typing fixes; updated readme

.github/workflows/development.yml

@@ -20,7 +20,7 @@ jobs:
       - run: poetry install
       - run: echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
 
-      - uses: jakebailey/pyright-action@v2
+      - run: poetry run pyright src
       - run: poetry run coverage run -m pytest
       - run: poetry run coverage report
 

README.md

@@ -10,31 +10,36 @@ Kantholtz' personal Python toolbox. Check out the [documentation here](https://k
 
 ## Installation
 
-Python 3.9 is required.
+Python 3.11 is required.
 
-``` console
-$ conda create -n ktz python=3.9
-$ conda activate ktz
-$ pip install ktz
+```console
+pip install ktz
 ```
 
+
 For a local installation with all dev dependencies:
 
 ``` console
 $ git clone https://github.com/kantholtz/ktz.git
 $ cd ktz
-$ conda create -n ktz python=3.9
+$ conda create -n ktz python=3.11
 $ conda activate ktz
-$ pip install .[dev]
+$ poetry install --with dev
 
 # run tests
-$ pytest
+$ poetry run pytest
 
 # to continually run tests
-$ ptw -c
+$ poetry run ptw -c
+
+# static typing
+$ poetry run pyright src
 
 # to check code coverage
-$ coverage run -m pytest
-$ coverage report
-$ coverage html
+$ poetry run coverage run -m pytest
+$ poetry run coverage report
+$ poetry run coverage html
+
+# build package
+$ poetry build
 ```

pyproject.toml

@@ -21,6 +21,7 @@ pytest = "^8.2.1"
 pytest-cov = "^5.0.0"
 pytest-watch = "^4.2.0"
 pytest-pudb = "^0.7.0"
+pyright = "^1.1.365"
 
 [build-system]
 requires = ["poetry-core"]

src/ktz/collections.py

@@ -42,6 +42,7 @@ def buckets(
 def buckets(
     col: Collection[A],
     key: Callable[[Index, A], tuple[C, D]],
+    mapper: None = ...,
 ) -> dict[C, D]:
     ...
 
@@ -50,8 +51,8 @@ def buckets(
 @overload
 def buckets(
     col: Collection[tuple[A, B]],
-    key: None,
-    mapper: Callable[[tuple[C, ...]], D],
+    key: None = ...,
+    mapper: Callable[[tuple[C, ...]], D] = ...,
 ) -> dict[A, D]:
     ...
 
@@ -510,7 +511,7 @@ def _dconv(dic: dict, fns):
     return res
 
 
-def dconv(dic: dict, *convert: Callable[[A, B], C]):
+def dconv(dic: dict, *convert: Callable[[A], C] | Callable[[A, B], C]):
     """
     Convert a dictionary deeply.
 

src/tests/test_collections.py

@@ -2,6 +2,7 @@
 
 import tempfile
 from contextlib import ExitStack
+from typing import Any, Callable, Iterable
 
 import pytest
 import yaml
@@ -51,11 +52,17 @@ def test_buckets_index(self):
     def test_buckets_mapper(self):
         ref = {1: 9, 5: 13}
         ret = buckets(
-            ((1, 2), (1, 3), (1, 4), (5, 6), (5, 7)),
+            col=((1, 2), (1, 3), (1, 4), (5, 6), (5, 7)),
             mapper=sum,
         )
         assert ref == ret
 
+    def f(self, y: Callable[[Iterable[Any]], int], *args) -> int:
+        return y(*args)
+
+    def g(self):
+        return self.f(sum, 1, 2, 3)
+
     #
     #  with key and with mapper
     #
@@ -382,7 +389,7 @@ def plus1(v):
         assert d2 == dict(a=2, b=3, c=[])
 
     def test_key(self):
-        def fn(v, k):
+        def fn(_, k):
             if k == "foo":
                 return True
             return False
@@ -428,8 +435,10 @@ def test_multi(self):
             yaml.dump(d2, fd2)
 
             ret = ryaml(fd1.name, fd2.name)
+            assert ret == dict(foo=3, bar=2, xyz=4)
+            return
 
-        assert ret == dict(foo=3, bar=2, xyz=4)
+        assert False
 
     def test_multi_deep(self):
         d1 = dict(foo=dict(a=1, b=2), bar=2)
@@ -443,8 +452,10 @@ def test_multi_deep(self):
             yaml.dump(d2, fd2)
 
             ret = ryaml(fd1.name, fd2.name)
+            assert ret == dict(foo=dict(a=3, b=2, c=4), bar=2, xyz=5)
+            return
 
-        assert ret == dict(foo=dict(a=3, b=2, c=4), bar=2, xyz=5)
+        assert False
 
     def test_overwrites(self):
         d1 = dict(foo=1, bar=2)
@@ -458,8 +469,10 @@ def test_overwrites(self):
             yaml.dump(d2, fd2)
 
             ret = ryaml(fd1.name, fd2.name, xyz=5)
+            assert ret == dict(foo=3, bar=2, xyz=5)
+            return
 
-        assert ret == dict(foo=3, bar=2, xyz=5)
+        assert False
 
     def test_overwrites_deep(self):
         d1 = dict(foo=1, bar=2)
@@ -473,5 +486,6 @@ def test_overwrites_deep(self):
             yaml.dump(d2, fd2)
 
             ret = ryaml(fd1.name, fd2.name, xyz=dict(a=3, c=3))
+            assert ret == dict(foo=3, bar=2, xyz=dict(a=3, b=2, c=3))
 
-        assert ret == dict(foo=3, bar=2, xyz=dict(a=3, b=2, c=3))
+        assert False

src/tests/test_functools.py

@@ -4,7 +4,6 @@
 from pathlib import Path
 
 import pytest
-
 from ktz import functools as ft
 
 
@@ -26,7 +25,7 @@ def test_single_function(self, cachedir):
         outside = 1
 
         @run.cache("x")
-        def foo():
+        def foo():  # type: ignore
             return outside
 
         # from function execution
@@ -185,7 +184,7 @@ def test_get(self, cachedir):
         run = ft.Cascade(prefix=cachedir, x="x")
 
         @run.cache("x")
-        def f():
+        def f():  # type: ignore
             return outside
 
         # from computed value
@@ -201,7 +200,7 @@ def f(x):
             return outside  # pragma: no cover
 
         # from cache
-        assert f() == 1
+        assert f() == 1  # type: ignore
         assert run.get("x") == 1
 
     def test_get_raises(self, cachedir):