diff --git a/py-polars/polars/testing/parametric/profiles.py b/py-polars/polars/testing/parametric/profiles.py index c48dd0292a66..5cfe0bdde35e 100644 --- a/py-polars/polars/testing/parametric/profiles.py +++ b/py-polars/polars/testing/parametric/profiles.py @@ -14,6 +14,10 @@ def load_profile( """ Load a named (or custom) hypothesis profile for use with the parametric tests. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Parameters ---------- profile : {str, int}, optional @@ -71,6 +75,10 @@ def set_profile(profile: ParametricProfileNames | int) -> None: """ Set the env var `POLARS_HYPOTHESIS_PROFILE` to the given profile name/value. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Parameters ---------- profile : {str, int}, optional diff --git a/py-polars/polars/testing/parametric/strategies/core.py b/py-polars/polars/testing/parametric/strategies/core.py index b90e759ee3fb..fd15bd96fe77 100644 --- a/py-polars/polars/testing/parametric/strategies/core.py +++ b/py-polars/polars/testing/parametric/strategies/core.py @@ -49,6 +49,10 @@ def series( # noqa: D417 """ Hypothesis strategy for producing Polars Series. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Parameters ---------- name : {str, strategy}, optional @@ -284,6 +288,10 @@ def dataframes( # noqa: D417 """ Hypothesis strategy for producing Polars DataFrames or LazyFrames. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Parameters ---------- cols : {int, columns}, optional @@ -493,6 +501,10 @@ class column: """ Define a column for use with the `dataframes` strategy. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Parameters ---------- name : str diff --git a/py-polars/polars/testing/parametric/strategies/data.py b/py-polars/polars/testing/parametric/strategies/data.py index 1f0c656cf73f..c42f073a24c3 100644 --- a/py-polars/polars/testing/parametric/strategies/data.py +++ b/py-polars/polars/testing/parametric/strategies/data.py @@ -256,6 +256,10 @@ def lists( """ Create a strategy for generating lists of the given data type. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Parameters ---------- inner_dtype diff --git a/py-polars/polars/testing/parametric/strategies/dtype.py b/py-polars/polars/testing/parametric/strategies/dtype.py index 5ee01a1774a1..3bd00bf87bcf 100644 --- a/py-polars/polars/testing/parametric/strategies/dtype.py +++ b/py-polars/polars/testing/parametric/strategies/dtype.py @@ -95,6 +95,10 @@ def dtypes( """ Create a strategy for generating Polars :class:`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 diff --git a/py-polars/polars/testing/parametric/strategies/legacy.py b/py-polars/polars/testing/parametric/strategies/legacy.py index 46f0cc1188e9..bb3c59f6a9e5 100644 --- a/py-polars/polars/testing/parametric/strategies/legacy.py +++ b/py-polars/polars/testing/parametric/strategies/legacy.py @@ -34,6 +34,10 @@ def columns( .. deprecated:: 0.20.26 Use :class:`column` instead in conjunction with a list comprehension. + .. warning:: + This functionality is currently considered **unstable**. It may be + changed at any point without it being considered a breaking change. + Generate a fixed sequence of `column` objects suitable for passing to the @dataframes strategy, or using standalone (note that this function is not itself a strategy).