A bunch of pre-commit and CI upgrade. (#412)

Carreau · web-flow · commit 3800504fa7ef · 2025-02-27T11:43:56.000+01:00
* safe ruff fixes

* some unsafe fixes

* Tweak ignored rules

* more unsafe fixes

* more ruff fixes

* Fix all newer issues after pre-commit upgrade
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -28,7 +28,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.8", "3.12"]
+        python-version: ["3.8", "3.12", "3.13"]
         include:
           - os: windows-latest
             python-version: "3.9"
@@ -41,6 +41,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Lint
+        run: |
+          hatch run typing:test
       - name: Test
         run: |
           hatch run cov:test
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,7 +4,7 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-case-conflict
       - id: check-ast
@@ -21,12 +21,12 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.27.4
+    rev: 0.31.2
     hooks:
       - id: check-github-workflows
 
   - repo: https://github.com/executablebooks/mdformat
-    rev: 0.7.17
+    rev: 0.7.22
     hooks:
       - id: mdformat
         additional_dependencies:
@@ -39,22 +39,22 @@ repos:
         types_or: [yaml, html, json]
 
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: "1.16.0"
+    rev: "1.19.1"
     hooks:
       - id: blacken-docs
         additional_dependencies: [black==23.7.0]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.8.0"
+    rev: "v1.15.0"
     hooks:
       - id: mypy
         files: jupyter_core
         stages: [manual]
-        args: ["--install-types", "--non-interactive"]
-        additional_dependencies: ["traitlets>=5.13", "platformdirs>=3.11"]
+        additional_dependencies:
+          ["traitlets>=5.13", "platformdirs>=3.11", "argcomplete"]
 
   - repo: https://github.com/codespell-project/codespell
-    rev: "v2.2.6"
+    rev: "v2.4.1"
     hooks:
       - id: codespell
         args: ["-L", "re-use"]
@@ -67,7 +67,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.2.0
+    rev: v0.9.7
     hooks:
       - id: ruff
         types_or: [python, jupyter]
@@ -76,7 +76,7 @@ repos:
         types_or: [python, jupyter]
 
   - repo: https://github.com/scientific-python/cookie
-    rev: "2024.01.24"
+    rev: "2025.01.22"
     hooks:
       - id: sp-repo-review
         additional_dependencies: ["repo-review[cli]"]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -339,7 +339,7 @@ We now make the assumption that if we are running in a virtual environment, we s
 
 #### Migrate to Standard Platform Directories
 
-In version 5, we introduce a `JUPYTER_PLATFORM_DIRS` environment variable to opt in to using more appropriate platform-specific directories.  We raise a deprecation warning if the variable is not set.  In version 6,  `JUPYTER_PLATFORM_DIRS` will be opt-out.  In version 7, we will remove the environment variable checks and old directory logic.
+In version 5, we introduce a `JUPYTER_PLATFORM_DIRS` environment variable to opt in to using more appropriate platform-specific directories. We raise a deprecation warning if the variable is not set. In version 6, `JUPYTER_PLATFORM_DIRS` will be opt-out. In version 7, we will remove the environment variable checks and old directory logic.
 
 #### Drop Support for Python 3.7
 
diff --git a/docs/conf.py b/docs/conf.py
@@ -69,7 +69,8 @@
 # built documents.
 #
 # The short X.Y version.
-version = "%d.%d" % version_info[:2]  # type:ignore[str-format]
+major, minor = version_info[:2]
+version = f"{major}.{minor}"
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
diff --git a/jupyter.py b/jupyter.py
@@ -1,4 +1,5 @@
 """Launch the root jupyter command"""
+
 from __future__ import annotations
 
 if __name__ == "__main__":
diff --git a/jupyter_core/__main__.py b/jupyter_core/__main__.py
@@ -1,4 +1,5 @@
 """Launch the root jupyter command"""
+
 from __future__ import annotations
 
 from .command import main
diff --git a/jupyter_core/application.py b/jupyter_core/application.py
@@ -133,6 +133,7 @@ def _config_file_name_default(self) -> str:
 
     def write_default_config(self) -> None:
         """Write our default config to a .py config file"""
+        config_file: str
         if self.config_file:
             config_file = self.config_file
         else:
@@ -142,7 +143,7 @@ def write_default_config(self) -> None:
             answer = ""
 
             def ask() -> str:
-                prompt = "Overwrite %s with default config? [y/N]" % config_file
+                prompt = f"Overwrite {config_file!r} with default config? [y/N]"
                 try:
                     return input(prompt).lower() or "n"
                 except KeyboardInterrupt:
@@ -157,7 +158,7 @@ def ask() -> str:
                 return
 
         config_text = self.generate_config_file()
-        print("Writing default config to: %s" % config_file)
+        print("Writing default config to: {config_file!r}")
         ensure_dir_exists(Path(config_file).parent.resolve(), 0o700)
         with Path.open(Path(config_file), mode="w", encoding="utf-8") as f:
             f.write(config_text)
diff --git a/jupyter_core/command.py b/jupyter_core/command.py
@@ -28,12 +28,13 @@ class JupyterParser(argparse.ArgumentParser):
     """A Jupyter argument parser."""
 
     @property
-    def epilog(self) -> str | None:
+    def epilog(self) -> str:
         """Add subcommands to epilog on request
 
         Avoids searching PATH for subcommands unless help output is requested.
         """
-        return "Available subcommands: %s" % " ".join(list_subcommands())
+        subcommands: str = " ".join(list_subcommands())
+        return f"Available subcommands: {subcommands}"
 
     @epilog.setter
     def epilog(self, x: Any) -> None:
@@ -42,7 +43,7 @@ def epilog(self, x: Any) -> None:
     def argcomplete(self) -> None:
         """Trigger auto-completion, if enabled"""
         try:
-            import argcomplete  # type: ignore[import-not-found]
+            import argcomplete
 
             argcomplete.autocomplete(self)
         except ImportError:
@@ -119,7 +120,8 @@ def _execvp(cmd: str, argv: list[str]) -> None:
         # so rely on shutil.which
         cmd_path = which(cmd)
         if cmd_path is None:
-            raise OSError("%r not found" % cmd, errno.ENOENT)
+            msg = f"{cmd!r} not found"
+            raise OSError(msg, errno.ENOENT)
         p = Popen([cmd_path] + argv[1:])  # noqa: S603
         # Don't raise KeyboardInterrupt in the parent process.
         # Set this after spawning, to avoid subprocess inheriting handler.
@@ -377,7 +379,7 @@ def main() -> None:
 
                 for name in sorted(data):
                     path = data[name]
-                    print("%s:" % name)
+                    print(f"{name}:")
                     for p in path:
                         print("    " + p)
             return
diff --git a/jupyter_core/paths.py b/jupyter_core/paths.py
@@ -174,7 +174,7 @@ def jupyter_data_dir() -> str:
 
     if sys.platform == "darwin":
         return str(Path(home, "Library", "Jupyter"))
-    if sys.platform == "win32":
+    if sys.platform == "win32":  # type: ignore[unreachable]
         appdata = os.environ.get("APPDATA", None)
         if appdata:
             return str(Path(appdata, "jupyter").resolve())
@@ -292,18 +292,17 @@ def jupyter_path(*subdirs: str) -> list[str]:
     SYSTEM_CONFIG_PATH = platformdirs.site_config_dir(
         APPNAME, appauthor=False, multipath=True
     ).split(os.pathsep)
+elif os.name == "nt":
+    programdata = os.environ.get("PROGRAMDATA", None)
+    if programdata:
+        SYSTEM_CONFIG_PATH = [str(Path(programdata, "jupyter"))]
+    else:  # PROGRAMDATA is not defined by default on XP.
+        SYSTEM_CONFIG_PATH = []
 else:
-    if os.name == "nt":
-        programdata = os.environ.get("PROGRAMDATA", None)
-        if programdata:  # noqa: SIM108
-            SYSTEM_CONFIG_PATH = [str(Path(programdata, "jupyter"))]
-        else:  # PROGRAMDATA is not defined by default on XP.
-            SYSTEM_CONFIG_PATH = []
-    else:
-        SYSTEM_CONFIG_PATH = [
-            "/usr/local/etc/jupyter",
-            "/etc/jupyter",
-        ]
+    SYSTEM_CONFIG_PATH = [
+        "/usr/local/etc/jupyter",
+        "/etc/jupyter",
+    ]
 ENV_CONFIG_PATH: list[str] = [str(Path(sys.prefix, "etc", "jupyter"))]
 
 
@@ -986,7 +985,7 @@ def secure_write(fname: str, binary: bool = False) -> Iterator[Any]:
         else:
             # Python on windows does not respect the group and public bits for chmod, so we need
             # to take additional steps to secure the contents.
-            # Touch file pre-emptively to avoid editing permissions in open files in Windows
+            # Touch file preemptively to avoid editing permissions in open files in Windows
             fd = os.open(fname, open_flag, 0o0600)
             os.close(fd)
             open_flag = os.O_WRONLY | os.O_TRUNC
diff --git a/jupyter_core/troubleshoot.py b/jupyter_core/troubleshoot.py
@@ -3,6 +3,7 @@
 display environment information that is frequently
 used to troubleshoot installations of Jupyter or IPython
 """
+
 from __future__ import annotations
 
 import os
@@ -68,17 +69,17 @@ def main() -> None:
         print(f"\t{directory}")
 
     print("\nsys.executable:")
-    print(f'\t{environment_data["sys_exe"]}')
+    print(f"\t{environment_data['sys_exe']}")
 
     print("\nsys.version:")
     if "\n" in environment_data["sys_version"]:
         for data in environment_data["sys_version"].split("\n"):
             print(f"\t{data}")
     else:
-        print(f'\t{environment_data["sys_version"]}')
+        print(f"\t{environment_data['sys_version']}")
 
     print("\nplatform.platform():")
-    print(f'\t{environment_data["platform"]}')
+    print(f"\t{environment_data['platform']}")
 
     if environment_data["which"]:
         print("\nwhich -a jupyter:")
diff --git a/jupyter_core/utils/__init__.py b/jupyter_core/utils/__init__.py
@@ -28,7 +28,8 @@ def ensure_dir_exists(path: str | Path, mode: int = 0o777) -> None:
         if e.errno != errno.EEXIST:
             raise
     if not Path(path).is_dir():
-        raise OSError("%r exists but is not a directory" % path)
+        msg = f"{path!r} exists but is not a directory"
+        raise OSError(msg)
 
 
 def _get_frame(level: int) -> FrameType | None:
@@ -201,5 +202,4 @@ async def ensure_async(obj: Awaitable[T] | T) -> T:
                 return cast(T, obj)
             raise
         return result
-    # obj doesn't need to be awaited
-    return cast(T, obj)
+    return obj
diff --git a/jupyter_core/version.py b/jupyter_core/version.py
@@ -1,6 +1,7 @@
 """
 store the current version info of the jupyter_core.
 """
+
 from __future__ import annotations
 
 import re
diff --git a/pyproject.toml b/pyproject.toml
@@ -108,6 +108,10 @@ python_version = "3.8"
 strict = true
 enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
 warn_unreachable = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+warn_redundant_casts = true
+disallow_untyped_calls = true
 
 [tool.pytest.ini_options]
 minversion = "7.0"
@@ -176,18 +180,16 @@ extend-select = [
   "S",           # flake8-bandit
 ]
 ignore = [
-  "PLR",    # Design related pylint codes
-  "Q000",   # Single quotes found but double quotes preferred
   "E501",   # Line too long (158 > 100 characters)
-  "UP007",  # Use `X | Y` for type annotations"
-  "SIM105", # Use `contextlib.suppress(...)`
+  "PLR0912",# Too many branches
+  "PLR0915",# Too many statements
+  "PLR2004",# Magic value used in comparison, consider replacing `...` with a constant variable
+  "RUF012", # Mutable class attributes should be annotated
   "S101",   # Use of assert
-  "RUF012"  # Mutable class attributes should be annotated
-]
-unfixable = [
-  "T201", # Don't touch print statements
-  "RUF100", # Don't touch noqa lines
-  "F401"  # Unused imports
+  "SIM103", # Return the condition directly
+  "SIM105", # Use `contextlib.suppress(...)`
+  "SIM108", # Use ternary operator
+  "UP007",  # Use `X | Y` for type annotations"
 ]
 isort.required-imports = ["from __future__ import annotations"]
 
diff --git a/scripts/jupyter b/scripts/jupyter
@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 """Launch the root jupyter command"""
+
 from __future__ import annotations
 
 from jupyter_core.command import main
diff --git a/scripts/jupyter-migrate b/scripts/jupyter-migrate
@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # PYTHON_ARGCOMPLETE_OK
 """Migrate Jupyter config from IPython < 4.0"""
+
 from __future__ import annotations
 
 from jupyter_core.migrate import main
diff --git a/tests/test_command.py b/tests/test_command.py
@@ -1,4 +1,5 @@
 """Test the Jupyter command-line"""
+
 from __future__ import annotations
 
 import json
@@ -99,7 +100,7 @@ def test_paths():
     for d in (jupyter_config_dir(), jupyter_data_dir(), jupyter_runtime_dir()):
         assert d in output
     for key in ("config", "data", "runtime"):
-        assert ("%s:" % key) in output
+        assert (f"{key}:") in output
 
     for path in (jupyter_config_path(), jupyter_path()):
         for d in path:
diff --git a/tests/test_migrate.py b/tests/test_migrate.py
@@ -1,6 +1,7 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 """Test config file migration"""
+
 from __future__ import annotations
 
 import os
@@ -29,15 +30,15 @@
 dotipython_empty = pjoin(here, "dotipython_empty")
 
 
-@pytest.fixture()
+@pytest.fixture
 def td(request):
     """Fixture for a temporary directory"""
     td = mkdtemp("μnïcø∂e")
     yield td
     shutil.rmtree(td)
 
 
-@pytest.fixture()
+@pytest.fixture
 def env(request):
     """Fixture for a full testing environment"""
     td = mkdtemp()
diff --git a/tests/test_paths.py b/tests/test_paths.py
@@ -526,7 +526,7 @@ def test_secure_write_win32():
     def fetch_win32_permissions(filename):
         """Extracts file permissions on windows using icacls"""
         role_permissions = {}
-        proc = os.popen("icacls %s" % filename)
+        proc = os.popen(f"icacls {filename}")
         lines = proc.read().splitlines()
         proc.close()
         for index, line in enumerate(lines):

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,8 @@`
`69`	`69`	`# built documents.`
`70`	`70`	`#`
`71`	`71`	`# The short X.Y version.`
`72`		`-version = "%d.%d" % version_info[:2] # type:ignore[str-format]`
	`72`	`+major, minor = version_info[:2]`
	`73`	`+version = f"{major}.{minor}"`
`73`	`74`	`# The full version, including alpha/beta/rc tags.`
`74`	`75`	`release = __version__`
`75`	`76`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Launch the root jupyter command"""`
	`2`	`+`
`2`	`3`	`from __future__ import annotations`
`3`	`4`
`4`	`5`	`if __name__ == "__main__":`