Mock data generation for pydantic based models and python dataclasses
Project description
Pydantic-Factories
This library offers powerful mock data generation capabilities for pydantic
based models, dataclasses
and TypeDict
s. It can also be used with other libraries that use pydantic as a foundation.
Check out the documentation 📚.
Installation
pip install pydantic-factories
Example
from datetime import date, datetime
from typing import List, Union
from pydantic import BaseModel, UUID4
from pydantic_factories import ModelFactory
class Person(BaseModel):
id: UUID4
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
class PersonFactory(ModelFactory):
__model__ = Person
result = PersonFactory.build()
That's it - with almost no work, we are able to create a mock data object fitting the Person
class model definition.
This is possible because of the typing information available on the pydantic model and model-fields, which are used as a source of truth for data generation.
The factory parses the information stored in the pydantic model and generates a dictionary of kwargs that are passed to
the Person
class' init method.
Features
- ✅ supports both built-in and pydantic types
- ✅ supports pydantic field constraints
- ✅ supports complex field types
- ✅ supports custom model fields
- ✅ supports dataclasses
Why This Library?
- 💯 powerful
- 💯 extensible
- 💯 simple
- 💯 rigorously tested
Contributing
This library is open to contributions - in fact we welcome it. Please see the contribution guide!
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
Hashes for pydantic_factories-1.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0125162334b47a04a7b44438372737b8bf43f2c9fd8e2d521f7bc16f319e0f7 |
|
MD5 | c07dc1b3f7ac144c269af1027e8fd9fd |
|
BLAKE2b-256 | 82205d9b4416e7ca4c73ccf0e89bbc269b5088e288f66f0fa64cb1d055b1daf3 |
Hashes for pydantic_factories-1.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f022d1df1923936a6a6fbbeb0b3470dd0ff914bd118dba5d39327ff5138b5854 |
|
MD5 | f34f800d4308929f342f9d4bdda2e343 |
|
BLAKE2b-256 | c1236e067c470471a2ea0cce76aa2490417fc5a44165c52a3c570e2d2cc40a59 |