Keywords
License
- MIT
- Yesattribution
- Permissivelinking
- Permissivedistribution
- Permissivemodification
- Nopatent grant
- Yesprivate use
- Permissivesublicensing
- Notrademark grant
Downloads
Readme
Project Status CI/CD Quality Package Community Meta
Polyfactory
Polyfactory is a simple and powerful mock data generation library, based around type hints and supporting dataclasses, typed-dicts, pydantic models, msgspec structs and more.
Polyfactory part of the Litestar project and as such actively maintained by a community of maintainers and contributors.
Example
from dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
...
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, Person)
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 dataclass, which are used as a source of truth for data generation.
The factory parses the information stored in the dataclass and generates a dictionary of kwargs that are passed to
Person
.
Documentation
Usage and API reference documentation is available on https://polyfactory.litestar.dev/.
Installation
pip install polyfactory
Relation to Pydantic-Factories
Prior to version 2, this library was known as pydantic-factories, a name
under which it gained quite a bit of popularity.
A main motivator for the 2.0 release was that we wanted to support more than just Pydantic models, something which also
required a change to its core architecture. As this library would no longer be directly tied to Pydantic, polyfactory
was chosen as its new name to reflect its capabilities; It can generate mock data for dataclasses, typed-dicts,
Pydantic, odmantic, and beanie ODM models, as well as custom factories.
Contributing
This library is a community driven open source project. We welcome and encourage contributions. Please check out the GitHub issues, read the contribution guide (at the repositoryโs root), and youโre always welcome to join our discord server.
Contributors โจ
Thanks goes to these wonderful people (emoji key):
Na'aman Hirschfeld
๐ง ๐ โ ๏ธ ๐ป ๐
Jacob Coffee
๐ง ๐ โ ๏ธ
Janek Nouvertnรฉ
๐ง ๐ โ ๏ธ ๐ป
Peter Schutt
๐ง โ ๏ธ ๐ป ๐
Marek Czaplicki
๐ป โ ๏ธ
Piotr Przybyลo
๐ป
sygutss
๐ ๐ป
chrisbeardy
๐
guacs
๐ป ๐ ๐ โ ๏ธ ๐ง
Vadim
๐ป
Simske
๐ป
Sondre Lillebรธ Gundersen
๐ป
Mateusz Ciszczoล
๐ป
Pedro Bernardes
๐ป
Martin Roy
๐ป
Matthew Aylward
๐ป
Elton H.Y. Chou
๐ป
Thang
๐ป
Daan
๐ป
Lyz
๐ป
Thorin Schiffer
๐ป
Iipin
๐ป
avihai-yosef
๐ป
anthonyh209
๐ป
Roman Reznikov
๐ป
gigelu
๐ป
Rodrigo Medina
๐ป
Gerrit Egnew
๐ป
danielkatzan
๐
Abdulhaq Emhemmed
๐ป
klimantje
๐ป
Tom Crasset
๐ป
cฤtฤlin
๐ป
Andrew Truong
๐ป ๐
Anthony
๐ป ๐ โ ๏ธ
Jonathan Liuti
๐ป ๐ โ ๏ธ
Julio Olivera
๐ป โ ๏ธ
Benoรฎt Godard
๐ป ๐ โ ๏ธ
Henry Sorsky
๐
Kim Minki
๐
Tim Joseph Dumol
๐
jeffry
๐ป
Sergey Kovalev
๐ป
Isaac Jackson
๐ป
This project follows the all-contributors specification. Contributions of any kind welcome!