Skip to main content

Mock data generation for pydantic based models

Project description

PyPI - Python Version Coverage Maintainability Rating Reliability Rating Quality Gate Status

Pydantic Factories

This library offers mock data generation for pydantic based models. This means any user defined models as well as third party libraries that use pydantic as a foundation, e.g. SQLModel, FastAPI, Beanie, Ormar and others.

Features

  • ✅ supports both built-in and pydantic types
  • ✅ supports pydantic field constraints
  • ✅ supports complex field typings
  • ✅ supports custom model fields

Why This Library?

  • 💯 powerful mock data generation
  • 💯 simple to use and extend
  • 💯 rigorously tested

Installation

pip install pydantic-factories

OR

poetry add --dev pydantic-factories

Usage

from datetime import date, datetime
from typing import List, Union

from pydantic import BaseModel, UUID4

from pydantic_factories.factory import ModelFactory


class Person(BaseModel):
    id: UUID4
    name: str
    hobbies: List[str]
    age: Union[float, int]
    birthday: Union[datetime, date]


class PersonFactoryWithDefaults(ModelFactory):
    __model__ = Person


result = PersonFactoryWithDefaults.build()

That's it - the factory will create a data object that fits the defined model and pass it to the pydantic model as kwargs. It will then pass through the pydantic validation and parsing mechanism, and create a model instance.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydantic-factories-0.3.2b0.tar.gz (13.5 kB view hashes)

Uploaded Source

Built Distribution

pydantic_factories-0.3.2b0-py3-none-any.whl (17.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page