Data validation using Python type hints
Project description
Pydantic
Data validation using Python type hints.
Fast and extensible, Pydantic plays nicely with your linters/IDE/brain. Define how data should be in pure, canonical Python 3.8+; validate it with Pydantic.
Pydantic Company :rocket:
We've started a company based on the principles that I believe have led to Pydantic's success. Learning more from the Company Announcement.
Pydantic V1.10 vs. V2
Pydantic V2 is a ground-up rewrite that offers many new features, performance improvements, and some breaking changes compared to Pydantic V1.
If you're using Pydantic V1 you may want to look at the
pydantic V1.10 Documentation or,
1.10.X-fixes git branch. Pydantic V2 also ships with the latest version of Pydantic V1 built in so that you can incrementally upgrade your code base and projects: from pydantic import v1 as pydantic_v1.
Help
See documentation for more details.
Installation
Install using pip install -U pydantic or conda install pydantic -c conda-forge.
For more installation options to make Pydantic even faster,
see the Install section in the documentation.
A Simple Example
from datetime import datetime
from typing import List, Optional
from pydantic import BaseModel
class User(BaseModel):
id: int
name: str = 'John Doe'
signup_ts: Optional[datetime] = None
friends: List[int] = []
external_data = {'id': '123', 'signup_ts': '2017-06-01 12:22', 'friends': [1, '2', b'3']}
user = User(**external_data)
print(user)
#> User id=123 name='John Doe' signup_ts=datetime.datetime(2017, 6, 1, 12, 22) friends=[1, 2, 3]
print(user.id)
#> 123
Contributing
For guidance on setting up a development environment and how to make a contribution to Pydantic, see Contributing to Pydantic.
Reporting a Security Vulnerability
See our security policy.
Changelog
v2.6.2 (2024-02-23)
What's Changed
Packaging
- Upgrade to
pydantic-core2.16.3 by @sydney-runkle in #8879
Fixes
- 'YYYY-MM-DD' date string coerced to datetime shouldn't infer timezone by @sydney-runkle in pydantic/pydantic-core#1193
v2.6.1 (2024-02-05)
What's Changed
Packaging
- Upgrade to
pydantic-core2.16.2 by @sydney-runkle in #8717
Fixes
- Fix bug with
mypyplugin andno_strict_optional = Trueby @dmontagu in #8666 - Fix
ByteSizeerrortypechange by @sydney-runkle in #8681 - Fix inheriting
Fieldannotations in dataclasses by @sydney-runkle in #8679 - Fix regression in core schema generation for indirect definition references by @dmontagu in #8702
- Fix unsupported types bug with
PlainValidatorby @sydney-runkle in #8710 - Reverting problematic fix from 2.6 release, fixing schema building bug by @sydney-runkle in #8718
- Fix warning for tuple of wrong size in
Unionby @davidhewitt in pydantic/pydantic-core#1174 - Fix
computed_fieldJSON serializerexclude_nonebehavior by @sydney-runkle in pydantic/pydantic-core#1187
v2.6.0 (2024-01-29)
The code released in v2.6.0 is practically identical to that of v2.6.0b1.
What's Changed
Packaging
- Check for
email-validatorversion >= 2.0 by @commonism in #6033 - Upgrade `ruff`` target version to Python 3.8 by @Elkiwa in #8341
- Update to
pydantic-extra-types==2.4.1by @yezz123 in #8478 - Update to
pyright==1.1.345by @Viicos in #8453 - Update pydantic-core from 2.14.6 to 2.16.1, significant changes from these updates are described below, full changelog here
New Features
- Add
NatsDsnby @ekeew in #6874 - Add
ConfigDict.ser_json_inf_nanby @davidhewitt in #8159 - Add
types.OnErrorOmitby @adriangb in #8222 - Support
AliasGeneratorusage by @sydney-runkle in #8282 - Add Pydantic People Page to docs by @sydney-runkle in #8345
- Support
yyyy-MM-DDdatetime parsing by @sydney-runkle in #8404 - Added bits conversions to the
ByteSizeclass #8415 by @luca-matei in #8507 - Enable json schema creation with type
ByteSizeby @geospackle in #8537 - Add
eval_type_backportto handle union operator and builtin generic subscripting in older Pythons by @alexmojaki in #8209 - Add support for
dataclassfieldsinitby @dmontagu in #8552 - Implement pickling for
ValidationErrorby @davidhewitt in pydantic/pydantic-core#1119 - Add unified tuple validator that can handle "variadic" tuples via PEP-646 by @dmontagu in pydantic/pydantic-core#865
Changes
- Drop Python3.7 support by @hramezani in #7188
- Drop Python 3.7, and PyPy 3.7 and 3.8 by @davidhewitt in pydantic/pydantic-core#1129
- Use positional-only
selfinBaseModelconstructor, so no field name can ever conflict with it by @ariebovenberg in #8072 - Make
@validate_callreturn a function instead of a custom descriptor - fixes binding issue with inheritance and addsself/clsargument to validation errors by @alexmojaki in #8268 - Exclude
BaseModeldocstring from JSON schema description by @sydney-runkle in #8352 - Introducing
classpropertydecorator formodel_computed_fieldsby @Jocelyn-Gas in #8437 - Explicitly raise an error if field names clashes with types by @Viicos in #8243
- Use stricter serializer for unions of simple types by @alexdrydew pydantic/pydantic-core#1132
Performance
- Add Codspeed profiling Actions workflow by @lambertsbennett in #8054
- Improve
intextraction by @samuelcolvin in pydantic/pydantic-core#1155 - Improve performance of recursion guard by @samuelcolvin in pydantic/pydantic-core#1156
dataclassserialization speedups by @samuelcolvin in pydantic/pydantic-core#1162- Avoid
HashMapcreation when looking up small JSON objects inLazyIndexMapsby @samuelcolvin in pydantic/jiter#55 - use hashbrown to speedup python string caching by @davidhewitt in pydantic/jiter#51
- Replace
Peakwith more efficientPeekby @davidhewitt in pydantic/jiter#48
Fixes
- Move
getattrwarning in deprecatedBaseConfigby @tlambert03 in #7183 - Only hash
model_fields, not whole__dict__by @alexmojaki in #7786 - Fix mishandling of unions while freezing types in the
mypyplugin by @dmontagu in #7411 - Fix
mypyerror on untypedClassVarby @vincent-hachin-wmx in #8138 - Only compare pydantic fields in
BaseModel.__eq__instead of whole__dict__by @QuentinSoubeyranAqemia in #7825 - Update
strictdocstring inmodel_validatemethod. by @LukeTonin in #8223 - Fix overload position of
computed_fieldby @Viicos in #8227 - Fix custom type type casting used in multiple attributes by @ianhfc in #8066
- Fix issue not allowing
validate_calldecorator to be dynamically assigned to a class method by @jusexton in #8249 - Fix issue
unittest.mockdeprecation warnings by @ibleedicare in #8262 - Added tests for the case
JsonValuecontains subclassed primitive values by @jusexton in #8286 - Fix
mypyerror on free before validator (classmethod) by @sydney-runkle in #8285 - Fix
to_snakeconversion by @jevins09 in #8316 - Fix type annotation of
ModelMetaclass.__prepare__by @slanzmich in #8305 - Disallow
configspecification when initializing aTypeAdapterwhen the annotated type has config already by @sydney-runkle in #8365 - Fix a naming issue with JSON schema for generics parametrized by recursive type aliases by @dmontagu in #8389
- Fix type annotation in pydantic people script by @shenxiangzhuang in #8402
- Add support for field
aliasindataclasssignature by @NeevCohen in #8387 - Fix bug with schema generation with
Field(...)in a forward ref by @dmontagu in #8494 - Fix ordering of keys in
__dict__withmodel_constructcall by @sydney-runkle in #8500 - Fix module
path_typecreation when globals does not contain__name__by @hramezani in #8470 - Fix for namespace issue with dataclasses with
from __future__ import annotationsby @sydney-runkle in #8513 - Fix: make function validator types positional-only by @pmmmwh in #8479
- Fix usage of
@deprecatedby @Viicos in #8294 - Add more support for private attributes in
model_constructcall by @sydney-runkle in #8525 - Use a stack for the types namespace by @dmontagu in #8378
- Fix schema-building bug with
TypeAliasTypefor types with refs by @dmontagu in #8526 - Support
pydantic.Field(repr=False)in dataclasses by @tigeryy2 in #8511 - Override
dataclass_transformbehavior forRootModelby @Viicos in #8163 - Refactor signature generation for simplicity by @sydney-runkle in #8572
- Fix ordering bug of PlainValidator annotation by @Anvil in #8567
- Fix
exclude_nonefor json serialization ofcomputed_fields by @sydney-runkle in pydantic/pydantic-core#1098 - Support yyyy-MM-DD string for datetimes by @sydney-runkle in pydantic/pydantic-core#1124
- Tweak ordering of definitions in generated schemas by @StrawHatDrag0n in #8583
New Contributors
pydantic
- @ekeew made their first contribution in #6874
- @lambertsbennett made their first contribution in #8054
- @vincent-hachin-wmx made their first contribution in #8138
- @QuentinSoubeyranAqemia made their first contribution in #7825
- @ariebovenberg made their first contribution in #8072
- @LukeTonin made their first contribution in #8223
- @denisart made their first contribution in #8231
- @ianhfc made their first contribution in #8066
- @eonu made their first contribution in #8255
- @amandahla made their first contribution in #8263
- @ibleedicare made their first contribution in #8262
- @jevins09 made their first contribution in #8316
- @cuu508 made their first contribution in #8322
- @slanzmich made their first contribution in #8305
- @jensenbox made their first contribution in #8331
- @szepeviktor made their first contribution in #8356
- @Elkiwa made their first contribution in #8341
- @parhamfh made their first contribution in #8395
- @shenxiangzhuang made their first contribution in #8402
- @NeevCohen made their first contribution in #8387
- @zby made their first contribution in #8497
- @patelnets made their first contribution in #8491
- @edwardwli made their first contribution in #8503
- @luca-matei made their first contribution in #8507
- @Jocelyn-Gas made their first contribution in #8437
- @bL34cHig0 made their first contribution in #8501
- @tigeryy2 made their first contribution in #8511
- @geospackle made their first contribution in #8537
- @Anvil made their first contribution in #8567
- @hungtsetse made their first contribution in #8546
- @StrawHatDrag0n made their first contribution in #8583
pydantic-core
- @mariuswinger made their first contribution in pydantic/pydantic-core#1087
- @adamchainz made their first contribution in pydantic/pydantic-core#1090
- @akx made their first contribution in pydantic/pydantic-core#1123
v2.6.0b1 (2024-01-19)
Pre-release, see the GitHub release for details.
v2.5.3 (2023-12-22)
What's Changed
Packaging
- uprev
pydantic-coreto 2.14.6
Fixes
- Fix memory leak with recursive definitions creating reference cycles by @davidhewitt in pydantic/pydantic-core#1125
v2.5.2 (2023-11-22)
What's Changed
Packaging
- uprev
pydantic-coreto 2.14.5
New Features
- Add
ConfigDict.ser_json_inf_nanby @davidhewitt in #8159
Fixes
- Fix validation of
Literalfrom JSON keys when used asdictkey by @sydney-runkle in pydantic/pydantic-core#1075 - Fix bug re
custom_initon members ofUnionby @sydney-runkle in pydantic/pydantic-core#1076 - Fix
JsonValueboolserialization by @sydney-runkle in #8190 - Fix handling of unhashable inputs with
LiteralinUnions by @sydney-runkle in pydantic/pydantic-core#1089
v2.5.1 (2023-11-15)
What's Changed
Packaging
- uprev pydantic-core to 2.14.3 by @samuelcolvin in #8120
Fixes
- Fix package description limit by @dmontagu in #8097
- Fix
ValidateCallWrappererror when creating a model which has a @validate_call wrapped field annotation by @sydney-runkle in #8110
v2.5.0 (2023-11-13)
The code released in v2.5.0 is functionally identical to that of v2.5.0b1.
What's Changed
Packaging
- Update pydantic-core from 2.10.1 to 2.14.1, significant changes from these updates are described below, full changelog here
- Update to
pyright==1.1.335by @Viicos in #8075
New Features
- Allow plugins to catch non
ValidationErrorerrors by @adriangb in #7806 - Support
__doc__argument increate_model()by @chris-spann in #7863 - Expose
regex_engineflag - meaning you can use with the Rust or Python regex libraries in constraints by @utkini in #7768 - Save return type generated from type annotation in
ComputedFieldInfoby @alexmojaki in #7889 - Adopting
ruffformatter by @Luca-Blight in #7930 - Added
validation_error_causeto config by @zakstucke in #7626 - Make path of the item to validate available in plugin by @hramezani in #7861
- Add
CallableDiscriminatorandTagby @dmontagu in #7983 - Make union case tags affect union error messages by @dmontagu in #8001
- Add
examplesandjson_schema_extrato@computed_fieldby @alexmojaki in #8013 - Add
JsonValuetype by @dmontagu in #7998 - Allow
stras argument toDiscriminatorby @dmontagu in #8047 - Add
SchemaSerializer.__reduce__method to enable pickle serialization by @edoakes in pydantic/pydantic-core#1006
Changes
- Significant Change: replace
ultra_strictwith new smart union implementation, the way unions are validated has changed significantly to improve performance and correctness, we have worked hard to absolutely minimise the number of cases where behaviour has changed, see the PR for details - by @davidhewitt in pydantic/pydantic-core#867 - Add support for instance method reassignment when
extra='allow'by @sydney-runkle in #7683 - Support JSON schema generation for
Enumtypes with no cases by @sydney-runkle in #7927 - Warn if a class inherits from
GenericbeforeBaseModelby @alexmojaki in #7891
Performance
- New custom JSON parser,
jiterby @samuelcolvin in pydantic/pydantic-core#974 - PGO build for MacOS M1 by @samuelcolvin in pydantic/pydantic-core#1063
- Use
__getattr__for all package imports, improve import time by @samuelcolvin in #7947
Fixes
- Fix
mypyissue with subclasses ofRootModelby @sydney-runkle in #7677 - Properly rebuild the
FieldInfowhen a forward ref gets evaluated by @dmontagu in #7698 - Fix failure to load
SecretStrfrom JSON (regression in v2.4) by @sydney-runkle in #7729 - Fix
defer_buildbehavior withTypeAdapterby @sydney-runkle in #7736 - Improve compatibility with legacy
mypyversions by @dmontagu in #7742 - Fix: update
TypeVarhandling when default is not set by @pmmmwh in #7719 - Support specification of
strictonEnumtype fields by @sydney-runkle in #7761 - Wrap
weakref.refinstead of subclassing to fixcloudpickleserialization by @edoakes in #7780 - Keep values of private attributes set within
model_post_initin subclasses by @alexmojaki in #7775 - Add more specific type for non-callable
json_schema_extraby @alexmojaki in #7803 - Raise an error when deleting frozen (model) fields by @alexmojaki in #7800
- Fix schema sorting bug with default values by @sydney-runkle in #7817
- Use generated alias for aliases that are not specified otherwise by @alexmojaki in #7802
- Support
strictspecification forUUIDtypes by @sydney-runkle in #7865 - JSON schema: fix extra parameter handling by @me-and in #7810
- Fix: support
pydantic.Field(kw_only=True)with inherited dataclasses by @PrettyWood in #7827 - Support
validate_calldecorator for methods in classes with__slots__by @sydney-runkle in #7883 - Fix pydantic dataclass problem with
dataclasses.fielddefault by @hramezani in #7898 - Fix schema generation for generics with union type bounds by @sydney-runkle in #7899
- Fix version for
importlib_metadataon python 3.7 by @sydney-runkle in #7904 - Support
|operator (Union) in PydanticRecursiveRef by @alexmojaki in #7892 - Fix
display_as_typeforTypeAliasTypein python 3.12 by @dmontagu in #7929 - Add support for
NotRequiredgenerics inTypedDictby @sydney-runkle in #7932 - Make generic
TypeAliasTypespecifications produce different schema definitions by @alexdrydew in #7893 - Added fix for signature of inherited dataclass by @howsunjow in #7925
- Make the model name generation more robust in JSON schema by @joakimnordling in #7881
- Fix plurals in validation error messages (in tests) by @Iipin in #7972
PrivateAttris passed fromAnnotateddefault position by @tabassco in #8004- Don't decode bytes (which may not be UTF8) when displaying SecretBytes by @alexmojaki in #8012
- Use
classmethodinstead ofclassmethod[Any, Any, Any]by @Mr-Pepe in #7979 - Clearer error on invalid Plugin by @samuelcolvin in #8023
- Correct pydantic dataclasses import by @samuelcolvin in #8027
- Fix misbehavior for models referencing redefined type aliases by @dmontagu in #8050
- Fix
Optionalfield withvalidate_defaultonly performing one field validation by @sydney-runkle in pydantic/pydantic-core#1002 - Fix
definition-refbug withDictkeys by @sydney-runkle in pydantic/pydantic-core#1014 - Fix bug allowing validation of
booltypes withcoerce_numbers_to_str=Trueby @sydney-runkle in pydantic/pydantic-core#1017 - Don't accept
NaNin float and decimal constraints by @davidhewitt in pydantic/pydantic-core#1037 - Add
lax_strandlax_intsupport for enum values not inherited from str/int by @michaelhly in pydantic/pydantic-core#1015 - Support subclasses in lists in
UnionofListtypes by @sydney-runkle in pydantic/pydantic-core#1039 - Allow validation against
max_digitsanddecimalsto pass if normalized or non-normalized input is valid by @sydney-runkle in pydantic/pydantic-core#1049 - Fix: proper pluralization in
ValidationErrormessages by @Iipin in pydantic/pydantic-core#1050 - Disallow the string
'-'asdatetimeinput by @davidhewitt in pydantic/speedate#52 & pydantic/pydantic-core#1060 - Fix: NaN and Inf float serialization by @davidhewitt in pydantic/pydantic-core#1062
- Restore manylinux-compatible PGO builds by @davidhewitt in pydantic/pydantic-core#1068
New Contributors
pydantic
- @schneebuzz made their first contribution in #7699
- @edoakes made their first contribution in #7780
- @alexmojaki made their first contribution in #7775
- @NickG123 made their first contribution in #7751
- @gowthamgts made their first contribution in #7830
- @jamesbraza made their first contribution in #7848
- @laundmo made their first contribution in #7850
- @rahmatnazali made their first contribution in #7870
- @waterfountain1996 made their first contribution in #7878
- @chris-spann made their first contribution in #7863
- @me-and made their first contribution in #7810
- @utkini made their first contribution in #7768
- @bn-l made their first contribution in #7744
- @alexdrydew made their first contribution in #7893
- @Luca-Blight made their first contribution in #7930
- @howsunjow made their first contribution in #7925
- @joakimnordling made their first contribution in #7881
- @icfly2 made their first contribution in #7976
- @Yummy-Yums made their first contribution in #8003
- @Iipin made their first contribution in #7972
- @tabassco made their first contribution in #8004
- @Mr-Pepe made their first contribution in #7979
- @0x00cl made their first contribution in #8010
- @barraponto made their first contribution in #8032
pydantic-core
- @sisp made their first contribution in pydantic/pydantic-core#995
- @michaelhly made their first contribution in pydantic/pydantic-core#1015
v2.5.0b1 (2023-11-09)
Pre-release, see the GitHub release for details.
v2.4.2 (2023-09-27)
What's Changed
Fixes
- Fix bug with JSON schema for sequence of discriminated union by @dmontagu in #7647
- Fix schema references in discriminated unions by @adriangb in #7646
- Fix json schema generation for recursive models by @adriangb in #7653
- Fix
models_json_schemafor generic models by @adriangb in #7654 - Fix xfailed test for generic model signatures by @adriangb in #7658
New Contributors
- @austinorr made their first contribution in #7657
- @peterHoburg made their first contribution in #7670
v2.4.1 (2023-09-26)
What's Changed
Packaging
- Update pydantic-core to 2.10.1 by @davidhewitt in #7633
Fixes
- Serialize unsubstituted type vars as
Anyby @adriangb in #7606 - Remove schema building caches by @adriangb in #7624
- Fix an issue where JSON schema extras weren't JSON encoded by @dmontagu in #7625
v2.4.0 (2023-09-22)
What's Changed
Packaging
- Update pydantic-core to 2.10.0 by @samuelcolvin in #7542
New Features
- Add
Base64Urltypes by @dmontagu in #7286 - Implement optional
numbertostrcoercion by @lig in #7508 - Allow access to
field_nameanddatain all validators if there is data and a field name by @samuelcolvin in #7542 - Add
BaseModel.model_validate_stringsandTypeAdapter.validate_stringsby @hramezani in #7552 - Add Pydantic
pluginsexperimental implementation by @lig @samuelcolvin and @Kludex in #6820
Changes
- Do not override
model_post_initin subclass with private attrs by @Viicos in #7302 - Make fields with defaults not required in the serialization schema by default by @dmontagu in #7275
- Mark
Extraas deprecated by @disrupted in #7299 - Make
EncodedStra dataclass by @Kludex in #7396 - Move
annotated_handlersto be public by @samuelcolvin in #7569
Performance
- Simplify flattening and inlining of
CoreSchemaby @adriangb in #7523 - Remove unused copies in
CoreSchemawalking by @adriangb in #7528 - Add caches for collecting definitions and invalid schemas from a CoreSchema by @adriangb in #7527
- Eagerly resolve discriminated unions and cache cases where we can't by @adriangb in #7529
- Replace
dict.getanddict.setdefaultwith more verbose versions inCoreSchemabuilding hot paths by @adriangb in #7536 - Cache invalid
CoreSchemadiscovery by @adriangb in #7535 - Allow disabling
CoreSchemavalidation for faster startup times by @adriangb in #7565
Fixes
- Fix config detection for
TypedDictfrom grandparent classes by @dmontagu in #7272 - Fix hash function generation for frozen models with unusual MRO by @dmontagu in #7274
- Make
strictconfig overridable in field for Path by @hramezani in #7281 - Use
ser_json_<timedelta|bytes>on default inGenerateJsonSchemaby @Kludex in #7269 - Adding a check that alias is validated as an identifier for Python by @andree0 in #7319
- Raise an error when computed field overrides field by @sydney-runkle in #7346
- Fix applying
SkipValidationto referenced schemas by @adriangb in #7381 - Enforce behavior of private attributes having double leading underscore by @lig in #7265
- Standardize
__get_pydantic_core_schema__signature by @hramezani in #7415 - Fix generic dataclass fields mutation bug (when using
TypeAdapter) by @sydney-runkle in #7435 - Fix
TypeErroronmodel_validatorinwrapmode by @pmmmwh in #7496 - Improve enum error message by @hramezani in #7506
- Make
reprwork for instances that failed initialization when handlingValidationErrors by @dmontagu in #7439 - Fixed a regular expression denial of service issue by limiting whitespaces by @prodigysml in #7360
- Fix handling of
UUIDvalues havingUUID.version=Noneby @lig in #7566 - Fix
__iter__returning privatecached_propertyinfo by @sydney-runkle in #7570 - Improvements to version info message by @samuelcolvin in #7594
New Contributors
- @15498th made their first contribution in #7238
- @GabrielCappelli made their first contribution in #7213
- @tobni made their first contribution in #7184
- @redruin1 made their first contribution in #7282
- @FacerAin made their first contribution in #7288
- @acdha made their first contribution in #7297
- @andree0 made their first contribution in #7319
- @gordonhart made their first contribution in #7375
- @pmmmwh made their first contribution in #7496
- @disrupted made their first contribution in #7299
- @prodigysml made their first contribution in #7360
v2.3.0 (2023-08-23)
- 🔥 Remove orphaned changes file from repo by @lig in #7168
- Add copy button on documentation by @Kludex in #7190
- Fix docs on JSON type by @Kludex in #7189
- Update mypy 1.5.0 to 1.5.1 in CI by @hramezani in #7191
- fix download links badge by @samuelcolvin in #7200
- add 2.2.1 to changelog by @samuelcolvin in #7212
- Make ModelWrapValidator protocols generic by @dmontagu in #7154
- Correct
Field(..., exclude: bool)docs by @samuelcolvin in #7214 - Make shadowing attributes a warning instead of an error by @adriangb in #7193
- Document
Base64StrandBase64Bytesby @Kludex in #7192 - Fix
config.defer_buildfor serialization first cases by @samuelcolvin in #7024 - clean Model docstrings in JSON Schema by @samuelcolvin in #7210
- fix #7228 (typo): docs in
validators.mdto correctvalidate_defaultkwarg by @lmmx in #7229 - ✅ Implement
tzinfo.fromutcmethod forTzInfoinpydantic-coreby @lig in #7019 - Support
__get_validators__by @hramezani in #7197
v2.2.1 (2023-08-18)
- Make
xfailing test for root model extra stopxfailing by @dmontagu in #6937 - Optimize recursion detection by stopping on the second visit for the same object by @mciucu in #7160
- fix link in docs by @tlambert03 in #7166
- Replace MiMalloc w/ default allocator by @adriangb in pydantic/pydantic-core#900
- Bump pydantic-core to 2.6.1 and prepare 2.2.1 release by @adriangb in #7176
v2.2.0 (2023-08-17)
- Split "pipx install" setup command into two commands on the documentation site by @nomadmtb in #6869
- Deprecate
Field.includeby @hramezani in #6852 - Fix typo in default factory error msg by @hramezani in #6880
- Simplify handling of typing.Annotated in GenerateSchema by @dmontagu in #6887
- Re-enable fastapi tests in CI by @dmontagu in #6883
- Make it harder to hit collisions with json schema defrefs by @dmontagu in #6566
- Cleaner error for invalid input to
Pathfields by @samuelcolvin in #6903 - :memo: support Coordinate Type by @yezz123 in #6906
- Fix
ForwardRefwrapper for py 3.10.0 (shim until bpo-45166) by @randomir in #6919 - Fix misbehavior related to copying of RootModel by @dmontagu in #6918
- Fix issue with recursion error caused by ParamSpec by @dmontagu in #6923
- Add section about Constrained classes to the Migration Guide by @Kludex in #6924
- Use
mainbranch for badge links by @Viicos in #6925 - Add test for v1/v2 Annotated discrepancy by @carlbordum in #6926
- Make the v1 mypy plugin work with both v1 and v2 by @dmontagu in #6921
- Fix issue where generic models couldn't be parametrized with BaseModel by @dmontagu in #6933
- Remove xfail for discriminated union with alias by @dmontagu in #6938
- add field_serializer to computed_field by @andresliszt in #6965
- Use union_schema with Type[Union[...]] by @JeanArhancet in #6952
- Fix inherited typeddict attributes / config by @adriangb in #6981
- fix dataclass annotated before validator called twice by @davidhewitt in #6998
- Update test-fastapi deselected tests by @hramezani in #7014
- Fix validator doc format by @hramezani in #7015
- Fix typo in docstring of model_json_schema by @AdamVinch-Federated in #7032
- remove unused "type ignores" with pyright by @samuelcolvin in #7026
- Add benchmark representing FastAPI startup time by @adriangb in #7030
- Fix json_encoders for Enum subclasses by @adriangb in #7029
- Update docstring of
ser_json_bytesregarding base64 encoding by @Viicos in #7052 - Allow
@validate_callto work on async methods by @adriangb in #7046 - Fix: mypy error with
SettingsandSettingsConfigDictby @JeanArhancet in #7002 - Fix some typos (repeated words and it's/its) by @eumiro in #7063
- Fix the typo in docstring by @harunyasar in #7062
- Docs: Fix broken URL in the pydantic-settings package recommendation by @swetjen in #6995
- Handle constraints being applied to schemas that don't accept it by @adriangb in #6951
- Replace almost_equal_floats with math.isclose by @eumiro in #7082
- bump pydantic-core to 2.5.0 by @davidhewitt in #7077
- Add
short_versionand use it in links by @hramezani in #7115 - 📝 Add usage link to
RootModelby @Kludex in #7113 - Revert "Fix default port for mongosrv DSNs (#6827)" by @Kludex in #7116
- Clarify validate_default and _Unset handling in usage docs and migration guide by @benbenbang in #6950
- Tweak documentation of
Field.excludeby @Viicos in #7086 - Do not require
validate_assignmentto useField.frozenby @Viicos in #7103 - tweaks to
_core_utilsby @samuelcolvin in #7040 - Make DefaultDict working with set by @hramezani in #7126
- Don't always require typing.Generic as a base for partially parametrized models by @dmontagu in #7119
- Fix issue with JSON schema incorrectly using parent class core schema by @dmontagu in #7020
- Fix xfailed test related to TypedDict and alias_generator by @dmontagu in #6940
- Improve error message for NameEmail by @dmontagu in #6939
- Fix generic computed fields by @dmontagu in #6988
- Reflect namedtuple default values during validation by @dmontagu in #7144
- Update dependencies, fix pydantic-core usage, fix CI issues by @dmontagu in #7150
- Add mypy 1.5.0 by @hramezani in #7118
- Handle non-json native enum values by @adriangb in #7056
- document
round_tripin Json type documentation by @jc-louis in #7137 - Relax signature checks to better support builtins and C extension functions as validators by @adriangb in #7101
- add union_mode='left_to_right' by @davidhewitt in #7151
- Include an error message hint for inherited ordering by @yvalencia91 in #7124
- Fix one docs link and resolve some warnings for two others by @dmontagu in #7153
- Include Field extra keys name in warning by @hramezani in #7136
v2.1.1 (2023-07-25)
v2.1.0 (2023-07-25)
- Add
StringConstraintsfor use as Annotated metadata by @adriangb in #6605 - Try to fix intermittently failing CI by @adriangb in #6683
- Remove redundant example of optional vs default. by @ehiggs-deliverect in #6676
- Docs update by @samuelcolvin in #6692
- Remove the Validate always section in validator docs by @adriangb in #6679
- Fix recursion error in json schema generation by @adriangb in #6720
- Fix incorrect subclass check for secretstr by @AlexVndnblcke in #6730
- update pdm / pdm lockfile to 2.8.0 by @davidhewitt in #6714
- unpin pdm on more CI jobs by @davidhewitt in #6755
- improve source locations for auxiliary packages in docs by @davidhewitt in #6749
- Assume builtins don't accept an info argument by @adriangb in #6754
- Fix bug where calling
help(BaseModelSubclass)raises errors by @hramezani in #6758 - Fix mypy plugin handling of
@model_validator(mode="after")by @ljodal in #6753 - update pydantic-core to 2.3.1 by @davidhewitt in #6756
- Mypy plugin for settings by @hramezani in #6760
- Use
contentSchemakeyword for JSON schema by @dmontagu in #6715 - fast-path checking finite decimals by @davidhewitt in #6769
- Docs update by @samuelcolvin in #6771
- Improve json schema doc by @hramezani in #6772
- Update validator docs by @adriangb in #6695
- Fix typehint for wrap validator by @dmontagu in #6788
- 🐛 Fix validation warning for unions of Literal and other type by @lig in #6628
- Update documentation for generics support in V2 by @tpdorsey in #6685
- add pydantic-core build info to
version_info()by @samuelcolvin in #6785 - Fix pydantic dataclasses that use slots with default values by @dmontagu in #6796
- Fix inheritance of hash function for frozen models by @dmontagu in #6789
- ✨ Add
SkipJsonSchemaannotation by @Kludex in #6653 - Error if an invalid field name is used with Field by @dmontagu in #6797
- Add
GenericModeltoMOVED_IN_V2by @adriangb in #6776 - Remove unused code from
docs/usage/types/custom.mdby @hramezani in #6803 - Fix
float->Decimalcoercion precision loss by @adriangb in #6810 - remove email validation from the north star benchmark by @davidhewitt in #6816
- Fix link to mypy by @progsmile in #6824
- Improve initialization hooks example by @hramezani in #6822
- Fix default port for mongosrv DSNs by @dmontagu in #6827
- Improve API documentation, in particular more links between usage and API docs by @samuelcolvin in #6780
- update pydantic-core to 2.4.0 by @davidhewitt in #6831
- Fix
annotated_types.MaxLenvalidator for custom sequence types by @ImogenBits in #6809 - Update V1 by @hramezani in #6833
- Make it so callable JSON schema extra works by @dmontagu in #6798
- Fix serialization issue with
InstanceOfby @dmontagu in #6829 - Add back support for
json_encodersby @adriangb in #6811 - Update field annotations when building the schema by @dmontagu in #6838
- Use
WeakValueDictionaryto fix generic memory leak by @dmontagu in #6681 - Add
config.defer_buildto optionally make model building lazy by @samuelcolvin in #6823 - delegate
UUIDserialization to pydantic-core by @davidhewitt in #6850 - Update
json_encodersdocs by @adriangb in #6848 - Fix error message for
staticmethod/classmethodorder with validate_call by @dmontagu in #6686 - Improve documentation for
Configby @samuelcolvin in #6847 - Update serialization doc to mention
Field.excludetakes priority over call-timeinclude/excludeby @hramezani in #6851 - Allow customizing core schema generation by making
GenerateSchemapublic by @adriangb in #6737
v2.0.3 (2023-07-05)
- Mention PyObject (v1) moving to ImportString (v2) in migration doc by @slafs in #6456
- Fix release-tweet CI by @Kludex in #6461
- Revise the section on required / optional / nullable fields. by @ybressler in #6468
- Warn if a type hint is not in fact a type by @adriangb in #6479
- Replace TransformSchema with GetPydanticSchema by @dmontagu in #6484
- Fix the un-hashability of various annotation types, for use in caching generic containers by @dmontagu in #6480
- PYD-164: Rework custom types docs by @adriangb in #6490
- Fix ci by @adriangb in #6507
- Fix forward ref in generic by @adriangb in #6511
- Fix generation of serialization JSON schemas for core_schema.ChainSchema by @dmontagu in #6515
- Document the change in
Field.aliasbehavior in Pydantic V2 by @hramezani in #6508 - Give better error message attempting to compute the json schema of a model with undefined fields by @dmontagu in #6519
- Document
alias_priorityby @tpdorsey in #6520 - Add redirect for types documentation by @tpdorsey in #6513
- Allow updating docs without release by @samuelcolvin in #6551
- Ensure docs tests always run in the right folder by @dmontagu in #6487
- Defer evaluation of return type hints for serializer functions by @dmontagu in #6516
- Disable E501 from Ruff and rely on just Black by @adriangb in #6552
- Update JSON Schema documentation for V2 by @tpdorsey in #6492
- Add documentation of cyclic reference handling by @dmontagu in #6493
- Remove the need for change files by @samuelcolvin in #6556
- add "north star" benchmark by @davidhewitt in #6547
- Update Dataclasses docs by @tpdorsey in #6470
- ♻️ Use different error message on v1 redirects by @Kludex in #6595
- ⬆ Upgrade
pydantic-coreto v2.2.0 by @lig in #6589 - Fix serialization for IPvAny by @dmontagu in #6572
- Improve CI by using PDM instead of pip to install typing-extensions by @adriangb in #6602
- Add
enumerror type docs by @lig in #6603 - 🐛 Fix
max_lengthfor unicode strings by @lig in #6559 - Add documentation for accessing features via
pydantic.v1by @tpdorsey in #6604 - Include extra when iterating over a model by @adriangb in #6562
- Fix typing of model_validator by @adriangb in #6514
- Touch up Decimal validator by @adriangb in #6327
- Fix various docstrings using fixed pytest-examples by @dmontagu in #6607
- Handle function validators in a discriminated union by @dmontagu in #6570
- Review json_schema.md by @tpdorsey in #6608
- Make validate_call work on basemodel methods by @dmontagu in #6569
- add test for big int json serde by @davidhewitt in #6614
- Fix pydantic dataclass problem with dataclasses.field default_factory by @hramezani in #6616
- Fixed mypy type inference for TypeAdapter by @zakstucke in #6617
- Make it work to use None as a generic parameter by @dmontagu in #6609
- Make it work to use
$refas an alias by @dmontagu in #6568 - add note to migration guide about changes to
AnyUrletc by @davidhewitt in #6618 - 🐛 Support defining
json_schema_extraonRootModelusingFieldby @lig in #6622 - Update pre-commit to prevent commits to main branch on accident by @dmontagu in #6636
- Fix PDM CI for python 3.7 on MacOS/windows by @dmontagu in #6627
- Produce more accurate signatures for pydantic dataclasses by @dmontagu in #6633
- Updates to Url types for Pydantic V2 by @tpdorsey in #6638
- Fix list markdown in
transformdocstring by @StefanBRas in #6649 - simplify slots_dataclass construction to appease mypy by @davidhewitt in #6639
- Update TypedDict schema generation docstring by @adriangb in #6651
- Detect and lint-error for prints by @dmontagu in #6655
- Add xfailing test for pydantic-core PR 766 by @dmontagu in #6641
- Ignore unrecognized fields from dataclasses metadata by @dmontagu in #6634
- Make non-existent class getattr a mypy error by @dmontagu in #6658
- Update pydantic-core to 2.3.0 by @hramezani in #6648
- Use OrderedDict from typing_extensions by @dmontagu in #6664
- Fix typehint for JSON schema extra callable by @dmontagu in #6659
v2.0.2 (2023-07-05)
- Fix bug where round-trip pickling/unpickling a
RootModelwould change the value of__dict__, #6457 by @dmontagu - Allow single-item discriminated unions, #6405 by @dmontagu
- Fix issue with union parsing of enums, #6440 by @dmontagu
- Docs: Fixed
constrdocumentation, renamed oldregexto newpattern, #6452 by @miili - Change
GenerateJsonSchema.generate_definitionssignature, #6436 by @dmontagu
See the full changelog here
v2.0.1 (2023-07-04)
First patch release of Pydantic V2
- Extra fields added via
setattr(i.e.m.some_extra_field = 'extra_value') are added to.model_extraifmodel_configextra='allowed'. Fixed #6333, #6365 by @aaraney - Automatically unpack JSON schema '$ref' for custom types, #6343 by @adriangb
- Fix tagged unions multiple processing in submodels, #6340 by @suharnikov
See the full changelog here
v2.0 (2023-06-30)
Pydantic V2 is here! :tada:
See this post for more details.
v2.0b3 (2023-06-16)
Third beta pre-release of Pydantic V2
See the full changelog here
v2.0b2 (2023-06-03)
Add from_attributes runtime flag to TypeAdapter.validate_python and BaseModel.model_validate.
See the full changelog here
v2.0b1 (2023-06-01)
First beta pre-release of Pydantic V2
See the full changelog here
v2.0a4 (2023-05-05)
Fourth pre-release of Pydantic V2
See the full changelog here
v2.0a3 (2023-04-20)
Third pre-release of Pydantic V2
See the full changelog here
v2.0a2 (2023-04-12)
Second pre-release of Pydantic V2
See the full changelog here
v2.0a1 (2023-04-03)
First pre-release of Pydantic V2!
See this post for more details.
... see here for earlier changes.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pydantic-2.6.2.tar.gz.
File metadata
- Download URL: pydantic-2.6.2.tar.gz
- Upload date:
- Size: 680.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a09be1c3d28f3abe37f8a78af58284b236a92ce520105ddc91a6d29ea1176ba7
|
|
| MD5 |
f07f11534e715f71a5ae91418a291ce9
|
|
| BLAKE2b-256 |
a72d6308c04382ebdf15f1add7f0ec5e518ab23a0958363a8b3399f09c314fc0
|
File details
Details for the file pydantic-2.6.2-py3-none-any.whl.
File metadata
- Download URL: pydantic-2.6.2-py3-none-any.whl
- Upload date:
- Size: 394.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
37a5432e54b12fecaa1049c5195f3d860a10e01bdfd24f1840ef14bd0d3aeab3
|
|
| MD5 |
0c6e868a5bddaa2da4120c503dbf2062
|
|
| BLAKE2b-256 |
4228f19be8d493c59a8ddf32c15d69765c6423ad712da1c6255b418df2fc1443
|