cobra-array 0.1.0__tar.gz

cobra_array-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Cathie Li
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cobra_array-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: cobra-array
+Version: 0.1.0
+Summary: A backend-agnostic array utility library that unifies array conversion, context control, and cross-library operations across `NumPy`/`PyTorch`-style ecosystems.
+Author-email: Zhen Tian <zhen.tian.cs@gmail.com>
+Project-URL: Homepage, https://github.com/tinchen777/cobra-array.git
+Project-URL: Repository, https://github.com/tinchen777/cobra-array.git
+Project-URL: Issues, https://github.com/tinchen777/cobra-array.git/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: array-api-compat>=1.11.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: numpy<2.0,>=1.21; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<h2 id="title">
+🍁 cobra-array 🍁<br>
+<sub>Unified Array Utilities with Python Array API Compatibility</sub>
+</h2>
+
+[![PyPI version](https://img.shields.io/pypi/v/cobra-array.svg)](https://pypi.org/project/cobra-array/)
+![Python](https://img.shields.io/pypi/pyversions/cobra-array?color=brightgreen)
+[![codecov](https://codecov.io/gh/tinchen777/cobra-array/branch/main/graph/badge.svg)](https://codecov.io/gh/tinchen777/cobra-array)
+![License](https://img.shields.io/github/license/tinchen777/cobra-array.svg)
+
+[![Tests](https://github.com/tinchen777/cobra-array/actions/workflows/test.yml/badge.svg)](https://github.com/tinchen777/cobra-array/actions/workflows/test.yml)
+![Github stars](https://img.shields.io/github/stars/tinchen777/cobra-array.svg)
+
+</div>
+
+## About
+
+`cobra-array` is a backend-agnostic array utility library that unifies array conversion, context control, and cross-library operations across `NumPy`/`PyTorch`-style ecosystems.
+
+- Python: 3.9+
+- Runtime deps: `array-api-compat` (>= 1.11.2)
+
+## Features
+
+- 🚀 **Ackend-agnostic API**: Work with different array backends through one consistent interface.
+- 🚀 **Context-driven unification**: Automatically align namespace, dtype, and device via context managers and decorators.
+- 🚀 **Compatibility wrappers**: `CompatArray` and `CompatNamespace` provide a clean, consistent layer over native backend behavior.
+
+## Installation
+
+### Install from PyPI
+
+```bash
+pip install cobra-array
+```
+
+## Quick Start
+
+- Basic conversions:
+
+    ```python
+    import numpy as np
+    from cobra_array.convert import to_numpy, to_tensor, to_list
+
+    data = [[1, 2], [3, 4]]
+
+    arr_np = to_numpy(data, dtype=np.float32)
+    print(type(arr_np), arr_np.dtype)  # numpy.ndarray float32
+
+    arr_torch = to_tensor(data, device="cpu")
+    print(type(arr_torch), arr_torch.device)
+
+    back_to_list = to_list(arr_np)
+    print(back_to_list)  # [[1.0, 2.0], [3.0, 4.0]]
+    ```
+
+- Context-based conversion:
+
+    ```python
+    import numpy as np
+    from cobra_array import array_context, as_context, context_spec
+
+    with array_context(xp="numpy", dtype=np.float32, device="cpu"):
+        x = as_context([1, 2, 3])
+        y = as_context(np.array([4, 5]))
+        spec = context_spec()
+        print(spec.cxp.xp_name, spec.dtype, spec.device)
+        print(x, y)
+    ```
+
+- Auto-unify function arguments:
+
+    ```python
+    import numpy as np
+    from cobra_array import unify_args
+
+    @unify_args(ref=0, unify_dtype=True, unify_device=True, arraylike_only=True)
+    def add_and_mean(a, b):
+        c = a + b
+        return c.mean()
+
+    out = add_and_mean(np.array([1, 2, 3]), [4, 5, 6])
+    print(out)
+    ```
+
+- Default backend strategy:
+
+    ```python
+    from cobra_array.default import as_default, default_spec
+
+    spec = default_spec()
+    print(spec.cxp.xp_name, spec.dtype, spec.device)
+
+    x = as_default([1, 2, 3], unify_dtype=True, unify_device=True)
+    print(x, x.dtype)
+    ```
+
+## Requirements
+
+- Python >= 3.9
+- `array-api-compat` >= 1.11.2
+
+## License
+
+See LICENSE in the repository.
+
+## Links
+
+- [Homepage/Repo](https://github.com/tinchen777/cobra-array.git)
+- [Issues](https://github.com/tinchen777/cobra-array.git/issues)

cobra_array-0.1.0/README.md

@@ -0,0 +1,112 @@
+<div align="center">
+
+<h2 id="title">
+🍁 cobra-array 🍁<br>
+<sub>Unified Array Utilities with Python Array API Compatibility</sub>
+</h2>
+
+[![PyPI version](https://img.shields.io/pypi/v/cobra-array.svg)](https://pypi.org/project/cobra-array/)
+![Python](https://img.shields.io/pypi/pyversions/cobra-array?color=brightgreen)
+[![codecov](https://codecov.io/gh/tinchen777/cobra-array/branch/main/graph/badge.svg)](https://codecov.io/gh/tinchen777/cobra-array)
+![License](https://img.shields.io/github/license/tinchen777/cobra-array.svg)
+
+[![Tests](https://github.com/tinchen777/cobra-array/actions/workflows/test.yml/badge.svg)](https://github.com/tinchen777/cobra-array/actions/workflows/test.yml)
+![Github stars](https://img.shields.io/github/stars/tinchen777/cobra-array.svg)
+
+</div>
+
+## About
+
+`cobra-array` is a backend-agnostic array utility library that unifies array conversion, context control, and cross-library operations across `NumPy`/`PyTorch`-style ecosystems.
+
+- Python: 3.9+
+- Runtime deps: `array-api-compat` (>= 1.11.2)
+
+## Features
+
+- 🚀 **Ackend-agnostic API**: Work with different array backends through one consistent interface.
+- 🚀 **Context-driven unification**: Automatically align namespace, dtype, and device via context managers and decorators.
+- 🚀 **Compatibility wrappers**: `CompatArray` and `CompatNamespace` provide a clean, consistent layer over native backend behavior.
+
+## Installation
+
+### Install from PyPI
+
+```bash
+pip install cobra-array
+```
+
+## Quick Start
+
+- Basic conversions:
+
+    ```python
+    import numpy as np
+    from cobra_array.convert import to_numpy, to_tensor, to_list
+
+    data = [[1, 2], [3, 4]]
+
+    arr_np = to_numpy(data, dtype=np.float32)
+    print(type(arr_np), arr_np.dtype)  # numpy.ndarray float32
+
+    arr_torch = to_tensor(data, device="cpu")
+    print(type(arr_torch), arr_torch.device)
+
+    back_to_list = to_list(arr_np)
+    print(back_to_list)  # [[1.0, 2.0], [3.0, 4.0]]
+    ```
+
+- Context-based conversion:
+
+    ```python
+    import numpy as np
+    from cobra_array import array_context, as_context, context_spec
+
+    with array_context(xp="numpy", dtype=np.float32, device="cpu"):
+        x = as_context([1, 2, 3])
+        y = as_context(np.array([4, 5]))
+        spec = context_spec()
+        print(spec.cxp.xp_name, spec.dtype, spec.device)
+        print(x, y)
+    ```
+
+- Auto-unify function arguments:
+
+    ```python
+    import numpy as np
+    from cobra_array import unify_args
+
+    @unify_args(ref=0, unify_dtype=True, unify_device=True, arraylike_only=True)
+    def add_and_mean(a, b):
+        c = a + b
+        return c.mean()
+
+    out = add_and_mean(np.array([1, 2, 3]), [4, 5, 6])
+    print(out)
+    ```
+
+- Default backend strategy:
+
+    ```python
+    from cobra_array.default import as_default, default_spec
+
+    spec = default_spec()
+    print(spec.cxp.xp_name, spec.dtype, spec.device)
+
+    x = as_default([1, 2, 3], unify_dtype=True, unify_device=True)
+    print(x, x.dtype)
+    ```
+
+## Requirements
+
+- Python >= 3.9
+- `array-api-compat` >= 1.11.2
+
+## License
+
+See LICENSE in the repository.
+
+## Links
+
+- [Homepage/Repo](https://github.com/tinchen777/cobra-array.git)
+- [Issues](https://github.com/tinchen777/cobra-array.git/issues)

cobra_array-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cobra-array"
+dynamic = ["version"]
+description = "A backend-agnostic array utility library that unifies array conversion, context control, and cross-library operations across `NumPy`/`PyTorch`-style ecosystems."
+readme = "README.md"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Zhen Tian", email = "zhen.tian.cs@gmail.com"}
+]
+requires-python = ">=3.9"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "array-api-compat>=1.11.2"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "numpy>=1.21,<2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/tinchen777/cobra-array.git"
+Repository = "https://github.com/tinchen777/cobra-array.git"
+Issues = "https://github.com/tinchen777/cobra-array.git/issues"
+
+[tool.setuptools.dynamic]
+version = {attr = "cobra_array.__version__"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["cobra_array*"]

cobra_array-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cobra_array-0.1.0/src/cobra_array/__init__.py

@@ -0,0 +1,105 @@
+# src/cobra_array/__init__.py
+"""
+cobra-array
+===========
+
+A unified array interface for multiple array libraries, providing seamless interoperability and convenient utilities for array manipulation and conversion.
+A backend-agnostic array utility library that unifies array conversion, context control, and cross-library operations across NumPy/PyTorch-style ecosystems.
+
+Modules
+-------
+- :mod:`cobra_array.compat`: Compatibility utilities for `compatibility namespaces` and `compatibility arrays`.
+- :mod:`cobra_array.convert`: Utilities for converting between different array types and namespaces.
+- :mod:`cobra_array.default`: Default utilities for array specifications and namespaces.
+- :mod:`cobra_array.array_api`: Utilities for working with array namespaces and devices.
+Functions
+---------
+- :func:`array_spec`: Get the array specification of an object.
+- :func:`context_spec`: Get the context specification of an object.
+- :func:`as_context`: Convert an array-like object to an array in the determined context namespace.
+- :func:`array_context`: Get the context namespace for a given array or set of arrays.
+- :func:`unify_args`: A decorator to unify the array arguments of a function to the same namespace, dtype, and device.
+- :func:`array_namespace_alias`: Get the alias of an array namespace if it exists.
+- :func:`is_compat_namespace`: Check if an object is a `compatibility namespace`.
+- :func:`is_array_namespace`: Check if an object is an `array namespace`.
+
+Examples
+--------
+Basic conversions::
+
+    import numpy as np
+    from cobra_array.convert import to_numpy, to_tensor, to_list
+
+    data = [[1, 2], [3, 4]]
+
+    arr_np = to_numpy(data, dtype=np.float32)
+    print(type(arr_np), arr_np.dtype)  # numpy.ndarray float32
+
+    arr_torch = to_tensor(data, device="cpu")
+    print(type(arr_torch), arr_torch.device)
+
+    back_to_list = to_list(arr_np)
+    print(back_to_list)  # [[1.0, 2.0], [3.0, 4.0]]
+
+Context-based conversion::
+
+    import numpy as np
+    from cobra_array import array_context, as_context, context_spec
+
+    with array_context(xp="numpy", dtype=np.float32, device="cpu"):
+        x = as_context([1, 2, 3])
+        y = as_context(np.array([4, 5]))
+        spec = context_spec()
+        print(spec.cxp.xp_name, spec.dtype, spec.device)
+        print(x, y)
+
+Auto-unify function arguments::
+
+    import numpy as np
+    from cobra_array import unify_args
+
+    @unify_args(ref=0, unify_dtype=True, unify_device=True, arraylike_only=True)
+    def add_and_mean(a, b):
+        c = a + b
+        return c.mean()
+
+    out = add_and_mean(np.array([1, 2, 3]), [4, 5, 6])
+    print(out)
+
+Default backend strategy::
+
+    from cobra_array.default import as_default, default_spec
+
+    spec = default_spec()
+    print(spec.cxp.xp_name, spec.dtype, spec.device)
+
+    x = as_default([1, 2, 3], unify_dtype=True, unify_device=True)
+    print(x, x.dtype)
+"""
+
+from ._core import (
+    array_spec,
+    context_spec,
+    as_context,
+    array_context,
+    unify_args
+)
+from ._utils import (
+    array_namespace_alias,
+    is_compat_namespace,
+    is_array_namespace
+)
+
+__author__ = "Zhen Tian"
+__version__ = "0.1.0"
+
+__all__ = [
+    "array_spec",
+    "context_spec",
+    "as_context",
+    "array_context",
+    "unify_args",
+    "array_namespace_alias",
+    "is_compat_namespace",
+    "is_array_namespace"
+]