pydantic models work with mypy provided you use the annotation-only version of required fields:
{!.tmp_examples/mypy_main.py!}
You can run your code through mypy with:
mypy \
--ignore-missing-imports \
--follow-imports=skip \
--strict-optional \
pydantic_mypy_test.py
If you call mypy on the example code above, you should see mypy detect the attribute access error:
13: error: "Model" has no attribute "middle_name"
For your code to pass with --strict-optional
, you need to to use Optional[]
or an alias of Optional[]
for all fields with None
as the default. (This is standard with mypy.)
Pydantic provides a few useful optional or union types:
NoneStr
aka.Optional[str]
NoneBytes
aka.Optional[bytes]
StrBytes
aka.Union[str, bytes]
NoneStrBytes
aka.Optional[StrBytes]
If these aren't sufficient you can of course define your own.
Pydantic ships with a mypy plugin that adds a number of important pydantic-specific features to mypy that improve its ability to type-check your code.
See the pydantic mypy plugin docs for more details.
Pydantic dataclasses and the validate_arguments
decorator
should also work well with mypy.