Pydantic attributes typos

[kabell]

I would like to prevent typos in pydantic model attributes and catch them by Pyright.

Example

from pydantic import BaseModel

class Foo(BaseModel):
    bar:int

    def set_value(self, value: int):
        self.barr = value  # typo in bar

If I run

foo = Foo(bar=6)
foo.set_value(10)

It will crash

ValueError: "Foo" object has no field "barr"

Is there a way to configure Pyright to catch and report such issues?

These are my current settings:

"typeCheckingMode": "strict",
 "strictParameterNoneValue": false,

  "reportInvalidTypeForm": "error",
  "reportMissingImports": "error",
  "reportCallIssue": "error",
  "reportUndefinedVariable": "error",
  "reportInvalidTypeArguments": "error",
  "reportTypeCommentUsage": "error",
  "reportMatchNotExhaustive": "error",
  "reportOptionalCall": "error",
  "reportOptionalContextManager": "error",
  "reportRedeclaration": "error",
  "reportSelfClsParameterName": "error",
  "reportUnusedExpression": "error",
  "reportUnboundVariable": "error",
  "reportInvalidStringEscapeSequence": "error",
  "reportUnusedCoroutine": "error",
  "reportArgumentType": "error",
  "reportReturnType": "error",
  "reportAssignmentType": "error",
  "reportGeneralTypeIssues": "error",
  "reportUnnecessaryTypeIgnoreComment": "error",
  "reportAttributeAccessIssue": "error",
  "reportIncompatibleMethodOverride": "error",
  "reportIncompatibleVariableOverride": "error",
  "reportMissingParameterType": "error",
  "reportOptionalIterable": "error",
  "reportOptionalMemberAccess": "error",
  "reportOptionalOperand": "error",
  "reportOptionalSubscript": "error",
  "reportUninitializedInstanceVariable": "error",

[Eric Traut (erictraut)]

As a rule, pyright has no hard-coded knowledge about any third-party libraries. The behavior you're describing here, where an assignment to an instance variable results in a runtime error, is specific to pydantic. As such, this isn't a behavior that pyright (or any standards-compliant type checker) would report as an error.

Pyright does support reportUninitializedInstanceVariable, which I see you're using, but this won't detect this particular error.

Thankfully, this error should be easy to find and diagnose the first time you run your code, so static analysis doesn't add much value here.

[Jozef Marko (jodik)]

for constructing yes, but it also doesn't catch stuff like foo.barr = 5 which if hidden in rarely used code path can cause runtime errors

[Eric Traut (erictraut)]

It does report an error for foo.barr = 5 if there is no barr attribute defined within the class.