Hypothesis strategies in xarray.testing.strategies

doc/api.rst

@@ -1107,6 +1107,10 @@ See the :ref:`documentation page on testing <testing.hypothesis>` for a guide on
    testing.strategies.dimension_sizes
    testing.strategies.attrs
    testing.strategies.variables
+   testing.strategies.coordinate_variables
+   testing.strategies.dataarrays
+   testing.strategies.data_variables
+   testing.strategies.datasets
    testing.strategies.unique_subset_of
 
 Exceptions

doc/conf.py

@@ -329,6 +329,8 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     "cftime": ("https://unidata.github.io/cftime", None),
+    "sparse": ("https://sparse.pydata.org/en/latest/", None),
+    "hypothesis": ("https://hypothesis.readthedocs.io/en/latest/", None),
     "cubed": ("https://cubed-dev.github.io/cubed/", None),
     "dask": ("https://docs.dask.org/en/latest", None),
     "datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None),

doc/user-guide/testing.rst

@@ -51,6 +51,10 @@ These strategies are accessible in the :py:mod:`xarray.testing.strategies` modul
    testing.strategies.dimension_sizes
    testing.strategies.attrs
    testing.strategies.variables
+   testing.strategies.coordinate_variables
+   testing.strategies.dataarrays
+   testing.strategies.data_variables
+   testing.strategies.datasets
    testing.strategies.unique_subset_of
 
 These build upon the numpy and array API strategies offered in :py:mod:`hypothesis.extra.numpy` and :py:mod:`hypothesis.extra.array_api`:
@@ -89,7 +93,6 @@ In your tests however you should not use ``.example()`` - instead you should par
     def test_function_that_acts_on_variables(var):
         assert func(var) == ...
 
-
 Chaining Strategies
 ~~~~~~~~~~~~~~~~~~~
 
@@ -145,6 +148,7 @@ objects your chained strategy will generate.
     fixed_x_variable_y_maybe_z = st.fixed_dictionaries(
         {"x": st.just(2), "y": st.integers(3, 4)}, optional={"z": st.just(2)}
     )
+
     fixed_x_variable_y_maybe_z.example()
 
     special_variables = xrst.variables(dims=fixed_x_variable_y_maybe_z)
@@ -156,6 +160,7 @@ Here we have used one of hypothesis' built-in strategies :py:func:`hypothesis.st
 strategy which generates mappings of dimension names to lengths (i.e. the ``size`` of the xarray object we want).
 This particular strategy will always generate an ``x`` dimension of length 2, and a ``y`` dimension of
 length either 3 or 4, and will sometimes also generate a ``z`` dimension of length 2.
+
 By feeding this strategy for dictionaries into the ``dims`` argument of xarray's :py:func:`~st.variables` strategy,
 we can generate arbitrary :py:class:`~xarray.Variable` objects whose dimensions will always match these specifications.
 

doc/whats-new.rst

@@ -26,6 +26,10 @@ New Features
   By `Tom White <https://github.com/tomwhite>`_.
 - Allow data variable specific ``constant_values`` in the dataset ``pad`` function (:pull:`9353``).
   By `Tiago Sanona <https://github.com/tsanona>`_.
+- Added a suite of hypothesis strategies for generating xarray objects containing arbitrary data, useful for testing.
+  Accessible under :py:func:`testing.strategies`, and documented in a new page on testing in the User Guide.
+  (:issue:`6911`, :pull:`6908`)
+  By `Tom Nicholas <https://github.com/TomNicholas>`_.
 
 Breaking changes
 ~~~~~~~~~~~~~~~~