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.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6b2cdf715f8c3e4a84e2851c0fb493af2009398159594c000192a38ce192129 |
|
MD5 | fe45399271f994a26b8b3794fcc96d3a |
|
BLAKE2b-256 | 27b5cc54935065629028544a1f448ac7e22f9aa7f2ca7aa84097fb9b057296c4 |
Hashes for pydantic_factories-1.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11c267ccbb7d54b1b456f68060f31472a5e53151314679e6f9367962b4d3a6f8 |
|
MD5 | 8e352f60938867fbee5eaa505b34e8cd |
|
BLAKE2b-256 | c0f8ba2361d3a51aea201057e13e189f0c6c9cdec9d52548e4a42802f39e98c3 |