ENH: testing: make assertion functions public (#753)

* ENH: testing: make assertion functions public

* revisions

* TST/CI: add run-deps tests

Author: lucascolley

.github/workflows/ci.yml

@@ -57,6 +57,8 @@ jobs:
             runs-on: ubuntu-latest
           - environment: tests-backends-py311
             runs-on: ubuntu-latest
+          - environment: tests-run-deps
+            runs-on: ubuntu-slim
 
     environment:
       name: ci-checks
@@ -76,7 +78,7 @@ jobs:
 
       - name: Test package
         # Save some time; also at the moment of writing coverage crashes on python 3.13t
-        if: ${{ matrix.environment != 'tests-nogil' }}
+        if: ${{ matrix.environment != 'tests-nogil' && matrix.environment != 'tests-run-deps' }}
         run: pixi run -e "${TASK_ENV}" tests-ci
         env:
           TASK_ENV: ${{ matrix.environment }}
@@ -85,6 +87,10 @@ jobs:
         if: ${{ matrix.environment == 'tests-nogil' }}
         run: pixi run -e tests-nogil tests --parallel-threads=4
 
+      - name: Run dependency tests
+        if: ${{ matrix.environment == 'tests-run-deps' }}
+        run: pixi run tests-run-deps-cov
+
       - name: Upload coverage report
         if: ${{ matrix.environment != 'tests-nogil' }}
         uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0

docs/_templates/autosummary/class.rst

@@ -0,0 +1,5 @@
+{{ name | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ fullname }}

docs/_templates/autosummary/function.rst

@@ -0,0 +1,5 @@
+{{ name | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ fullname }}

docs/_templates/testing-function.rst

@@ -0,0 +1,5 @@
+{{ fullname.split('.')[-2:] | join('.') | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ fullname }}

docs/api-reference.md docs/api-assorted.mddocs/api-reference.md renamed to docs/api-assorted.md

@@ -1,4 +1,4 @@
-# API Reference
+# Assorted functions
 
 ```{eval-rst}
 .. currentmodule:: array_api_extra

docs/api-lazy.md

@@ -1,7 +1,7 @@
 # Tools for lazy backends
 
-These additional functions are meant to be used to support compatibility with
-lazy backends, e.g. Dask or JAX:
+Additional functions with special behaviour for lazy backends,
+e.g. Dask or JAX:
 
 ```{eval-rst}
 .. currentmodule:: array_api_extra
@@ -10,6 +10,17 @@ lazy backends, e.g. Dask or JAX:
     :toctree: generated
 
     lazy_apply
+```
+
+Testing utilities:
+
+```{eval-rst}
+.. currentmodule:: array_api_extra
+.. autosummary::
+    :nosignatures:
+    :template: testing-function.rst
+    :toctree: generated
+
     testing.lazy_xp_function
     testing.patch_lazy_xp_functions
 ```

docs/api-testing.md

@@ -0,0 +1,18 @@
+# Testing utilities (`xpx.testing`)
+
+These testing utilities are intended to help transition from using
+{py:mod}`numpy.testing`.
+
+```{eval-rst}
+.. currentmodule:: array_api_extra.testing
+.. autosummary::
+    :nosignatures:
+    :template: testing-function.rst
+    :toctree: generated
+
+    assert_close
+    assert_equal
+    assert_less
+```
+
+See also utilities specific to testing lazy backends in {doc}`api-lazy`.

docs/conf.py

@@ -66,4 +66,6 @@
     ("py:class", "_io.BytesIO"),
 ]
 
+templates_path = ["_templates"]
+
 always_document_param_types = True

docs/index.md

@@ -4,7 +4,8 @@
 :maxdepth: 2
 :hidden:
 self
-api-reference.md
+api-assorted.md
+api-testing.md
 api-lazy.md
 contributing.md
 contributors.md