array-api-extra 0.3.2__tar.gz → 0.4.0__tar.gz

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.all-contributorsrc

@@ -163,6 +163,17 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "crusaderky",
+      "name": "Guido Imperiale",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6213168?v=4",
+      "profile": "https://github.com/crusaderky",
+      "contributions": [
+        "code",
+        "doc",
+        "tool"
+      ]
     }
   ]
 }

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.github/workflows/cd.yml

@@ -37,7 +37,7 @@ jobs:
           path: dist
 
       - name: Generate artifact attestation for sdist and wheel
-        uses: actions/attest-build-provenance@v1.4.4
+        uses: actions/attest-build-provenance@v2.0.1
         with:
           subject-path: "dist/*"
 

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.github/workflows/ci.yml

@@ -32,8 +32,9 @@ jobs:
           extra_args: --hook-stage manual --all-files
       - uses: prefix-dev/setup-pixi@v0.8.1
         with:
-          pixi-version: v0.37.0
+          pixi-version: v0.39.0
           cache: true
+          environments: lint
       - name: Run Pylint, Mypy & Pyright
         run: |
           pixi run -e lint pylint
@@ -57,7 +58,7 @@ jobs:
 
       - uses: prefix-dev/setup-pixi@v0.8.1
         with:
-          pixi-version: v0.37.0
+          pixi-version: v0.39.0
           cache: true
           environments: ${{ matrix.environment }}
 
@@ -65,6 +66,6 @@ jobs:
         run: pixi run -e ${{ matrix.environment }} tests-ci
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v5.0.7
+        uses: codecov/codecov-action@v5.1.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.github/workflows/docs-build.yml

@@ -9,8 +9,9 @@ jobs:
       - uses: actions/checkout@v4
       - uses: prefix-dev/setup-pixi@v0.8.1
         with:
-          pixi-version: v0.37.0
+          pixi-version: v0.39.0
           cache: true
+          environments: docs
       - name: Build Docs
         run: pixi run -e docs docs
       - name: Upload Artifact

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.github/workflows/docs-deploy.yml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Download Artifact
-        uses: dawidd6/action-download-artifact@v6
+        uses: dawidd6/action-download-artifact@v7
         with:
           workflow: docs-build.yml
           name: docs-build

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.gitignore

@@ -114,9 +114,11 @@ ENV/
 env.bak/
 venv.bak/
 
-# Spyder project settings
+# IDE project settings
+.idea/
 .spyderproject
 .spyproject
+.vscode/
 
 # Rope project settings
 .ropeproject
@@ -160,3 +162,7 @@ Thumbs.db
 # pixi environments
 .pixi
 *.egg-info
+
+# Vendor tests
+vendor_tests/array_api_compat/
+vendor_tests/array_api_extra/

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
         additional_dependencies: [black==24.*]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.6.0"
+    rev: "v5.0.0"
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -35,14 +35,14 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: "v3.3.3"
+    rev: "v3.4.2"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
         args: [--prose-wrap=always]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.6.1"
+    rev: "v0.8.2"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
@@ -68,13 +68,13 @@ repos:
         exclude: .pre-commit-config.yaml
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: "v0.19"
+    rev: "v0.23"
     hooks:
       - id: validate-pyproject
         additional_dependencies: ["validate-pyproject-schema-store[all]"]
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: "0.29.1"
+    rev: "0.30.0"
     hooks:
       - id: check-dependabot
       - id: check-github-workflows

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/CONTRIBUTORS.md

@@ -28,6 +28,7 @@ This project exists thanks to the following contributors
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://ogrisel.com"><img src="https://avatars.githubusercontent.com/u/89061?v=4?s=100" width="100px;" alt="Olivier Grisel"/><br /><sub><b>Olivier Grisel</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=ogrisel" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/crusaderky"><img src="https://avatars.githubusercontent.com/u/6213168?v=4?s=100" width="100px;" alt="Guido Imperiale"/><br /><sub><b>Guido Imperiale</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=crusaderky" title="Code">💻</a> <a href="https://github.com/data-apis/array-api-extra/commits?author=crusaderky" title="Documentation">📖</a> <a href="#tool-crusaderky" title="Tools">🔧</a></td>
     </tr>
   </tbody>
 </table>

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/PKG-INFO

@@ -1,12 +1,10 @@
 Metadata-Version: 2.3
 Name: array-api-extra
