Move APIs (#12)

Author: flying-sheep

docs/index.rst

@@ -5,8 +5,15 @@
    :members:
 
 
-``fast_array_utils.scipy``
---------------------------
+``fast_array_utils.conv``
+-------------------------
 
-.. automodule:: fast_array_utils.scipy
+.. automodule:: fast_array_utils.conv
    :members:
+
+
+``fast_array_utils.types``
+--------------------------
+
+.. automodule:: fast_array_utils.types
+   :members: OutOfCoreDataset

pyproject.toml

@@ -111,7 +111,7 @@ run.data_file = "test-data/.coverage"
 xml.output = "test-data/coverage.xml"
 html.directory = "test-data/htmlcov"
 run.omit = [ "src/testing/*", "tests/*" ]
-report.exclude_also = [ "if TYPE_CHECKING:", "@numba.njit" ]
+report.exclude_also = [ "if TYPE_CHECKING:", "@numba[.]njit", "[.]{3}" ]
 
 [tool.mypy]
 strict = true

src/fast_array_utils/__init__.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from ._asarray import OutOfCoreDataset, asarray
+from . import conv, types
 
 
-__all__ = ["OutOfCoreDataset", "asarray"]
+__all__ = ["conv", "types"]

src/fast_array_utils/conv/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: MPL-2.0
+"""Conversion utilities."""
+
+from __future__ import annotations
+
+from ._asarray import asarray
+
+
+__all__ = ["asarray"]

src/fast_array_utils/_asarray.py renamed to src/fast_array_utils/conv/_asarray.py

@@ -6,7 +6,7 @@
 
 import numpy as np
 
-from .types import CSBase, CupyArray, CupySparseMatrix, DaskArray, H5Dataset, OutOfCoreDataset
+from ..types import CSBase, CupyArray, CupySparseMatrix, DaskArray, H5Dataset, OutOfCoreDataset
 
 
 if TYPE_CHECKING:

src/fast_array_utils/scipy/__init__.py renamed to src/fast_array_utils/conv/scipy/__init__.py

@@ -12,7 +12,7 @@
 
     from numpy.typing import NDArray
 
-    from ..types import CSBase
+    from ...types import CSBase
 
     DT_co = TypeVar("DT_co", bound=np.generic, covariant=True)
     DT = TypeVar("DT", bound=np.generic)
@@ -41,7 +41,7 @@ def to_dense(x: CSBase[DT_co], order: Literal["C", "F"] = "C") -> NDArray[DT_co]
         _to_dense_csr_numba(x.indptr, x.indices, x.data, out)
     elif x.format == "csc":
         _to_dense_csc_numba(x.indptr, x.indices, x.data, out)
-    else:
+    else:  # pragma: no cover
         out = x.toarray(order=order)
     return out
 

src/fast_array_utils/scipy/_to_dense.py renamed to src/fast_array_utils/conv/scipy/_to_dense.py

@@ -7,7 +7,7 @@
 import numpy as np
 import pytest
 
-from fast_array_utils._asarray import asarray
+from fast_array_utils.conv import asarray
 
 
 if TYPE_CHECKING:

tests/test_asarray.py

@@ -7,7 +7,7 @@
 import numpy as np
 import pytest
 
-from fast_array_utils.scipy import to_dense
+from fast_array_utils.conv.scipy import to_dense
 
 
 if TYPE_CHECKING: