chore: update all CI files; add ty; fix ruff/mypy errors

Author: karlicoss

.ci/release-uv

@@ -26,6 +26,7 @@ from subprocess import check_call
 
 is_ci = os.environ.get('CI') is not None
 
+
 def main() -> None:
     p = argparse.ArgumentParser()
     p.add_argument('--use-test-pypi', action='store_true')
@@ -34,19 +35,14 @@ def main() -> None:
     publish_url = ['--publish-url', 'https://test.pypi.org/legacy/'] if args.use_test_pypi else []
 
     root = Path(__file__).absolute().parent.parent
-    os.chdir(root) # just in case
-
-    if is_ci:
-        # see https://github.com/actions/checkout/issues/217
-        check_call('git fetch --prune --unshallow'.split())
+    os.chdir(root)  # just in case
 
     # TODO ok, for now uv won't remove dist dir if it already exists
     #  https://github.com/astral-sh/uv/issues/10293
     dist = root / 'dist'
     if dist.exists():
         shutil.rmtree(dist)
 
-    # todo what is --force-pep517?
     check_call(['uv', 'build'])
 
     if not is_ci:

.github/workflows/main.yml

@@ -6,24 +6,30 @@ on:
     branches: '*'
     tags: 'v[0-9]+.*' # only trigger on 'release' tags for PyPi
     # Ideally I would put this in the pypi job... but github syntax doesn't allow for regexes there :shrug:
-  pull_request: # needed to trigger on others' PRs
+
+  # Needed to trigger on others' PRs.
   # Note that people who fork it need to go to "Actions" tab on their fork and click "I understand my workflows, go ahead and enable them".
-  workflow_dispatch: # needed to trigger workflows manually
-    # todo cron?
+  pull_request:
+
+  # Needed to trigger workflows manually.
+  workflow_dispatch:
     inputs:
       debug_enabled:
         type: boolean
         description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
         required: false
         default: false
 
+  schedule:
+    - cron: '31 18 * * 5'  # run every Friday
+
 
 jobs:
   build:
     strategy:
       fail-fast: false
       matrix:
-        platform: [ubuntu-latest, macos-latest]  # todo windows-latest]
+        platform: [ubuntu-latest, macos-latest]  # windows-latest
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
         # vvv just an example of excluding stuff from matrix
         # exclude: [{platform: macos-latest, python-version: '3.6'}]
@@ -55,44 +61,57 @@ jobs:
 
     # explicit bash command is necessary for Windows CI runner, otherwise it thinks it's cmd...
     - run: bash .ci/run
+      env:
+        # only compute lxml coverage on ubuntu; it crashes on windows
+        CI_MYPY_COVERAGE: ${{ matrix.platform == 'ubuntu-latest' && '--cobertura-xml-report .coverage.mypy' || '' }}
 
     - if: matrix.platform == 'ubuntu-latest'  # no need to compute coverage for other platforms
-      uses: actions/upload-artifact@v4
+      uses: codecov/codecov-action@v5
       with:
-        include-hidden-files: true
-        name: .coverage.mypy_${{ matrix.platform }}_${{ matrix.python-version }}
-        path: .coverage.mypy/
+        fail_ci_if_error: true  # default false
+        token: ${{ secrets.CODECOV_TOKEN }}
+        flags: mypy-${{ matrix.python-version }}
+        files: .coverage.mypy/cobertura.xml
 
 
   pypi:
-    runs-on: ubuntu-latest
+    # Do not run it for PRs/cron schedule etc.
+    # NOTE: release tags are guarded by on: push: tags on the top.
+    if: github.event_name == 'push' && (startsWith(github.event.ref, 'refs/tags/') || (github.event.ref == format('refs/heads/{0}', github.event.repository.master_branch)))
+    # Ugh, I tried using matrix or something to explicitly generate only test pypi or prod pypi pipelines.
+    # But github actions is so shit, it's impossible to do any logic at all, e.g. doesn't support conditional matrix, if/else statements for variables etc.
+
     needs: [build] # add all other jobs here
+
+    runs-on: ubuntu-latest
+
     permissions:
       # necessary for Trusted Publishing
       id-token: write
