field_meta

class polyfactory.field_meta.Null

Bases: object

Sentinel class for empty values

class polyfactory.field_meta.UrlConstraints

Bases: TypedDict

class polyfactory.field_meta.Constraints

Bases: TypedDict

Metadata regarding a type constraints, if any

class polyfactory.field_meta.FieldMeta

Bases: object

Factory field metadata container. This class is used to store the data about a field of a factory’s model.

__init__(*, name: str, annotation: type, default: ~typing.Any = <class 'polyfactory.field_meta.Null'>, children: list[~polyfactory.field_meta.FieldMeta] | None = None, constraints: ~polyfactory.field_meta.Constraints | None = None, examples: list[~typing.Any] | None = None, required: bool = True) → None

Create a factory field metadata instance.

__repr__() → str

Return a string representation of the field meta.

property type_args: tuple[Any, ...]

Return the normalized type args of the annotation, if any.

Returns:

a tuple of types.

classmethod from_type(annotation: Any, name: str = '', default: Any = <class 'polyfactory.field_meta.Null'>, constraints: Constraints | None = None, children: list[FieldMeta] | None = None, required: bool = True, examples: list[Any] | None = None) → Self

Builder method to create a FieldMeta from a type annotation.

Parameters:

• annotation – A type annotation.

• name – Field name

• default – Default value, if any.

• constraints – A dictionary of constraints, if any.

• examples – A list of example values, if any.

Returns:

A field meta instance.

classmethod parse_examples(metadata: Sequence[Any]) → list[Any] | None

Get the example values from the given annotation metadata.

Any metadata object with a non-empty examples list attribute is supported, e.g. msgspec.Meta or pydantic.Field. If several are given, the last one wins.

Parameters:

metadata – A list of annotation metadata.

Returns:

A list of example values, if any.

classmethod get_constraints_metadata(annotation: Any) → Sequence[Any]

Get the metadatas of the constraints from the given annotation.

Parameters:

• annotation – A type annotation.

• random – An instance of random.Random.

Returns:

A list of the metadata in the annotation.