Bpr

.github/workflows/ci.yml

@@ -74,6 +74,23 @@ jobs:
                 curl -L -O https://gitlab.tiker.net/inducer/ci-support/raw/main/prepare-and-run-mypy.sh
                 . ./prepare-and-run-mypy.sh python3 mypy
 
+    basedpyright:
+        runs-on: ubuntu-latest
+        steps:
+        -   uses: actions/checkout@v4
+        -   uses: actions/setup-python@v5
+            with:
+                python-version: '3.x'
+        -   name: "Main Script"
+            run: |
+                curl -L -O https://tiker.net/ci-support-v0
+                . ./ci-support-v0
+                build_py_project_in_venv
+                sudo apt install libopenmpi-dev
+                pip install numpy attrs orderedsets pytest mpi4py matplotlib
+                pip install basedpyright
+                basedpyright
+
     pytest:
         name: Pytest on Py${{ matrix.python-version }} ${{ matrix.os }}
         runs-on: ${{ matrix.os }}

pyproject.toml

@@ -7,7 +7,7 @@ name = "pytools"
 version = "2025.1.3"
 description = "A collection of tools for Python"
 readme = "README.rst"
-license = { text = "MIT" }
+license = "MIT"
 authors = [
     { name = "Andreas Kloeckner", email = "inform@tiker.net" },
 ]
@@ -17,7 +17,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: Other Audience",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3 :: Only",
@@ -107,6 +106,13 @@ required-imports = ["from __future__ import annotations"]
 extend-ignore-names = ["update_for_*"]
 
 
+[tool.basedpyright]
+reportImplicitStringConcatenation = "none"
+reportUnnecessaryIsInstance = "none"
+reportUnusedCallResult = "none"
+reportExplicitAny = "none"
+
+
 [tool.mypy]
 python_version = "3.10"
 ignore_missing_imports = true

pytools/__init__.py

@@ -45,20 +45,27 @@
 from functools import reduce, wraps
 from sys import intern
 from typing import (
+    TYPE_CHECKING,
     Any,
     ClassVar,
     Concatenate,
     Generic,
     ParamSpec,
     Protocol,
     TypeVar,
+    cast,
 )
 
 from typing_extensions import Self, dataclass_transform
 
 from pytools.version import VERSION_TEXT
 
 
+if TYPE_CHECKING:
+    from _typeshed import ReadableBuffer
+    from typing_extensions import Self
+
+
 __version__ = VERSION_TEXT
 
 
@@ -188,6 +195,8 @@
 Hashing
 -------
 
+.. autoclass:: Hash
+
 .. autofunction:: unordered_hash
 
 Sampling
@@ -233,6 +242,8 @@
 .. class:: P
 
     Generic unbound invariant :class:`typing.ParamSpec`.
+
+.. class:: _HashT
 """
 
 # {{{ type variables
@@ -342,7 +353,7 @@ def module_getattr_for_deprecations(
 
 # {{{ math
 
-def delta(x, y):
+def delta(x: int, y: int) -> int:
     if x == y:
         return 1
     return 0
@@ -1481,10 +1492,10 @@ class _ConcatenableSequence(Generic[T_co], Protocol):
     .. automethod:: __add__
     .. automethod:: __len__
     """
-    def __getitem__(self, slice) -> Self:
+    def __getitem__(self, slice: slice, /) -> Self:
         ...
 
-    def __add__(self, other: Self) -> Self:
+    def __add__(self, value: Self, /) -> Self:
         ...
 
     def __len__(self) -> int:
@@ -2724,9 +2735,41 @@ def resolve_name(name):
 
 # {{{ unordered_hash
 
-def unordered_hash(hash_instance: Any,
-                   iterable: Iterable[Any],
-                   hash_constructor: Callable[[], Any] | None = None) -> Any:
+class Hash(Protocol):
+    """A protocol for the hashes from :mod:`hashlib`.
+
+    .. automethod:: update
+    .. automethod:: digest
+    .. automethod:: hexdigest
+    .. automethod:: copy
+    """
+    def update(self, obj: ReadableBuffer, /) -> None:
+        ...
+
+    def digest(self) -> bytes:
+        ...
+
+    def hexdigest(self) -> str:
+        ...
+
+    def copy(self) -> Self:
+        ...
+
+    @property
+    def digest_size(self) -> int:
+        ...
+
+    @property
+    def name(self) -> str:
+        ...
+
+
+_HashT = TypeVar("_HashT", bound=Hash)
+
+
+def unordered_hash(hash_instance: _HashT,
+                   iterable: Iterable[ReadableBuffer],
+                   hash_constructor: Callable[[], _HashT] | None = None) -> _HashT:
     """Using a hash algorithm given by the parameter-less constructor
     *hash_constructor*, return a hash object whose internal state
     depends on the entries of *iterable*, but not their order. If *hash*
@@ -2750,7 +2793,8 @@ def unordered_hash(hash_instance: Any,
     if hash_constructor is None:
         import hashlib
         from functools import partial
-        hash_constructor = partial(hashlib.new, hash_instance.name)
+        hash_constructor = cast(
+                "Callable[[], _HashT]", partial(hashlib.new, hash_instance.name))
 
     assert hash_constructor is not None
 

pytools/graph.py

@@ -91,7 +91,7 @@
 
 NodeT = TypeVar("NodeT", bound=Hashable)
 
-GraphT: TypeAlias[NodeT] = Mapping[NodeT, Collection[NodeT]]
+GraphT: TypeAlias = Mapping[NodeT, Collection[NodeT]]
 
 
 # {{{ reverse_graph

pytools/persistent_dict.py

@@ -38,20 +38,20 @@
 from collections.abc import Callable, Iterator, Mapping
 from dataclasses import fields as dc_fields, is_dataclass
 from enum import Enum
-from typing import TYPE_CHECKING, Any, Protocol, TypeVar, cast
+from typing import TYPE_CHECKING, Any, TypeVar, cast
 from warnings import warn
 
 from siphash24 import siphash13
 
 
+if TYPE_CHECKING:
+    from pytools import Hash
+
+
 class RecommendedHashNotFoundWarning(UserWarning):
     pass
 
 
-if TYPE_CHECKING:
-    from _typeshed import ReadableBuffer
-    from typing_extensions import Self
-
 try:
     import attrs
 except ModuleNotFoundError:
@@ -85,7 +85,6 @@
 
 .. autoexception:: CollisionWarning
 
-.. autoclass:: Hash
 .. autoclass:: KeyBuilder
 .. autoclass:: PersistentDict
 .. autoclass:: WriteOncePersistentDict
@@ -106,27 +105,6 @@
 
 # {{{ key generation
 
-class Hash(Protocol):
-    """A protocol for the hashes from :mod:`hashlib`.
-
-    .. automethod:: update
-    .. automethod:: digest
-    .. automethod:: hexdigest
-    .. automethod:: copy
-    """
-    def update(self, data: ReadableBuffer) -> None:
-        ...
-
-    def digest(self) -> bytes:
-        ...
-
-    def hexdigest(self) -> str:
-        ...
-
-    def copy(self) -> Self:
-        ...
-
-
 class KeyBuilder:
     """A (stateless) object that computes persistent hashes of objects fed to it.
     Subclassing this class permits customizing the computation of hash keys.
@@ -286,7 +264,7 @@
         import math
         if math.isnan(key):
             # Also applies to np.nan, float("nan")
             warn("Encountered a NaN while hashing. Since NaNs compare unequal "
                  "to themselves, the resulting key can not be retrieved from a "
                  "PersistentDict and will lead to a collision error on retrieval.",
                  stacklevel=1)