chore: Template upgrade

pawamoy · pawamoy · commit 6d600238c631 · 2025-10-09T17:50:57.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier.
-_commit: 1.4.5
+_commit: 1.5.1
 _src_path: gh:mkdocstrings/handler-template
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,15 @@
+### For reviewers
+<!-- Help reviewers by letting them know whether AI was used to create this PR. -->
+
+- [ ] I did not use AI
+- [ ] I used AI and thoroughly reviewed every code/docs change
+
+### Description of the change
+<!-- Quick sentence for small changes, longer description for more impacting changes. -->
+
+### Relevant resources
+<!-- Link to any relevant GitHub issue, PR or discussion, section in online docs, etc. -->
+
+-
+-
+-
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,10 +2,17 @@ name: ci
 
 on:
   push:
+    branches:
+    - main
+    - test-me-*
   pull_request:
     branches:
     - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
 defaults:
   run:
     shell: bash
@@ -14,13 +21,30 @@ env:
   LANG: en_US.utf-8
   LC_ALL: en_US.utf-8
   PYTHONIOENCODING: UTF-8
+  PYTHONWARNDEFAULTENCODING: "1"
   PYTHON_VERSIONS: ""
 
 jobs:
 
   quality:
+    strategy:
+      matrix:
+        os:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+        python-version:
+        - "3.9"
+        - "3.13"
+        include:
+        - os: ubuntu-latest
+          python-version: "3.10"
+        - os: ubuntu-latest
+          python-version: "3.11"
+        - os: ubuntu-latest
+          python-version: "3.12"
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout
@@ -32,7 +56,7 @@ jobs:
     - name: Setup Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.13"
+        python-version: ${{ matrix.python-version }}
 
     - name: Setup uv
       uses: astral-sh/setup-uv@v5
@@ -109,7 +133,7 @@ jobs:
         - lowest-direct
         exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.python-version == '3.14' }}
+    continue-on-error: true
 
     steps:
     - name: Checkout
diff --git a/Makefile b/Makefile
@@ -2,6 +2,13 @@
 # the `make` command will point at the `scripts/make` shell script.
 # This Makefile is just here to allow auto-completion in the terminal.
 
