Merge pull request silx-kit#350 from t20100/types

Added typing

Author: t20100

.github/workflows/ci.yml

@@ -17,11 +17,12 @@ jobs:
         with:
           python-version: '3.12'
           cache: 'pip'
-      - run: python -m pip install --upgrade pip bandit black build flake8 isort twine
+      - run: python -m pip install --upgrade pip bandit black build flake8 isort mypy numpy twine
       - run: bandit -c pyproject.toml -r .
       - run: black --check .
       - run: flake8
       - run: isort --check .
+      - run: mypy
       - run: python -m build --sdist
       - run: python -m twine check dist/*
       # Build documentation

doc/conf.py

@@ -29,6 +29,7 @@
     "sphinx.ext.autodoc",
     "nbsphinx",
     "sphinx_rtd_theme",
+    "sphinx_autodoc_typehints",
 ]
 
 

doc/contribute.rst

@@ -45,6 +45,10 @@ From the source directory:
 
     bandit -c pyproject.toml -r .
 
+* Check typing with `mypy <https://mypy.readthedocs.io>`_`::
+
+    mypy
+
 Building documentation
 ======================
 

pyproject.toml

@@ -38,6 +38,7 @@ doc = [
     "ipython",
     "nbsphinx",
     "sphinx",
+    "sphinx-autodoc-typehints",
     "sphinx_rtd_theme",
 ]
 test = [
@@ -81,3 +82,24 @@ extend-exclude = '''
 [tool.isort]
 profile = "black"
 skip_glob = ["lib"]
+
+[tool.mypy]
+mypy_path = ["src"]
+packages = ["hdf5plugin"]
+strict = true
+implicit_optional = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = ["hdf5plugin.test"]
+disable_error_code = [
+    "attr-defined",
+    "no-untyped-def",
+]
+
+[[tool.mypy.overrides]]
+module = [
+    "blosc2",
+    "hdf5plugin._config",
+]
+ignore_missing_imports = true

src/h5py.pyi

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+"""mypy stubs for h5py usage in hdf5plugin"""
+
+import ctypes
+from collections.abc import Buffer
+from types import TracebackType
+from typing import Any, BinaryIO, Tuple
+
+from numpy.typing import ArrayLike, DTypeLike, NDArray
+
+class DatasetId:
+    def write_direct_chunk(self, offset: tuple[int, ...], data: Buffer) -> None: ...
+
+class Dataset:
+    def __getitem__(
+        self, key: int | slice | tuple[int | slice, ...]
+    ) -> NDArray[Any]: ...
+    @property
+    def id(self) -> DatasetId: ...
+
+class File:
+    def __init__(
+        self,
+        name: str | BinaryIO,
+        mode: str = "r",
+        driver: str = None,
+        backing_store: bool = None,
+    ): ...
+    def __enter__(self) -> File: ...
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> bool | None: ...
+    def __getitem__(self, key: str) -> Any: ...
+    def create_dataset(
+        self,
+        name: str,
+        shape: tuple[int, ...] = None,
+        dtype: DTypeLike = None,
+        data: ArrayLike = None,
+        chunks: tuple[int, ...] | bool | None = None,
+        compression: filters.FilterRefBase = None,
+    ) -> Any: ...
+    def flush(self) -> None: ...
+
+class filters:
+    class FilterRefBase:
+        filter_id: int | None = None
+        filter_options: Tuple[int, ...] = ()
+
+        def __len__(self) -> int: ...
+
+class h5:
+    @staticmethod
+    def get_libversion() -> tuple[int, ...]: ...
+
+class h5z:
+    __file__: str
+
+    @staticmethod
+    def filter_avail(filter_id: int) -> bool: ...
+    @staticmethod
+    def register_filter(filter_: ctypes.c_void_p) -> None: ...
+    @staticmethod
+    def unregister_filter(filter_id: int) -> bool: ...
+
+class version:
+    version_tuple: Tuple[int, ...]