-Version: 0.3.2
+Version: 0.4.0
 Summary: Extra array functions built on top of the array API standard.
 Project-URL: Homepage, https://github.com/data-apis/array-api-extra
 Project-URL: Bug Tracker, https://github.com/data-apis/array-api-extra/issues
-Project-URL: Discussions, https://github.com/data-apis/array-api-extra/discussions
 Project-URL: Changelog, https://github.com/data-apis/array-api-extra/releases
-Author: Open Source Contributors
 Author-email: Lucas Colley <lucas.colley8@gmail.com>
 License: MIT License
         
@@ -41,6 +39,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
+Requires-Dist: array-api-compat>=1.1.1
 Provides-Extra: docs
 Requires-Dist: furo>=2023.08.17; extra == 'docs'
 Requires-Dist: myst-parser>=0.13; extra == 'docs'
@@ -122,6 +121,7 @@ This project exists thanks to the following contributors
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://ogrisel.com"><img src="https://avatars.githubusercontent.com/u/89061?v=4?s=100" width="100px;" alt="Olivier Grisel"/><br /><sub><b>Olivier Grisel</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=ogrisel" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/crusaderky"><img src="https://avatars.githubusercontent.com/u/6213168?v=4?s=100" width="100px;" alt="Guido Imperiale"/><br /><sub><b>Guido Imperiale</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=crusaderky" title="Code">💻</a> <a href="https://github.com/data-apis/array-api-extra/commits?author=crusaderky" title="Documentation">📖</a> <a href="#tool-crusaderky" title="Tools">🔧</a></td>
     </tr>
   </tbody>
 </table>

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/README.md

@@ -66,6 +66,7 @@ This project exists thanks to the following contributors
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://ogrisel.com"><img src="https://avatars.githubusercontent.com/u/89061?v=4?s=100" width="100px;" alt="Olivier Grisel"/><br /><sub><b>Olivier Grisel</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=ogrisel" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/crusaderky"><img src="https://avatars.githubusercontent.com/u/6213168?v=4?s=100" width="100px;" alt="Guido Imperiale"/><br /><sub><b>Guido Imperiale</b></sub></a><br /><a href="https://github.com/data-apis/array-api-extra/commits?author=crusaderky" title="Code">💻</a> <a href="https://github.com/data-apis/array-api-extra/commits?author=crusaderky" title="Documentation">📖</a> <a href="#tool-crusaderky" title="Tools">🔧</a></td>
     </tr>
   </tbody>
 </table>

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/docs/conf.py

@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import importlib.metadata
 from typing import Any
 
@@ -38,7 +36,7 @@ html_theme_options: dict[str, Any] = {
                 <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
                     <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
                 </svg>
-            """,
+            """,  # noqa: E501
             "class": "",
         },
     ],

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/docs/contributing.md

@@ -43,13 +43,25 @@ pixi shell -e dev
 pixi run tests
 ```
 
+- To generate the coverage report:
+
+```
+pixi run coverage
+```
+
+- To generate and display the coverage report:
+
+```
+pixi run open-coverage
+```
+
 - To build the docs locally:
 
 ```
 pixi run docs
 ```
 
-- To open and preview the locally-built docs:
+- To build and preview the docs locally:
 
 ```
 pixi run open-docs

{array_api_extra-0.3.2 → array_api_extra-0.4.0}/docs/index.md

@@ -40,7 +40,7 @@ And
 [on conda-forge](https://prefix.dev/channels/conda-forge/packages/array-api-extra):
 
 ```shell
-micromamba install -c https://repo.prefix.dev/conda-forge array-api-extra
+mamba install array-api-extra
 # or
 pixi add array-api-extra
 ```
@@ -51,16 +51,57 @@ If you require stability, it is recommended to pin `array-api-extra` to
 a specific version, or vendor the library inside your own.
 ```
 
+```{note}
+This library depends on array-api-compat. We aim for compatibility with
+the latest released version of array-api-compat, and your mileage may vary
+with older or dev versions.
+```
+
 (vendoring)=
 
 ## Vendoring
 
 To vendor the library, clone
-[the repository](https://github.com/data-apis/array-api-extra) and copy it into
-the appropriate place in your library, like:
+[the array-api-extra repository](https://github.com/data-apis/array-api-extra)
+and copy it into the appropriate place in your library, like:
 
 ```
-cp -R array-api-extra/ mylib/vendored/array_api_extra
+cp -a array-api-extra/src/array_api_extra mylib/vendored/
+```
+
+`array-api-extra` depends on `array-api-compat`. You may either add a dependency
+in your own project to `array-api-compat` or vendor it too:
+
+1. Clone
+   [the array-api-compat repository](https://github.com/data-apis/array-api-compat)
+   and copy it next to your vendored array-api-extra:
+
+   ```
+   cp -a array-api-compat/array_api_compat mylib/vendored/
+   ```
+
+2. Create a new hook file which array-api-extra will use instead of the
+   top-level `array-api-compat` if present:
+
+   ```
+   echo 'from mylib.vendored.array_api_compat import *' > mylib/vendored/_array_api_compat_vendor.py
+   ```
+
+This also allows overriding `array-api-compat` functions if you so wish. E.g.
+your `mylib/vendored/_array_api_compat_vendor.py` could look like this:
+
+```python
+from mylib.vendored.array_api_compat import *
+from mylib.vendored.array_api_compat import array_namespace as _array_namespace_orig
+
+
+def array_namespace(*xs, **kwargs):
+    import mylib
+
+    if any(isinstance(x, mylib.MyArray) for x in xs):
+        return mylib
+    else:
+        return _array_namespace_orig(*xs, **kwargs)
 ```
 
 (usage)=
@@ -81,9 +122,12 @@ return xpx.atleast_nd(y, ndim=2, xp=xp)
 
 ```{note}
 Functions in this library assume input arrays *are arrays* (not "array-likes") and that
-the namespace passed as `xp` is compatible with the standard. This means that
-the namespace you pass as `xp` should come from array-api-compat's ``array_namespace``,
+the namespace passed as `xp` (if given) is compatible with the standard -
+this means that it should come from array-api-compat's `array_namespace`,
 or otherwise be compatible with the standard.
+
+Calling functions without providing an `xp` argument means that `array_namespace`
+is called internally to determine the namespace.
 ```
 
 In the examples shown in the docstrings of functions from this library,
@@ -92,6 +136,9 @@ array namespace `xp`. In reality, code using this library will be written to
 work with any compatible array namespace as `xp`, not any particular
 implementation.
 
+Some functions may only work with array libraries supported by array-api-compat.
+This will be clearly indicated in the docs.
+
 (scope)=
 
 ## Scope
@@ -102,11 +149,15 @@ Functions that are in-scope for this library will:
   standard.
 - Implement functionality which may be generally useful across various
   libraries.
-- Be implemented purely in terms of the array API standard.
 - Be implemented with type annotations and
   [numpydoc-style docstrings](https://numpydoc.readthedocs.io/en/latest/format.html).
 - Be tested against `array-api-strict`.
 
+Functions are implemented purely in terms of the array API standard where
+possible. Where functions must use library-specific helpers for libraries
+supported by array-api-compat, this will be clearly marked in their API
+reference page.
+
 In particular, the following kinds of function are also in-scope:
 
 - Functions which implement
@@ -117,20 +168,15 @@ In particular, the following kinds of function are also in-scope:
 
 The following features are currently out-of-scope for this library:
 
-- Delegation to known, existing array libraries.
+- Delegation to known, existing array libraries (unless necessary).
   - It is quite simple to wrap functions in this library to also use existing
-    implementations where possible. Such delegation will not live in this
-    library for now, but the array-agnostic functions in this library could form
-    an array-agnostic backend for such delegating functions in the future, here
-    or elsewhere.
+    implementations. Such delegation will not live in this library for now, but
+    the array-agnostic functions in this library could form an array-agnostic
+    backend for such delegating functions in the future, here or elsewhere.
 - Functions which accept "array-like" input, or standard-incompatible
   namespaces.
   - It is possible to prepare input arrays and a standard-compatible namespace
-    via `array-api-compat` downstream in consumer libraries. Avoiding use of
-    `array-api-compat` in this library makes it easier to vendor and reduces
-    potential redundant calls to `xp.asarray` and `array_namespace`.
-  - For proposed alternatives to the `xp=xp` interface, see
-    [this issue](https://github.com/data-apis/array-api-extra/issues/6).
+    via `array-api-compat` downstream in consumer libraries.
 - Functions which are specific to a particular domain.
   - These functions may belong better in an array-consuming library which is
     specific to that domain.