Upgrade tools and deps

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>

Author: gaborbernat

.pre-commit-config.yaml

@@ -4,31 +4,28 @@ repos:
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        additional_dependencies: [ "tomli>=2.0.1" ]
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [ "tomli>=2.0.1" ]
+        args: [ "--in-place", "--config", "./pyproject.toml" ]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.14"
+    rev: "v0.1.15"
     hooks:
       - id: ruff-format
       - id: ruff
-        args: ["--fix", "--unsafe-fixes", "--exit-non-zero-on-fix"]
-  - repo: https://github.com/tox-dev/tox-ini-fmt
-    rev: "1.3.1"
-    hooks:
-      - id: tox-ini-fmt
-        args: ["-p", "fix"]
+        args: [ "--fix", "--unsafe-fixes", "--exit-non-zero-on-fix" ]
   - repo: https://github.com/tox-dev/pyproject-fmt
     rev: "1.7.0"
     hooks:
       - id: pyproject-fmt
-        additional_dependencies: ["tox>=4.11.4"]
-  - repo: https://github.com/asottile/blacken-docs
-    rev: 1.16.0
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==23.11]
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
-    hooks:
-      - id: rst-backticks
+        additional_dependencies: ["tox>=4.12.1"]
   - repo: meta
     hooks:
       - id: check-hooks-apply

pyproject.toml