+default: help
+	@echo
+	@echo 'Enable direnv in your shell to use the `make` command: `direnv allow`'
+	@echo 'Or use `python scripts/make ARGS` to run the commands/tasks directly.'
+
+.DEFAULT_GOAL: default
+
 actions = \
 	allrun \
 	changelog \
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)
-[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)
+[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#mkdocstrings_python:gitter.im)
 
 ---
 
diff --git a/config/pytest.ini b/config/pytest.ini
@@ -10,6 +10,8 @@ testpaths =
 # action:message_regex:warning_class:module_regex:line
 filterwarnings =
   error
+  default::EncodingWarning
+  error::EncodingWarning:python
   # TODO: Remove once pytest-xdist 4 is released.
   ignore:.*rsyncdir:DeprecationWarning:xdist
   # TODO: Remove once mkdocstrings stops setting fallback function.
diff --git a/config/pytest_39.ini b/config/pytest_39.ini
@@ -0,0 +1,17 @@
+# YORE: EOL 3.9: Remove file.
+# This file is used on 3.9 due to forward compatibility issue with filterwarnings.
+# See https://github.com/pytest-dev/pytest/issues/11101.
+[pytest]
+python_files =
+  test_*.py
+addopts =
+  --cov
+  --cov-config config/coverage.ini
+testpaths =
+  tests
+
+# action:message_regex:warning_class:module_regex:line
+filterwarnings =
+  error
+  # TODO: remove once pytest-xdist 4 is released
+  ignore:.*rsyncdir:DeprecationWarning:xdist
diff --git a/docs/js/insiders.js b/docs/js/insiders.js
@@ -29,11 +29,14 @@ function updatePremiumSponsors(dataURL, rank) {
             let html = '';
             html += `<b>${capRank} sponsors</b><p>`
             sponsors.forEach(function (sponsor) {
-                html += `
-                    <a href="${sponsor.url}" target="_blank" title="${sponsor.name}">
-                        <img alt="${sponsor.name}" src="${sponsor.image}" style="height: ${sponsor.imageHeight}px;">
-                    </a>
-                `
+                html += `<a href="${sponsor.url}" target="_blank" title="${sponsor.name}">`
+                if (sponsor.image) {
+                    html += `<img alt="${sponsor.name}" src="${sponsor.image}" style="height: ${sponsor.imageHeight}px;">`
+                } else if (sponsor.imageLight && sponsor.imageDark) {
+                    html += `<img alt="${sponsor.name}" src="${sponsor.imageLight}#only-light" style="height: ${sponsor.imageHeight}px;">`
+                    html += `<img alt="${sponsor.name}" src="${sponsor.imageDark}#only-dark" style="height: ${sponsor.imageHeight}px;">`
+                }
+                html += '</a>';
             });
             html += '</p>'
             sponsorsDiv.innerHTML = html;
diff --git a/duties.py b/duties.py
@@ -26,6 +26,8 @@
 WINDOWS = os.name == "nt"
 PTY = not WINDOWS and not CI
 MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
+PY_VERSION = f"{sys.version_info.major}{sys.version_info.minor}"
+PY_DEV = "314"
 
 
 def pyprefix(title: str) -> str:
@@ -84,7 +86,7 @@ def check(ctx: Context) -> None:
     """Check it all!"""
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_quality(ctx: Context) -> None:
     """Check the code quality."""
     ctx.run(
@@ -93,7 +95,7 @@ def check_quality(ctx: Context) -> None:
     )
 
 
-@duty(skip_if=sys.version_info < (3, 13), skip_reason=pyprefix("Skipped: docs require modern generics syntax"))
+@duty(nofail=PY_VERSION == PY_DEV, skip_if=sys.version_info < (3, 13), skip_reason=pyprefix("Skipped: docs require modern generics syntax"))
 def check_docs(ctx: Context) -> None:
     """Check if the documentation builds correctly."""
     Path("htmlcov").mkdir(parents=True, exist_ok=True)
@@ -105,7 +107,7 @@ def check_docs(ctx: Context) -> None:
         )
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_types(ctx: Context) -> None:
     """Check that the code is correctly typed."""
     os.environ["MYPYPATH"] = "src"
@@ -118,7 +120,7 @@ def check_types(ctx: Context) -> None:
     )
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_api(ctx: Context, *cli_args: str) -> None:
     """Check for API breaking changes."""
     ctx.run(
@@ -239,25 +241,31 @@ def coverage(ctx: Context) -> None:
     ctx.run(tools.coverage.html(rcfile="config/coverage.ini"))
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def test(ctx: Context, *cli_args: str, match: str = "", snapshot: str = "report") -> None:  # noqa: PT028
     """Run the test suite.
 
     Parameters:
         match: A pytest expression to filter selected tests.
         snapshot: Whether to "create", "fix", "trim", or "update" snapshots.
     """
-    py_version = f"{sys.version_info.major}{sys.version_info.minor}"
-    os.environ["COVERAGE_FILE"] = f".coverage.{py_version}"
+    os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}"
+    os.environ["PYTHONWARNDEFAULTENCODING"] = "1"
     args = list(cli_args)
     if snapshot == "disable" or not snapshot:
         args = ["-n", "auto", "--inline-snapshot=disable"]
     else:
         args = [f"--inline-snapshot={snapshot}"]
