Adds type hints. Modernizes tooling.

Author: Daverball

.github/workflows/python-pr.yaml

@@ -13,16 +13,17 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
 
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox tox-gh-actions
+        run: uv pip install tox tox-gh-actions tox-uv --system
 
       - name: Test with tox without uploading coverage
         run: tox

.github/workflows/python-tox.yaml

@@ -27,16 +27,17 @@ jobs:
           echo "CODECOV_BRANCH=$(echo ${GITHUB_HEAD_REF} | tr / -)" \
                >> $GITHUB_ENV
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
 
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox tox-gh-actions
+        run: uv pip install tox tox-gh-actions tox-uv --system
 
       - name: Test with tox and upload coverage results
         run: tox -- --codecov --codecov-token=${{ secrets.CODECOV_TOKEN }} --junit-xml=junit.xml -o junit_family=legacy

.gitignore

@@ -9,6 +9,8 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+venv/
+.venv/
 build/
 develop-eggs/
 dist/

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: '^(.bumpversion.cfg)$'
+      - id: mixed-line-ending
+      - id: check-merge-conflict
+      - id: check-ast
+      - id: debug-statements
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
+    rev: v1.0.1
+    hooks:
+      - id: rst-linter
+        files: '^[A-Z]+\.rst$'
+  - repo: https://github.com/seantis/pre-commit-hooks
+    rev: v1.1.0
+    hooks:
+      - id: nocheckin
+        exclude: .pre-commit-config.yaml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.13
+    hooks:
+      - id: ruff
+        args: [ "--fix" ]
+        files: '^(src|tests)/.*\.py$'
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.16.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - GitPython
+          - pytest
+          - pytest-cov
+          - types-requests
+        exclude: '.*'
+        always_run: true
+        pass_filenames: false
+        args: ["-p", "pytest_codecov", "-p", "tests"]
+

pyproject.toml

@@ -16,7 +16,7 @@ authors = [
 maintainers = [
     { name = "David Salvisberg", email = "[email protected]" },
 ]
-license = {file = "LICENSE"}
+license = { file = "LICENSE" }
 classifiers = [
     "Framework :: Pytest",
     "Development Status :: 4 - Beta",
@@ -53,6 +53,9 @@ Repository = "https://github.com/seantis/pytest-codecov"
 [project.entry-points.pytest11]
 codecov = "pytest_codecov"
 
+[tool.setuptools.package-data]
+pytest_codecov = ["py.typed"]
+
 [tool.setuptools.dynamic]
 version = {attr = "pytest_codecov.__version__"}
 
@@ -66,17 +69,135 @@ source = ["pytest_codecov"]
 show_missing = true
 precision = 2
 
+[tool.mypy]
+python_version = "3.8"
+follow_imports = "silent"
+namespace_packages = true
+explicit_package_bases = true
+strict = true
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
+
+[tool.ruff]
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+src = ["src", "test"]
+include = [
+    "pyproject.toml",
+    "src/**/*.py",
+    "tests/**/*.py",
+]
+line-length = 79
+indent-width = 4
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+    "A005",
+    "ASYNC",
+    "B0",
+    "B904",
+    "B909",
+    "C4",
+    "COM818",
+    "E",
+    "F",
+    "FLY002",
+    "FURB",
+    "G010",
+    "G2",
+    "I002",
+    "ISC",
+    "LOG",
+    "N",
+    "PERF",
+    "PGH004",
+    "PGH005",
+    "PIE",
+    "PT",
+    "PYI",
+    "Q",
+    "RUF",
+    "S",
+    "SIM",
+    "SLOT",
+    "T",
+    "UP",
+    "W",
+]
+ignore = [
+    "FURB101",
+    "FURB103",
+]
+unfixable = []
+preview = true
+
+[tool.ruff.lint.extend-per-file-ignores]
+"src/**/*.py" = ["PT"]
+"tests/**/*.py" = [
+  "S",
+]
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]
+
+[tool.ruff.lint.pep8-naming]
+extend-ignore-names = []
+classmethod-decorators = []
+
+[tool.ruff.lint.flake8-quotes]
+avoid-escape = true
+docstring-quotes = "double"
+inline-quotes = "single"
+multiline-quotes = "double"
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "lf"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
 [tool.tox]
 legacy_tox_ini = """
     [tox]
-    envlist = py38,py39,py310,py311,py312,py313,flake8,report
+    envlist = py38,py39,py310,py311,py312,py313,mypy,ruff,report
 
     [gh-actions]
     python =
-        3.8: py38,flake8
+        3.8: py38
         3.9: py39
         3.10: py310
-        3.11: py311
+        3.11: py311,ruff,mypy
         3.12: py312
         3.13: py313
 
@@ -94,14 +215,27 @@ legacy_tox_ini = """
         .
         GitPython
 