+
     steps:
     # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
     - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
 
     - uses: actions/checkout@v4
       with:
         submodules: recursive
+        fetch-depth: 0  # pull all commits to correctly infer vcs version
 
     - uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.12'
 
     - uses: astral-sh/setup-uv@v5
       with:
         enable-cache: false  # we don't have lock files, so can't use them as cache key
 
     - name: 'release to test pypi'
       # always deploy merged master to test pypi
-      if: github.event_name != 'pull_request' && github.event.ref == 'refs/heads/master'
+      if: github.event.ref == format('refs/heads/{0}', github.event.repository.master_branch)
       run: .ci/release-uv --use-test-pypi
 
-    - name: 'release to pypi'
+    - name: 'release to prod pypi'
       # always deploy tags to release pypi
-      # NOTE: release tags are guarded by on: push: tags on the top
-      if: github.event_name != 'pull_request' && startsWith(github.event.ref, 'refs/tags')
+      if: startsWith(github.event.ref, 'refs/tags/')
       run: .ci/release-uv

README.ipynb

@@ -23,14 +23,15 @@
     "import sys\n",
     "from pathlib import Path\n",
     "\n",
-    "from IPython.display import Markdown as md\n",
+    "from IPython.display import Markdown as md  # ty: ignore[unresolved-import]\n",
     "\n",
     "##\n",
     "sys.path.insert(0, str(Path('src').absolute()))\n",
     "import cachew  # isort: skip\n",
     "import cachew.extra  # isort: skip\n",
     "import cachew.marshall.cachew  # isort: skip\n",
     "import cachew.tests.test_cachew as tests  # isort: skip\n",
+    "\n",
     "sys.modules['tests'] = tests  # meh\n",
     "##\n",
     "\n",
@@ -62,7 +63,7 @@
     "    return f'[{title}]({file}{numbers})'\n",
     "\n",
     "\n",