+
+    config_file = "config/pytest.ini"
+    # YORE: EOL 3.9: Remove block.
+    if sys.version_info[:2] < (3, 10):
+        config_file = "config/pytest_39.ini"
+
     ctx.run(
         tools.pytest(
             "tests",
-            config_file="config/pytest.ini",
+            config_file=config_file,
             select=match,
             color="yes",
         ).add_args(*args),
diff --git a/scripts/get_version.py b/scripts/get_version.py
@@ -4,7 +4,12 @@
 from contextlib import suppress
 from pathlib import Path
 
-from pdm.backend.hooks.version import SCMVersion, Version, default_version_formatter, get_version_from_scm
+from pdm.backend.hooks.version import (  # ty: ignore[unresolved-import]
+    SCMVersion,
+    Version,
+    default_version_formatter,
+    get_version_from_scm,
+)
 
 _root = Path(__file__).parent.parent
 _changelog = _root / "CHANGELOG.md"
diff --git a/scripts/make.py b/scripts/make.py
@@ -14,7 +14,8 @@
     from collections.abc import Iterator
 
 
-PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.9 3.10 3.11 3.12 3.13").split()
+PYTHON_VERSIONS = os.getenv("PYTHON_VERSIONS", "3.9 3.10 3.11 3.12 3.13 3.14").split()
+PYTHON_DEV = "3.14"
 
 
 def shell(cmd: str, *, capture_output: bool = False, **kwargs: Any) -> str | None:
@@ -67,16 +68,31 @@ def setup() -> None:
                 uv_install(venv_path)
 
 
+class _RunError(subprocess.CalledProcessError):
+    def __init__(self, *args: Any, python_version: str, **kwargs: Any):
+        super().__init__(*args, **kwargs)
+        self.python_version = python_version
+
+
 def run(version: str, cmd: str, *args: str, **kwargs: Any) -> None:
     """Run a command in a virtual environment."""
     kwargs = {"check": True, **kwargs}
     uv_run = ["uv", "run", "--no-sync"]
-    if version == "default":
-        with environ(UV_PROJECT_ENVIRONMENT=".venv"):
-            subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
-    else:
-        with environ(UV_PROJECT_ENVIRONMENT=f".venvs/{version}", MULTIRUN="1"):
-            subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
+    try:
+        if version == "default":
+            with environ(UV_PROJECT_ENVIRONMENT=".venv"):
+                subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
+        else:
+            with environ(UV_PROJECT_ENVIRONMENT=f".venvs/{version}", MULTIRUN="1"):
+                subprocess.run([*uv_run, cmd, *args], **kwargs)  # noqa: S603, PLW1510
+    except subprocess.CalledProcessError as process:
+        raise _RunError(
+            returncode=process.returncode,
+            python_version=version,
+            cmd=process.cmd,
+            output=process.output,
+            stderr=process.stderr,
+        ) from process
 
 
 def multirun(cmd: str, *args: str, **kwargs: Any) -> None:
@@ -144,19 +160,31 @@ def main() -> int:
         cmd = args.pop(0)
 
         if cmd == "run":
-            run("default", *args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            run("default", *args)  # ty: ignore[missing-argument]
             return 0
 
         if cmd == "multirun":
-            multirun(*args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            multirun(*args)  # ty: ignore[missing-argument]
             return 0
 
         if cmd == "allrun":
-            allrun(*args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            allrun(*args)  # ty: ignore[missing-argument]
             return 0
 
         if cmd.startswith("3."):
-            run(cmd, *args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            run(cmd, *args)  # ty: ignore[missing-argument]
             return 0
 
         opts = []
@@ -183,7 +211,14 @@ def main() -> int:
 if __name__ == "__main__":
     try:
         sys.exit(main())
-    except subprocess.CalledProcessError as process:
+    except _RunError as process:
         if process.output:
             print(process.output, file=sys.stderr)
-        sys.exit(process.returncode)
+        if (code := process.returncode) == 139:  # noqa: PLR2004
+            print(
+                f"✗ (python{process.python_version})  '{' '.join(process.cmd)}' failed with return code {code} (segfault)",
+                file=sys.stderr,
+            )
+            if process.python_version == PYTHON_DEV:
+                code = 0
+        sys.exit(code)
diff --git a/src/mkdocstrings_handlers/python/_internal/debug.py b/src/mkdocstrings_handlers/python/_internal/debug.py
@@ -85,7 +85,7 @@ def _get_debug_info() -> _Environment:
         interpreter_version=py_version,
         interpreter_path=sys.executable,
         platform=platform.platform(),
-        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],
+        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],  # ty: ignore[invalid-argument-type]
         packages=[_Package(pkg, _get_version(pkg)) for pkg in packages],
     )
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -92,7 +92,7 @@ def _fixture_public_objects(public_api: griffe.Module) -> list[griffe.Object | g
 def _fixture_inventory() -> Inventory:
     inventory_file = Path(__file__).parent.parent / "site" / "objects.inv"
     if not inventory_file.exists():
-        raise pytest.skip("The objects inventory is not available.")
+        pytest.skip("The objects inventory is not available.")  # ty: ignore[call-non-callable]
     with inventory_file.open("rb") as file:
         return Inventory.parse_sphinx(file)
 
@@ -138,7 +138,9 @@ def test_api_matches_inventory(inventory: Inventory, public_objects: list[griffe
     """All public objects are added to the inventory."""
     ignore_names = {"__getattr__", "__init__", "__repr__", "__str__", "__post_init__"}
     not_in_inventory = [
-        obj.path for obj in public_objects if obj.name not in ignore_names and obj.path not in inventory
+        f"{obj.relative_filepath}:{obj.lineno}: {obj.path}"
+        for obj in public_objects
+        if obj.name not in ignore_names and obj.path not in inventory
     ]
     msg = "Objects not in the inventory (try running `make run mkdocs build`):\n{paths}"
     assert not not_in_inventory, msg.format(paths="\n".join(sorted(not_in_inventory)))
