Merge branch 'main' into RET

Author: dstansby

.pre-commit-config.yaml

@@ -25,3 +25,10 @@ repos:
     rev: 2024.08.19
     hooks:
     - id: sp-repo-review
+
+  -   repo: https://github.com/pre-commit/mirrors-mypy
+      rev: 'v1.4.0'
+      hooks:
+      -   id: mypy
+          args: [--config-file, pyproject.toml]
+          additional_dependencies: [numpy, pytest, zfpy, 'zarr==3.0.0b1']

docs/conf.py

@@ -12,7 +12,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-
 import os
 import sys
 from unittest.mock import Mock as MagicMock
@@ -232,7 +231,7 @@ def __getattr__(cls, name):
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
+latex_elements: dict[str, str] = {
     # The paper size ('letterpaper' or 'a4paper').
     #'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').

docs/release.rst

@@ -11,21 +11,29 @@ Release notes
 Unreleased
 ----------
 
-Fix
-~~~
-* Fix in-place mutation of input array in `BitRound`.
-  By :user:`Sam Levang <slevang>`, :issue:`608`
-* Fix an issue where importing numcodecs would lock the state of `multiprocessing`
-  and prevent user code to call `multiprocessing.set_start_method("spawn")`
-  subsequently.
-  By :user:`Clément Robert <neutrinoceros>` :issue:`522`
+
+.. _release_0.14.0:
+
+0.14.0
+------
 
 Enhancements
 ~~~~~~~~~~~~
 * Add Crc32c checksum codec.
   By :user:`Norman Rzepka <normanrz>`, :issue:`613`.
 * Add codec wrappers for Zarr 3.
   By :user:`Norman Rzepka <normanrz>`, :issue:`524`
+* Added mypy type checking to continuous integration.
+  By :user:`David Stansby <dstansby>`, :issue:`460`.
+
+Fixes
+~~~~~
+* Fix in-place mutation of input array in `BitRound`.
+  By :user:`Sam Levang <slevang>`, :issue:`608`
+* Fix an issue where importing numcodecs would lock the state of `multiprocessing`
+  and prevent user code to call `multiprocessing.set_start_method("spawn")`
+  subsequently.
+  By :user:`Clément Robert <neutrinoceros>` :issue:`522`
 
 Maintenance
 ~~~~~~~~~~~

numcodecs/abc.py

@@ -29,13 +29,14 @@
 """
 
 from abc import ABC, abstractmethod
+from typing import Optional
 
 
 class Codec(ABC):
     """Codec abstract base class."""
 
     # override in sub-class
-    codec_id = None
+    codec_id: Optional[str] = None
     """Codec identifier."""
 
     @abstractmethod

numcodecs/checksum32.py

@@ -1,19 +1,23 @@
 import struct
 import zlib
-from typing import Literal
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Literal
 
 import numpy as np
 
 from .abc import Codec
 from .compat import ensure_contiguous_ndarray, ndarray_copy
 from .jenkins import jenkins_lookup3
 
+if TYPE_CHECKING:
+    from typing_extensions import Buffer
+
 CHECKSUM_LOCATION = Literal['start', 'end']
 
 
 class Checksum32(Codec):
     # override in sub-class
-    checksum = None
+    checksum: Callable[["Buffer", int], int] | None = None
     location: CHECKSUM_LOCATION = 'start'
 
     def __init__(self, location: CHECKSUM_LOCATION | None = None):

numcodecs/compat.py

@@ -100,7 +100,7 @@ def ensure_contiguous_ndarray_like(buf, max_buffer_size=None, flatten=True) -> N
 
     # check for datetime or timedelta ndarray, the buffer interface doesn't support those
     if arr.dtype.kind in "Mm":
-        arr = arr.view(np.int64)
+        arr = arr.view(np.int64)  # type: ignore[arg-type]
 
     # check memory is contiguous, if so flatten
     if arr.flags.c_contiguous or arr.flags.f_contiguous:
@@ -117,7 +117,7 @@ def ensure_contiguous_ndarray_like(buf, max_buffer_size=None, flatten=True) -> N
     return arr
 
 
-def ensure_contiguous_ndarray(buf, max_buffer_size=None, flatten=True) -> np.array:
+def ensure_contiguous_ndarray(buf, max_buffer_size=None, flatten=True) -> np.ndarray:
     """Convenience function to coerce `buf` to a numpy array, if it is not already a
     numpy array. Also ensures that the returned value exports fully contiguous memory,
     and supports the new-style buffer interface. If the optional max_buffer_size is

numcodecs/lzma.py

@@ -1,11 +1,14 @@
-import contextlib
+from types import ModuleType
+from typing import Optional
 
-_lzma = None
+_lzma: Optional[ModuleType] = None
 try:
     import lzma as _lzma
 except ImportError:  # pragma: no cover
-    with contextlib.suppress(ImportError):
-        from backports import lzma as _lzma
+    try:
+        from backports import lzma as _lzma  # type: ignore[no-redef]
+    except ImportError:
+        pass
 
 
 if _lzma:

numcodecs/ndarray_like.py

@@ -1,7 +1,7 @@
 from typing import Any, ClassVar, Optional, Protocol, runtime_checkable
 
 
-class _CachedProtocolMeta(Protocol.__class__):
+class _CachedProtocolMeta(Protocol.__class__):  # type: ignore[name-defined]
     """Custom implementation of @runtime_checkable
 
     The native implementation of @runtime_checkable is slow,

numcodecs/pcodec.py

@@ -1,7 +1,6 @@
 from typing import Literal, Optional
 
-import numcodecs
-import numcodecs.abc
+from numcodecs.abc import Codec
 from numcodecs.compat import ensure_contiguous_ndarray
 
 try:
@@ -13,7 +12,7 @@
 DEFAULT_MAX_PAGE_N = 262144
 
 
-class PCodec(numcodecs.abc.Codec):
+class PCodec(Codec):
     """
     PCodec (or pco, pronounced "pico") losslessly compresses and decompresses
     numerical sequences with high compression ratio and fast speed.

numcodecs/registry.py

@@ -2,11 +2,13 @@
 applications to dynamically register and look-up codec classes."""
 
 import logging
-from importlib.metadata import entry_points
+from importlib.metadata import EntryPoints, entry_points
+
+from numcodecs.abc import Codec
 
 logger = logging.getLogger("numcodecs")
-codec_registry = {}
-entries = {}
+codec_registry: dict[str, Codec] = {}
+entries: dict[str, "EntryPoints"] = {}
 
 
 def run_entrypoints():