-    "dmd = lambda x: display(md(x.strip()))"
+    "dmd = lambda x: display(md(x.strip()))  # ty: ignore[unresolved-reference]"
    ]
   },
   {
@@ -148,6 +149,7 @@
    "outputs": [],
    "source": [
     "doc = inspect.getdoc(cachew.cachew)\n",
+    "assert doc is not None\n",
     "doc = doc.split('Usage example:')[-1].lstrip()\n",
     "dmd(f\"\"\"```python\n",
     "{doc}\n",
@@ -229,7 +231,7 @@
     "[composite] = [x\n",
     " for x in ast.walk(ast.parse(inspect.getsource(cachew)))\n",
     " if isinstance(x, ast.FunctionDef) and x.name == 'composite_hash'\n",
-    "]\n",
+    "]  # fmt: skip\n",
     "\n",
     "link = f'{Path(cachew.__file__).relative_to(_CWD)}:#L{composite.lineno}'\n",
     "\n",

README.md

@@ -128,7 +128,7 @@ Cachew gives the best of two worlds and makes it both **easy and efficient**. Th
 - first your objects get [converted](src/cachew/marshall/cachew.py#L30) into a simpler JSON-like representation
 - after that, they are mapped into byte blobs via [`orjson`](https://github.com/ijl/orjson).
 
-When the function is called, cachew [computes the hash of your function's arguments ](src/cachew/__init__.py:#L587)
+When the function is called, cachew [computes the hash of your function's arguments ](src/cachew/__init__.py:#L590)
 and compares it against the previously stored hash value.
 
 - If they match, it would deserialize and yield whatever is stored in the cache database
@@ -140,18 +140,18 @@ and compares it against the previously stored hash value.
 
 
 
-* automatic schema inference: [1](src/cachew/tests/test_cachew.py#L387), [2](src/cachew/tests/test_cachew.py#L401)
+* automatic schema inference: [1](src/cachew/tests/test_cachew.py#L385), [2](src/cachew/tests/test_cachew.py#L399)
 * supported types:
 
     * primitive: `str`, `int`, `float`, `bool`, `datetime`, `date`, `Exception`
 
-      See [tests.test_types](src/cachew/tests/test_cachew.py#L687), [tests.test_primitive](src/cachew/tests/test_cachew.py#L725), [tests.test_dates](src/cachew/tests/test_cachew.py#L637), [tests.test_exceptions](src/cachew/tests/test_cachew.py#L1124)
-    * [@dataclass and NamedTuple](src/cachew/tests/test_cachew.py#L602)
-    * [Optional](src/cachew/tests/test_cachew.py#L531) types
-    * [Union](src/cachew/tests/test_cachew.py#L832) types
-    * [nested datatypes](src/cachew/tests/test_cachew.py#L447)
+      See [tests.test_types](src/cachew/tests/test_cachew.py#L685), [tests.test_primitive](src/cachew/tests/test_cachew.py#L723), [tests.test_dates](src/cachew/tests/test_cachew.py#L635), [tests.test_exceptions](src/cachew/tests/test_cachew.py#L1122)
+    * [@dataclass and NamedTuple](src/cachew/tests/test_cachew.py#L600)
+    * [Optional](src/cachew/tests/test_cachew.py#L529) types
+    * [Union](src/cachew/tests/test_cachew.py#L830) types
+    * [nested datatypes](src/cachew/tests/test_cachew.py#L445)
 
-* detects [datatype schema changes](src/cachew/tests/test_cachew.py#L477) and discards old data automatically
+* detects [datatype schema changes](src/cachew/tests/test_cachew.py#L475) and discards old data automatically
 
 
 # Performance
@@ -170,7 +170,7 @@ You can also use [extensive unit tests](src/cachew/tests/test_cachew.py) as a re
 
 Some useful (but optional) arguments of `@cachew` decorator:
 
-* `cache_path` can be a directory, or a callable that [returns a path](src/cachew/tests/test_cachew.py#L424) and depends on function's arguments.
+* `cache_path` can be a directory, or a callable that [returns a path](src/cachew/tests/test_cachew.py#L422) and depends on function's arguments.
 
    By default, `settings.DEFAULT_CACHEW_DIR` is used.
 

conftest.py

@@ -34,7 +34,10 @@ def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
     raise RuntimeError("Couldn't determine path for ", path)
 
 
-_pytest.pathlib.resolve_package_path = resolve_package_path
+# NOTE: seems like it's not necessary anymore?
+# keeping it for now just in case
+# after https://github.com/pytest-dev/pytest/pull/13426 we should be able to remove the whole conftest
+# _pytest.pathlib.resolve_package_path = resolve_package_path
 
 
 # without patching, the orig function returns just a package name for some reason
@@ -52,4 +55,4 @@ def search_pypath(module_name: str) -> str:
     return str(mpath)
 
 
-_pytest.main.search_pypath = search_pypath
+_pytest.main.search_pypath = search_pypath  # ty: ignore[invalid-assignment]

misc/test_redis/test.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 from time import time
 
-import redis
-from loguru import logger
+import redis  # ty: ignore[unresolved-import]
+from loguru import logger  # ty: ignore[unresolved-import]
 from more_itertools import ilen
 
 r = redis.Redis(host='localhost', port=6379, db=0)

pyproject.toml

@@ -34,6 +34,9 @@ optional = [
     "colorlog",
 ]
 [dependency-groups]
+# TODO: not sure, on the one hand could just use 'standard' dev dependency group
+# On the other hand, it's a bit annoying that it's always included by default? 
+# To make sure it's not included, need to use `uv run --exact --no-default-groups ...`
 testing = [
     "pytz", "types-pytz",  # optional runtime only dependency
 
@@ -47,16 +50,11 @@ testing = [
 
     "ruff",
     "mypy",
-    "lxml",  # for mypy html coverage
+    "lxml", # for mypy html coverage
+    "ty>=0.0.1a16",
 ]
 
 
-# workaround for error during uv publishing
-# see https://github.com/astral-sh/uv/issues/9513#issuecomment-2519527822
-[tool.setuptools]
-license-files = []
-
-
 [build-system]
 requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"

ruff.toml

@@ -29,7 +29,6 @@ lint.extend-select = [
     "ARG",  # unused argument checks
     "A",    # builtin shadowing
     "G",    # logging stuff
-    # "EM",  # TODO hmm could be helpful to prevent duplicate err msg in traceback.. but kinda annoying
 
     # "ALL", # uncomment this to check for new rules!
 ]
@@ -48,6 +47,7 @@ lint.ignore = [
     "FIX",   # complains about fixmes/todos -- annoying
     "TD",    # complains about todo formatting -- too annoying
     "ANN",   # missing type annotations? seems way to strict though
+    "EM" ,   # suggests assigning all exception messages into a variable first... pretty annoying
 
 ### too opinionated style checks
     "E501",  # too long lines
@@ -137,4 +137,10 @@ lint.ignore = [
     "SIM",     # some if statements crap
     "RSE102",  # complains about missing parens in exceptions
     ##
+
+    "PLC0415", # "imports should be at the top level" -- not realistic
+]
+
+
+extend-exclude = [
 ]

src/cachew/__init__.py

@@ -38,7 +38,7 @@ def orjson_dumps(*args, **kwargs):  # type: ignore[misc]
         # sqlite needs a blob
         return json.dumps(*args, **kwargs).encode('utf8')
 
-    orjson_loads = json.loads
+    orjson_loads = json.loads  # ty: ignore[invalid-assignment]
 
 import platformdirs
 
@@ -291,7 +291,7 @@ def cachew_error(e: Exception, *, logger: logging.Logger) -> None:
 # using cachew_impl here just to use different signatures during type checking (see below)
 @doublewrap
 def cachew_impl(
-    func=None,
+    func=None,  # TODO should probably type it after switch to python 3.10/proper paramspec
     cache_path: Optional[PathProvider[P]] = use_default_path,
     *,
     force_file: bool = False,
@@ -364,6 +364,7 @@ def process(self, msg, kwargs):
             func_name = extra['func_name']
             return f'[{func_name}] {msg}', kwargs
 
+    assert func is not None
     func_name = callable_name(func)
     adapter = AddFuncName(logger, {'func_name': func_name})
     logger = cast(logging.Logger, adapter)
@@ -428,7 +429,8 @@ def _func(*args, **kwargs):
     else:
         _func = func
 
-    # fmt: off
+    assert use_cls is not None
+
     ctx = Context(
         func         =_func,
         cache_path   =cache_path,
@@ -439,14 +441,13 @@ def _func(*args, **kwargs):
         chunk_by     =chunk_by,
         synthetic_key=synthetic_key,
         backend      =backend,
-    )
-    # fmt: on
+    )  # fmt: skip
 
     # hack to avoid extra stack frame (see test_recursive*)
     @functools.wraps(func)
     def binder(*args, **kwargs):
         kwargs['_cachew_context'] = ctx
-        res = cachew_wrapper(*args, **kwargs)
+        res = cachew_wrapper(*args, **kwargs)  # ty: ignore[missing-argument]
 
         if use_kind == 'single':
             lres = list(res)
@@ -460,7 +461,7 @@ def binder(*args, **kwargs):
 if TYPE_CHECKING:
     # we need two versions due to @doublewrap
     # this is when we just annotate as @cachew without any args
-    @overload  # type: ignore[no-overload-impl]
+    @overload
     def cachew(fun: F) -> F: ...
 
     # NOTE: we won't really be able to make sure the args of cache_path are the same as args of the wrapped function
@@ -479,14 +480,16 @@ def cachew(
         backend: Optional[Backend] = ...,
     ) -> Callable[[F], F]: ...
 
+    def cachew(*args, **kwargs):  # make ty happy
+        raise NotImplementedError
 else:
     cachew = cachew_impl
 
 
 def callable_name(func: Callable) -> str:
     # some functions don't have __module__
     mod = getattr(func, '__module__', None) or ''
-    return f'{mod}:{func.__qualname__}'
+    return f'{mod}:{getattr(func, "__qualname__")}'
 
 
 def callable_module_name(func: Callable) -> Optional[str]:
@@ -572,7 +575,7 @@ def _module_is_disabled(module_name: str, logger: logging.Logger) -> bool:
 
 
 @dataclass
-class Context(Generic[P]):
+class Context(Generic[P]):  # ty: ignore[invalid-argument-type]
     # fmt: off
     func         : Callable
     cache_path   : PathProvider[P]