Collections of pydantic models
Project description
pydantic-collections
The pydantic-collections
package provides BaseCollectionModel
class that allows you
to manipulate collections of pydantic models
(and any other types supported by pydantic).
Requirements
- Python >= 3.7
- pydantic >= 1.8.2
Installation
pip install pydantic-collections
Usage
Basic usage
from datetime import datetime
from pydantic import BaseModel
from pydantic_collections import BaseCollectionModel
class User(BaseModel):
id: int
name: str
birth_date: datetime
class UserCollection(BaseCollectionModel[User]):
pass
user_data = [
{'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'},
{'id': 2, 'name': 'Balaganov', 'birth_date': '2020-04-01T12:59:59'},
]
users = UserCollection(user_data)
print(users)
#> UserCollection([User(id=1, name='Bender', birth_date=datetime.datetime(2010, 4, 1, 12, 59, 59)), User(id=2, name='Balaganov', birth_date=datetime.datetime(2020, 4, 1, 12, 59, 59))])
print(users.dict())
#> [{'id': 1, 'name': 'Bender', 'birth_date': datetime.datetime(2010, 4, 1, 12, 59, 59)}, {'id': 2, 'name': 'Balaganov', 'birth_date': datetime.datetime(2020, 4, 1, 12, 59, 59)}]
print(users.json())
#> [{"id": 1, "name": "Bender", "birth_date": "2010-04-01T12:59:59"}, {"id": 2, "name": "Balaganov", "birth_date": "2020-04-01T12:59:59"}]
Strict assignment validation
By default BaseCollectionModel
has a strict assignment check
...
users = UserCollection()
users.append(User(id=1, name='Bender', birth_date=datetime.utcnow())) # OK
users.append({'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'})
#> pydantic.error_wrappers.ValidationError: 1 validation error for UserCollection
#> __root__ -> 2
#> instance of User expected (type=type_error.arbitrary_type; expected_arbitrary_type=User)
This behavior can be changed via Model Config
...
class UserCollection(BaseCollectionModel[User]):
class Config:
validate_assignment_strict = False
users = UserCollection()
users.append({'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'}) # OK
assert users[0].__class__ is User
assert users[0].id == 1
Using as a model field
BaseCollectionModel
is a subclass of BaseModel
, so you can use it as a model field
...
class UserContainer(BaseModel):
users: UserCollection = []
data = {
'users': [
{'id': 1, 'name': 'Bender', 'birth_date': '2010-04-01T12:59:59'},
{'id': 2, 'name': 'Balaganov', 'birth_date': '2020-04-01T12:59:59'},
]
}
container = UserContainer(**data)
container.users.append(User(...))
...
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
Close
Hashes for pydantic-collections-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ab3322af01a14c8156b34960b67ebfaa10126a002fc4808e10df5dee96d2d53 |
|
MD5 | ea38fb5c83486509111b8272b58ffc7b |
|
BLAKE2b-256 | 8bdeab921995e885b340e20f5db6804c3eb9915aa79d12d7a2eff4dfc1f9237f |
Close
Hashes for pydantic_collections-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3877e0a45beacabb09b3f3ae5ef62a325f0dfe96b6fb08bb45a75d0e420f483 |
|
MD5 | bec4989ec244176eb7fa0b087741942a |
|
BLAKE2b-256 | ed5c8e581ad70323fc2b2371b578e400baaa84baeaeb0f24b703ed093964f438 |