@@ -46,13 +46,13 @@ dependencies = [
   'typing-extensions>=4.7.1; python_version < "3.11"',
 ]
 optional-dependencies.docs = [
-  "furo>=2023.9.10",
+  "furo>=2024.1.29",
   "sphinx<7.2",
-  "sphinx-autodoc-typehints>=1.25.2",
+  "sphinx-autodoc-typehints>=1.25.3",
 ]
 optional-dependencies.testing = [
   "covdefaults>=2.3",
-  "pytest>=7.4.3",
+  "pytest>=7.4.4",
   "pytest-cov>=4.1",
   "pytest-mock>=3.11.1",
   "setuptools>=68",
@@ -65,33 +65,48 @@ urls.Tracker = "https://github.com/tox-dev/py-discovery/issues"
 build.hooks.vcs.version-file = "src/py_discovery/_version.py"
 version.source = "vcs"
 
-[tool.black]
-line-length = 120
-
 [tool.ruff]
 select = ["ALL"]
 line-length = 120
 target-version = "py37"
-isort = {known-first-party = ["py_discovery"], required-imports = ["from __future__ import annotations"]}
+isort = { known-first-party = ["py_discovery"], required-imports = ["from __future__ import annotations"] }
 ignore = [
-  "INP001",  # no implicit namespaces here
-  "ANN101",  # Missing type annotation for `self` in method
-  "ANN102",  # Missing type annotation for `cls` in classmethod"
-  "ANN401",  # Dynamically typed expressions
-  "D203",  # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
-  "D212",  # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible
-  "S104",  # Possible binding to all interfaces
+  "INP001", # no implicit namespaces here
+  "ANN101", # Missing type annotation for `self` in method
+  "ANN102", # Missing type annotation for `cls` in classmethod"
+  "ANN401", # Dynamically typed expressions
+  "D203",   # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible
+  "D212",   # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible
+  "S104",   # Possible binding to all interfaces
+  "CPY",    # no copyright
 ]
+format.preview = true
+lint.preview = true
 [tool.ruff.per-file-ignores]
 "tests/**/*.py" = [
-  "S101",  # asserts allowed in tests
-  "FBT",  # don't care about booleans as positional arguments in tests
-  "INP001", # no implicit namespace
-  "D",  # don't care about documentation in tests
-  "S603",  # `subprocess` call: check for execution of untrusted input
-  "PLR2004",  # Magic value used in comparison, consider replacing with a constant variable
+  "S101",    # asserts allowed in tests
+  "FBT",     # don't care about booleans as positional arguments in tests
+  "INP001",  # no implicit namespace
+  "D",       # don't care about documentation in tests
+  "S603",    # `subprocess` call: check for execution of untrusted input
+  "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
+  "PLC2701", # Private imports
+  "PLR0917", # too many positional arguments
+  "PLC0415", # import at top
 ]
 
+[tool.codespell]
+builtin = "clear,usage,en-GB_to_en-US"
+count = true
+quiet-level = 3
+
+[tool.docformatter]
+blank = true
+recursive = true
+pre-summary-newline = true
+wrap-descriptions = 120
+wrap-summaries = 120
+
 [tool.coverage]
 report.fail_under = 87
 html.show_contexts = true
@@ -110,7 +125,7 @@ run.parallel = true
 run.plugins = ["covdefaults"]
 
 [tool.mypy]
-python_version = "3.7"
+python_version = "3.8"
 show_error_codes = true
 strict = true
 overrides = [{ module = ["setuptools.*"], ignore_missing_imports = true }]

src/py_discovery/__init__.py

@@ -1,4 +1,5 @@
 """Python discovery."""
+
 from __future__ import annotations
 
 from ._builtin import Builtin, PathPythonInfo, get_interpreter
@@ -10,12 +11,12 @@
 __version__ = version  #: version of the package
 
 __all__ = [
-    "PythonInfo",
-    "VersionInfo",
-    "PythonSpec",
-    "Discover",
     "Builtin",
+    "Discover",
     "PathPythonInfo",
-    "get_interpreter",
+    "PythonInfo",
+    "PythonSpec",
+    "VersionInfo",
     "__version__",
+    "get_interpreter",
 ]

src/py_discovery/_builtin.py

@@ -110,7 +110,7 @@ def propose_interpreters(  # noqa: C901, PLR0912
 
         # 3. otherwise fallbacks to platform default logic
         if sys.platform == "win32":
-            from ._windows import propose_interpreters
+            from ._windows import propose_interpreters  # noqa: PLC0415
 
             for interpreter in propose_interpreters(spec, env):
                 yield interpreter, True
@@ -184,11 +184,11 @@ def possible_specs(spec: PythonSpec) -> Iterator[tuple[str, bool]]:
 
 
 class PathPythonInfo(PythonInfo):
-    """python info from a path."""
+    """Python info from a path."""
 
 
 __all__ = [
-    "get_interpreter",
     "Builtin",
     "PathPythonInfo",
+    "get_interpreter",
 ]

src/py_discovery/_discover.py

@@ -18,6 +18,7 @@ def add_parser_arguments(cls, parser: ArgumentParser) -> None:
         Add CLI arguments for this discovery mechanisms.
 
         :param parser: The CLI parser.
+
         """
         raise NotImplementedError
 
@@ -26,6 +27,7 @@ def __init__(self, options: Namespace) -> None:
         Create a new discovery mechanism.
 
         :param options: The parsed options as defined within the :meth:`add_parser_arguments`.
+
         """
         self._has_run = False
         self._interpreter: PythonInfo | None = None
@@ -37,6 +39,7 @@ def run(self) -> PythonInfo | None:
         Discovers an interpreter.
 
         :return: The interpreter ready to use for virtual environment creation
+
         """
         raise NotImplementedError
 

src/py_discovery/_info.py

@@ -2,6 +2,7 @@
 The PythonInfo contains information about a concrete instance of a Python interpreter.
 
 Note: this file is also used to query target interpreters, so can only use standard library methods
+
 """
 
 from __future__ import annotations
@@ -20,7 +21,7 @@
 from random import choice
 from shlex import quote
 from string import ascii_lowercase, ascii_uppercase, digits
-from subprocess import PIPE, Popen
+from subprocess import PIPE, Popen  # noqa: S404
 from tempfile import NamedTemporaryFile
 from typing import TYPE_CHECKING, Any, Iterator, Mapping, MutableMapping
 
@@ -152,7 +153,7 @@ def abs_path(v: str | None) -> str | None:
     def _fast_get_system_executable(self) -> str | None:
         """Try to get the system executable by just looking at properties."""
         # if this is a virtual environment
-        if self.real_prefix or self.base_prefix is not None and self.base_prefix != self.prefix:
+        if self.real_prefix or (self.base_prefix is not None and self.base_prefix != self.prefix):  # noqa: PLR1702
             if self.real_prefix is None:
                 # some platforms may set this to help us
                 base_executable: str | None = getattr(sys, "_base_executable", None)
@@ -196,8 +197,8 @@ def _distutils_install() -> dict[str, str]:
         with warnings.catch_warnings():  # disable warning for PEP-632
             warnings.simplefilter("ignore")
             try:
-                from distutils import dist
-                from distutils.command.install import SCHEME_KEYS
+                from distutils import dist  # noqa: PLC0415
+                from distutils.command.install import SCHEME_KEYS  # noqa: PLC0415
             except ImportError:  # if removed or not installed ignore
                 return {}
 
@@ -275,9 +276,6 @@ def system_exec_prefix(self) -> str:
         assert res is not None  # noqa: S101
         return res
 
-    def __unicode__(self) -> str:
-        return repr(self)
-
     def __repr__(self) -> str:
         return "{}({!r})".format(
             self.__class__.__name__,
@@ -357,6 +355,7 @@ def current(cls) -> PythonInfo:
         Locate the current host interpreter information.
 
         This might be different than what we run into in case the host python has been upgraded from underneath us.
+
         """
         if cls._current is None:
             cls._current = cls.from_exe(sys.executable, raise_on_error=True, resolve_to_host=False)
@@ -369,6 +368,7 @@ def current_system(cls) -> PythonInfo:
         Locate the current host interpreter information.
 
         This might be different than what we run into in case the host python has been upgraded from underneath us.
+
         """
         if cls._current_system is None:
             cls._current_system = cls.from_exe(sys.executable, raise_on_error=True, resolve_to_host=True)
@@ -380,7 +380,7 @@ def _to_json(self) -> str:
         return json.dumps(self._to_dict(), indent=2)
 
     def _to_dict(self) -> dict[str, Any]:
-        data = {var: (getattr(self, var) if var not in ("_creators",) else None) for var in vars(self)}
+        data = {var: (getattr(self, var) if var != "_creators" else None) for var in vars(self)}
 
         data["version_info"] = data["version_info"]._asdict()  # namedtuple to dictionary
         return data
@@ -683,10 +683,10 @@ def __repr__(self) -> str:
 
 
 __all__ = [
+    "EXTENSIONS",
     "PythonInfo",
     "VersionInfo",
     "fs_is_case_sensitive",
-    "EXTENSIONS",
 ]
 
 

src/py_discovery/_spec.py

@@ -15,7 +15,7 @@
 class PythonSpec:
     """Contains specification about a Python Interpreter."""
 
-    def __init__(  # noqa: PLR0913
+    def __init__(  # noqa: PLR0913, PLR0917
         self,
         str_spec: str | None,
         implementation: str | None,
@@ -36,7 +36,7 @@ def __init__(  # noqa: PLR0913
     @classmethod
     def from_string_spec(cls, string_spec: str) -> PythonSpec:  # noqa: C901, PLR0912
         impl, major, minor, micro, arch, path = None, None, None, None, None, None
-        if os.path.isabs(string_spec):  # noqa: PTH117
+        if os.path.isabs(string_spec):  # noqa: PTH117, PLR1702
             path = string_spec
         else:
             ok = False

src/py_discovery/_windows/pep514.py

@@ -47,8 +47,7 @@ def __exit__(
             exc_type: type[BaseException] | None,
             exc_value: BaseException | None,
             traceback: TracebackType | None,
-        ) -> bool | None:
-            ...
+        ) -> bool | None: ...
 
     def EnumKey(__key: _KeyType, __index: int) -> str:  # noqa: N802
         return ""

tests/test_py_info.py

@@ -160,7 +160,7 @@ def test_system_executable_no_exact_match(  # noqa: PLR0913
     mocker: MockerFixture,
     caplog: pytest.LogCaptureFixture,
 ) -> None:
-    """Here we should fallback to other compatible"""
+    """Here we should fallback to other compatible."""
     caplog.set_level(logging.DEBUG)
 
     def _make_py_info(of: PyInfoMock) -> PythonInfo:

tests/windows/test_windows.py

@@ -119,7 +119,7 @@ def test_propose_interpreters(string_spec: str, expected_exe: str, mocker: Mocke
 
 
 def _mock_pyinfo(major: int | None, minor: int | None, arch: int | None, exe: str) -> PythonInfo:
-    """Return PythonInfo objects with essential metadata set for the given args"""
+    """Return PythonInfo objects with essential metadata set for the given args."""
     info = PythonInfo()
     info.base_prefix = str(Path(exe).parent)
     info.executable = info.original_executable = info.system_executable = exe