-    [testenv:flake8]
+    [testenv:mypy]
+    basepython = python3.11
+    deps =
+        -e{toxinidir}[git]
+        mypy
+        types-requests
+    commands =
+        mypy -p pytest_codecov -p tests --python-version 3.9
+        mypy -p pytest_codecov -p tests --python-version 3.10
+        mypy -p pytest_codecov -p tests --python-version 3.11
+        mypy -p pytest_codecov -p tests --python-version 3.12
+        mypy -p pytest_codecov -p tests --python-version 3.13
+
+    [testenv:ruff]
     skip_install = true
-    deps = flake8
-    commands = flake8 src setup.py tests
+    deps = ruff
+    commands = ruff check
 
     [testenv:report]
-    deps = coverage
     skip_install = true
+    deps = coverage
     commands =
         coverage combine
         coverage report

src/pytest_codecov/__init__.py

@@ -1,11 +1,18 @@
+from __future__ import annotations
+
 import argparse
 import os
 import pytest
 import re
+from typing import TYPE_CHECKING
 
 import pytest_codecov.git as git
 import pytest_codecov.codecov as codecov
 
+if TYPE_CHECKING:
+    from coverage import Coverage
+    from pytest_cov.plugin import CovPlugin  # type: ignore[import-untyped]
+
 
 __version__ = '0.7.0'
 token_regex = re.compile(
@@ -16,21 +23,24 @@
 )
 
 
-def validate_token(arg):
+def validate_token(arg: str) -> str:
     if not token_regex.match(arg):
         msg = 'Invalid Codecov.io repository token supplied.'
         raise argparse.ArgumentTypeError(msg)
     return arg
 
 
-def validate_slug(arg):
+def validate_slug(arg: str) -> str:
     if not slug_regex.match(arg):
         msg = 'Invalid repository slug supplied.'
         raise argparse.ArgumentTypeError(msg)
     return arg
 
 
-def pytest_addoption(parser, pluginmanager):
+def pytest_addoption(
+    parser: pytest.Parser,
+    pluginmanager: pytest.PytestPluginManager
+) -> None:
     group = parser.getgroup('codecov')
     group.addoption(
         '--codecov',
@@ -83,20 +93,25 @@ def pytest_addoption(parser, pluginmanager):
         action='store_false',
         dest='codecov_upload_on_failure',
         default=True,
-        help='Don\'t upload coverage results on test failure'
+        help="Don't upload coverage results on test failure"
     )
     group.addoption(
         '--codecov-exclude-junit-xml',
         action='store_false',
         dest='codecov_junit_xml',
         default=True,
-        help='Don\'t upload the junit xml file'
+        help="Don't upload the junit xml file"
     )
 
 
 class CodecovPlugin:
 
-    def upload_report(self, terminalreporter, config, cov):
+    def upload_report(
+        self,
+        terminalreporter: pytest.TerminalReporter,
+        config: pytest.Config,
+        cov: Coverage
+    ) -> None:
         option = config.option
         uploader = codecov.CodecovUploader(
             option.codecov_slug,
@@ -105,7 +120,7 @@ def upload_report(self, terminalreporter, config, cov):
             token=option.codecov_token,
         )
         uploader.add_network_files(git.ls_files())
-        from coverage.misc import CoverageException
+        from coverage.exceptions import CoverageException
         try:
             uploader.add_coverage_report(cov)
         except CoverageException as exc:
@@ -188,12 +203,20 @@ def upload_report(self, terminalreporter, config, cov):
             terminalreporter.write_line(f'ERROR: {error}', red=True, bold=True)
 
     @pytest.hookimpl(trylast=True)
-    def pytest_terminal_summary(self, terminalreporter, exitstatus, config):
-        cov_plugin = config.pluginmanager.get_plugin('_cov')
+    def pytest_terminal_summary(
+        self,
+        terminalreporter: pytest.TerminalReporter,
+        exitstatus: int,
+        config: pytest.Config
+    ) -> None:
+        cov_plugin: CovPlugin | None = config.pluginmanager.get_plugin('_cov')
+        if cov_plugin is None:
+            return
+
         if cov_plugin.cov_controller is None:
             return
 
-        cov = cov_plugin.cov_controller.cov
+        cov: Coverage | None = cov_plugin.cov_controller.cov
         if cov is None:
             return
 
@@ -203,7 +226,7 @@ def pytest_terminal_summary(self, terminalreporter, exitstatus, config):
         self.upload_report(terminalreporter, config, cov)
 
 
-def pytest_configure(config):  # pragma: no cover
+def pytest_configure(config: pytest.Config) -> None:  # pragma: no cover
     # NOTE: Don't report codecov results on worker nodes
     if hasattr(config, 'workerinput'):
         return