| single |
# Pydantic
[CI]
[Coverage]
[pypi]
[CondaForge]
[downloads]
[versions]
[license]
[Pydantic v2]
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.
Learn 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
```py
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.8.2 (2024-07-03)
[GitHub release]
### What's Changed
#### Fixes
* Fix issue with assertion caused by pluggable schema validator by
[@dmontagu] in [#9838]
## v2.8.1 (2024-07-03)
[GitHub release]
### What's Changed
#### Packaging
* Bump `ruff` to `v0.5.0` and `pyright` to `v1.1.369` by [@sydney-runkle]
in [#9801]
|