polars.testing.parametric.dtypes

polars.testing.parametric.dtypes(
    *,
    allowed_dtypes: Collection[PolarsDataType] | None = None,
    excluded_dtypes: Sequence[PolarsDataType] | None = None,
    allow_time_zones: bool = True,
    nesting_level: int = 3,
) → SearchStrategy[DataType]

Create a strategy for generating Polars DataType objects.

Warning

This functionality is currently considered unstable. It may be changed at any point without it being considered a breaking change.

Parameters:

allowed_dtypes

Data types the strategy will pick from. If set to None (default), all supported data types are included.

excluded_dtypes

Data types the strategy will not pick from. This takes priority over data types specified in allowed_dtypes.

allow_time_zones

Allow generating Datetime data types with a time zone.

nesting_level

The complexity of nested data types. If set to 0, nested data types are disabled.