Merge branch 'main' into apply

Author: crusaderky

docs/contributing.md

@@ -6,11 +6,14 @@ converting code to consume the standard.
 
 Thanks to [all contributors](contributors.md) so far!
 
-## How to contribute a function
+## How to contribute a new function
 
 - [Open an issue](https://github.com/data-apis/array-api-extra/issues/new) to
-  propose the new function.
-- Add the implementation of your function to `src/array_api_extra/_funcs.py`.
+  propose the new function. You may want to wait for initial feedback on the
+  issue before diving into an implementation. Feel free to skip this step if
+  there is already an open issue for the function.
+- Add the implementation of your function to
+  `src/array_api_extra/_lib/_funcs.py`.
   - Ensure that your function includes type annotations and a
     [numpydoc-style docstring](https://numpydoc.readthedocs.io/en/latest/format.html).
   - Add your function to `__all__` at the top of the file.
@@ -20,6 +23,33 @@ Thanks to [all contributors](contributors.md) so far!
 - Add your function to `docs/api-reference.md`.
 - [Make a PR!](https://github.com/data-apis/array-api-extra/pulls)
 
+## How to add delegation to a function
+
+See [the tracker for adding delegation][delegation-tracker].
+
+[delegation-tracker]: https://github.com/data-apis/array-api-extra/issues/100
+
+- If you would like to discuss the task before diving into the implementation,
+  click on the three dots next to the function on the tracker issue, and choose
+  "Convert to sub-issue".
+- Create a function in `src/array_api_extra/_delegation.py` with a signature
+  matching the function in `src/array_api_extra/_lib/_funcs.py`, and move the
+  docstring to the new function. Leave a one-line docstring in `_funcs.py`,
+  pointing to `_delegation.py` to see the full docstring.
+- Also move the initial `array_namespace` call and any input validation over to
+  the new function.
+- Add delegation to backends using the `if _delegate` pattern. See
+  `src/array_api_extra/_lib/_backends.py` for the full list of backends we have
+  worked with so far.
+- After all delegation layers, return the result from the implementation in
+  `_funcs`.
+- Simplify the signature in `_funcs.py` to remove impossible arguments now that
+  it is only called internally via `_delegation`. For example, the `xp`
+  parameter can be changed from type `ModuleType | None` to `ModuleType`.
+- Don't worry if you are not sure how to do some of the above steps or think you
+  might have done something wrong -
+  [make a PR!](https://github.com/data-apis/array-api-extra/pulls)
+
 ## Development workflow
 
 If you are an experienced contributor to Python packages, feel free to develop

pixi.lock

@@ -28,21 +28,6 @@ classifiers = [
 dynamic = ["version"]
 dependencies = ["array-api-compat>=1.10.0,<2"]
 
-[project.optional-dependencies]
-tests = [
-    "pytest >=6",
-    "pytest-cov >=3",
-    "array-api-strict",
-    "numpy",
-]
-docs = [
-    "sphinx>=7.0",
-    "myst_parser>=0.13",
-    "sphinx_copybutton",
-    "sphinx_autodoc_typehints",
-    "furo>=2023.08.17",
-]
-
 [project.urls]
 Homepage = "https://github.com/data-apis/array-api-extra"
 "Bug Tracker" = "https://github.com/data-apis/array-api-extra/issues"
@@ -168,7 +153,7 @@ cupy = "*"
 
 [tool.pixi.environments]
 default = { solve-group = "default" }
-lint = { features = ["lint"], solve-group = "default" }
+lint = { features = ["lint", "backends"], solve-group = "default" }
 tests = { features = ["tests"], solve-group = "default" }
 docs = { features = ["docs"], solve-group = "default" }
 dev = { features = ["lint", "tests", "docs", "dev", "backends"], solve-group = "default" }
@@ -179,30 +164,24 @@ ci-py313 = ["py313", "tests"]
 ci-backends = ["py310", "tests", "backends"]
 tests-backends = ["py310", "tests", "backends", "cuda-backends"]
 
+
 # pytest
 
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
 xfail_strict = true
-filterwarnings = [
-    "error",
-    # TODO: when Python 3.10 is dropped, use `enum.member` in `_delegation.py`
-    "ignore:functools.partial will be a method descriptor:FutureWarning",
-]
+filterwarnings = ["error"]
 log_cli_level = "INFO"
 testpaths = ["tests"]
 markers = ["skip_xp_backend(library, *, reason=None): Skip test for a specific backend"]
 
+
 # Coverage
 
 [tool.coverage]
 run.source = ["array_api_extra"]
-report.exclude_also = [
-    '\.\.\.',
-    'if typing.TYPE_CHECKING:',
-    'if TYPE_CHECKING:',
-]
+report.exclude_also = ['\.\.\.']
 
 
 # mypy
@@ -213,18 +192,11 @@ python_version = "3.10"
 warn_unused_configs = true
 strict = true
 enable_error_code = ["ignore-without-code", "truthy-bool"]
-disallow_untyped_defs = false
-disallow_incomplete_defs = false
-# data-apis/array-api#589
+# https://github.com/data-apis/array-api-typing
 disallow_any_expr = false
 # false positives with input validation
 disable_error_code = ["redundant-expr", "unreachable"]
 
-[[tool.mypy.overrides]]
-module = "array_api_extra.*"
-disallow_untyped_defs = true
-disallow_incomplete_defs = true
-
 
 # pyright
 
@@ -234,10 +206,10 @@ pythonVersion = "3.10"
 pythonPlatform = "All"
 typeCheckingMode = "all"
 
-# data-apis/array-api#589
+# https://github.com/data-apis/array-api-typing
 reportAny = false
 reportExplicitAny = false
-# data-apis/array-api-strict#6
+# no array-api-strict type stubs
 reportUnknownMemberType = false
 # no array-api-compat type stubs
 reportUnknownVariableType = false
@@ -294,25 +266,17 @@ ignore = [
     "N806",    # Variable in function should be lowercase
 ]
 
-[tool.ruff.lint.per-file-ignores]
-"tests/**" = ["T20"]
-
 
 # Pylint
 
 [tool.pylint]
 py-version = "3.10"
-ignore-paths = [".*/_version.py"]
 reports.output-format = "colorized"
-similarities.ignore-imports = "yes"
 messages_control.disable = [
-    "design",
-    "fixme",
-    "line-too-long",
-    "missing-module-docstring",
-    "missing-function-docstring",
-    "too-many-lines",
-    "wrong-import-position",
+    "design",                     # ignore heavily opinionated design checks
+    "fixme",                      # allow FIXME comments
+    "line-too-long",              # ruff handles this
+    "missing-function-docstring", # numpydoc handles this
 ]
 
 
@@ -321,9 +285,9 @@ messages_control.disable = [
 [tool.numpydoc_validation]
 checks = [
     "all",  # report on all checks, except the below
-    "EX01",
-    "SA01",
-    "ES01",
+    "EX01", # most docstrings do not need an example
+    "SA01", # data-apis/array-api-extra#87
+    "ES01", # most docstrings do not need an extended summary
 ]
 exclude = [ # don't report on objects that match any of these regex
     '.*test_at.*',

pyproject.toml

@@ -1,8 +1,8 @@
 """Extra array functions built on top of the array API standard."""
 
 from ._delegation import pad
+from ._lib._at import at
 from ._lib._funcs import (
-    at,
     atleast_nd,
     cov,
     create_diagonal,