Add mypy to tox

.github/workflows/lint.yml

@@ -20,3 +20,18 @@ jobs:
         with:
           python-version: "3.x"
       - uses: tox-dev/action-pre-commit-uv@v1
+
+  mypy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Mypy
+        run: uvx --with tox-uv tox -e mypy

pyproject.toml

@@ -117,3 +117,8 @@ filterwarnings = [
   "ignore:sys.monitoring isn't available, using default core:coverage.exceptions.CoverageWarning",
 ]
 testpaths = [ "tests" ]
+
+[tool.mypy]
+pretty = true
+#strict = true
+show_error_codes = true

requirements-mypy.txt

@@ -0,0 +1,10 @@
+freezegun
+mypy==1.14.1
+platformdirs
+prettytable
+pytablewriter
+pytest
+respx
+termcolor
+types-python-dateutil
+types-python-slugify

src/pypistats/__init__.py

@@ -11,6 +11,7 @@
 import sys
 import warnings
 from pathlib import Path
+from typing import Any
 
 from platformdirs import user_cache_dir
 from slugify import slugify
@@ -25,13 +26,13 @@
 USER_AGENT = f"pypistats/{__version__}"
 
 
-def _print_verbose(verbose: bool, *args, **kwargs) -> None:
+def _print_verbose(verbose: bool, *args, **kwargs: Any) -> None:
     """Print if verbose"""
     if verbose:
         _print_stderr(*args, **kwargs)
 
 
-def _print_stderr(*args, **kwargs) -> None:
+def _print_stderr(*args, **kwargs: Any) -> None:
     """Print to stderr"""
     print(*args, file=sys.stderr, **kwargs)
 
@@ -483,38 +484,38 @@ def _paramify(param_name: str, param_value: float | str | None) -> str:
     return ""
 
 
-def recent(package: str, period: str | None = None, **kwargs: str):
+def recent(package: str, period: str | None = None, **kwargs: Any):
     """Retrieve the aggregate download quantities for the last day/week/month"""
     endpoint = f"packages/{package}/recent"
     params = _paramify("period", period)
     return pypi_stats_api(endpoint, params, **kwargs)
 
 
-def overall(package: str, mirrors: bool | str | None = None, **kwargs: str):
+def overall(package: str, mirrors: bool | str | None = None, **kwargs: Any):
     """Retrieve the aggregate daily download time series with or without mirror
     downloads"""
     endpoint = f"packages/{package}/overall"
     params = _paramify("mirrors", mirrors)
     return pypi_stats_api(endpoint, params, **kwargs)
 
 
-def python_major(package: str, version: str | None = None, **kwargs: str):
+def python_major(package: str, version: str | None = None, **kwargs: Any):
     """Retrieve the aggregate daily download time series by Python major version
     number"""
     endpoint = f"packages/{package}/python_major"
     params = _paramify("version", version)
     return pypi_stats_api(endpoint, params, **kwargs)
 
 
-def python_minor(package: str, version: str | None = None, **kwargs) -> str:
+def python_minor(package: str, version: str | None = None, **kwargs: Any) -> str:
     """Retrieve the aggregate daily download time series by Python minor version
     number"""
     endpoint = f"packages/{package}/python_minor"
     params = _paramify("version", version)
     return pypi_stats_api(endpoint, params, **kwargs)
 
 
-def system(package: str, os: str | None = None, **kwargs):
+def system(package: str, os: str | None = None, **kwargs: Any):
     """Retrieve the aggregate daily download time series by operating system"""
     endpoint = f"packages/{package}/system"
     params = _paramify("os", os)

src/pypistats/cli.py

@@ -51,7 +51,7 @@ def subcommand(args):
     if args is None:
         args = []
 
-    def decorator(func):
+    def decorator(func) -> None:
         func2 = getattr(pypistats, func.__name__)
         parser = parent.add_parser(
             func.__name__,

tests/test_pypistats_cache.py

@@ -61,7 +61,7 @@ def test__load_cache_bad_data(self) -> None:
     def test_cache_round_trip(self) -> None:
         # Arrange
         filename = pypistats.CACHE_DIR / "test_cache_round_trip.json"
-        data = "test data"
+        data = {"test": "data"}
 
         # Act
         pypistats._save_cache(filename, data)

tox.ini

@@ -4,6 +4,7 @@ requires =
 env_list =
     cog
     lint
+    mypy
     pins
     py{py3, 314, 313, 312, 311, 310, 39}
 
@@ -44,6 +45,12 @@ pass_env =
 commands =
     pre-commit run --all-files --show-diff-on-failure
 
+[testenv:mypy]
+deps =
+    -r requirements-mypy.txt
+commands =
+    mypy . {posargs}
+
 [testenv:pins]
 deps =
     -r requirements.txt