pyproject.toml

[build-system]
build-backend = "hatchling.build"
requires = [
  "hatch-fancy-pypi-readme>=25.1",
  "hatch-vcs>=0.5",
  "hatchling>=1.27; python_version<'3.10'",
  "hatchling>=1.28; python_version>='3.10'",
]

[project]
name = "python-discovery"
import-names = [ "python_discovery" ]
description = "Python interpreter discovery"
keywords = [
  "discovery",
  "interpreter",
  "python",
]
license = "MIT"
license-files = [ "LICENSE" ]
maintainers = [
  { name = "Bernát Gábor", email = "gaborjbernat@gmail.com" },
]
requires-python = ">=3.9"
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: Developers",
  "Operating System :: MacOS :: MacOS X",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Programming Language :: Python :: 3.15",
  "Programming Language :: Python :: Implementation :: CPython",
  "Topic :: Software Development :: Libraries",
  "Topic :: Utilities",
]
dynamic = [
  "readme",
  "version",
]
dependencies = [
  "filelock>=3.16.1",
]
urls.Changelog = "https://github.com/tox-dev/python-discovery/blob/main/docs/changelog.rst"
urls.Documentation = "https://python-discovery.readthedocs.io"
urls.Homepage = "https://github.com/tox-dev/python-discovery"
urls.Source = "https://github.com/tox-dev/python-discovery"
urls.Tracker = "https://github.com/tox-dev/python-discovery/issues"

[dependency-groups]
test = [
  "covdefaults>=2.3",
  "coverage>=7.6.1",
  "packaging>=23.2",
  "pytest>=8.3.5",
  "pytest-mock>=3.14.1",
  "setuptools>=75.3.4",
  "typing-extensions>=4.12",
  "vermin>=1.8",
]
docs = [
  "furo>=2025.12.19",
  "sphinx>=9.1",
  "sphinx-autodoc-typehints>=3.6.3",
  "sphinx-llm>=0.4.1,!=1.1",
  "sphinxcontrib-mermaid>=2",
  "sphinxcontrib-towncrier>=0.4",
  "towncrier>=25.8",
]
build = [
  "cython>=3",
  "hatch-fancy-pypi-readme>=25.1",
  "hatch-vcs>=0.5",
  "hatchling>=1.27; python_version<'3.10'",
  "hatchling>=1.28; python_version>='3.10'",
  "setuptools>=80",
]
pkg-meta = [
  "check-wheel-contents>=0.6.3",
  "twine>=6.2",
  "uv>=0.12.22",
]
release-news = [
  "release-creator>=4.1",
  "towncrier>=26.9",
]
release-notes = [
  "release-creator>=4.1",
]
release-prepare = [
  "prek>=0.2",
  "release-creator>=4.1",
  "towncrier>=26.9",
]

[tool.hatch]
version.source = "vcs"
metadata.hooks.fancy-pypi-readme.content-type = "text/markdown"
metadata.hooks.fancy-pypi-readme.fragments = [ { path = "README.md" } ]

[tool.uv]
dependency-groups.docs = { requires-python = ">=3.12" }
dependency-groups.pkg-meta = { requires-python = ">=3.10" }
dependency-groups.release-news = { requires-python = ">=3.15" }
dependency-groups.release-notes = { requires-python = ">=3.15" }
dependency-groups.release-prepare = { requires-python = ">=3.15" }

[tool.ruff]
target-version = "py39"
line-length = 120
format.preview = true
format.docstring-code-line-length = 100
format.docstring-code-format = true
lint.select = [
  "ALL",
]
lint.ignore = [
  "CPY",                                       # No copyright statements
  "docstring-missing-exception",               # `raises` is not documented in docstring
  "docstring-missing-returns",                 # `return` is not documented in docstring
  "docstring-missing-yields",                  # `yield` is not documented in docstring
  "hardcoded-bind-all-interfaces",             # Possible binding to all interface
  "incorrect-blank-line-before-class",         # `one-blank-line-before-class` and `no-blank-line-before-class` are incompatible
  "missing-trailing-comma",                    # Conflict with formatter
  "multi-line-summary-first-line",             # `multi-line-summary-first-line` and `multi-line-summary-second-line` are incompatible
  "single-line-implicit-string-concatenation", # Conflict with formatter
]
lint.per-file-ignores."docs/**/*.py" = [
  "implicit-namespace-package", # no __init__.py in docs directory
]
lint.per-file-ignores."src/python_discovery/_discovery.py" = [
  "PTH", # shim resolution uses string-based os.path for consistency with env variables
]
lint.per-file-ignores."src/python_discovery/_py_info.py" = [
  "PTH", # string-based os.path kept for parity with the interrogation script data
]
lint.per-file-ignores."src/python_discovery/_py_info_collect.py" = [
  "ANN",                              # file must parse on Python 2.7 for the version gate: no annotations
  "missing-required-import",          # `from __future__ import annotations` is a SyntaxError below 3.7
  "module-import-not-at-top-of-file", # the version gate must run before importing sysconfig, absent on 3.0/3.1
  "PTH",                              # must use os.path — file runs as subprocess script with only stdlib
  "UP",                               # pyupgrade pushes syntax newer than the 2.7 parse floor, e.g. f-strings
]
lint.per-file-ignores."src/python_discovery/_windows/_pep514.py" = [
  "PTH", # os.path.exists is monkeypatched in tests; pathlib.Path.exists bypasses the mock
]
lint.per-file-ignores."tasks/**/*.py" = [
  "D",                                    # release helper scripts, not API
  "implicit-namespace-package",           # no __init__.py in tasks directory
  "subprocess-without-shell-equals-true", # `subprocess` call: argv built from trusted inputs (version, gh CLI)
  "suspicious-subprocess-import",         # subprocess import (release tooling)
]
lint.per-file-ignores."tests/**/*.py" = [
  "assert",                               # asserts allowed in tests
  "D",                                    # don't care about documentation in tests
  "FBT",                                  # don't care about booleans as positional arguments in tests
  "implicit-namespace-package",           # no implicit namespace
  "import-outside-top-level",             # imports inside test functions (conditional on mocking)
  "import-private-name",                  # private imports needed to test internal APIs
  "magic-value-comparison",               # Magic value used in comparison
  "private-member-access",                # private member access needed to test internals
  "pytest-fixture-autouse",               # shared setup fixtures are meant to apply to every test
  "subprocess-without-shell-equals-true", # `subprocess` call: check for execution of untrusted input
  "suspicious-subprocess-import",         # subprocess import
  "too-many-arguments",                   # too many arguments (pytest fixtures)
  "too-many-positional-arguments",        # too many positional arguments (pytest fixtures)
]
lint.per-file-ignores."tests/windows/winreg_mock_values.py" = [
  "undefined-name", # undefined name (winreg available only on Windows)
]
lint.isort = { known-first-party = [
  "python_discovery",
], required-imports = [
  "from __future__ import annotations",
] }
lint.preview = true

[tool.codespell]
builtin = "clear,usage,en-GB_to_en-US"
write-changes = true
count = true

[tool.pyproject-fmt]
max_supported_python = "3.15"

[tool.ty]
src.exclude = [ "tests/windows/winreg_mock_values.py" ]

[[tool.ty.overrides]]
include = [
  "src/python_discovery/_py_info.py",
  "src/python_discovery/_py_info_collect.py",
  "src/python_discovery/_py_spec.py",
]
rules.unused-ignore-comment = "ignore"
rules.invalid-argument-type = "ignore"
rules.invalid-return-type = "ignore"
rules.no-matching-overload = "ignore"

[[tool.ty.overrides]]
include = [ "tests/**/*.py" ]
rules.unused-ignore-comment = "ignore"
rules.invalid-argument-type = "ignore"
rules.no-matching-overload = "ignore"
rules.unresolved-attribute = "ignore"

[tool.pytest]
ini_options.markers = [ "graalpy" ]

[tool.coverage]
run.source = [
  "python_discovery",
  "tests",
]
run.branch = true
run.dynamic_context = "test_function"
run.parallel = true
run.plugins = [
  "covdefaults",
]
paths.source = [
  "src",
  ".tox*/*/lib/python*/site-packages",
  ".tox*/pypy*/site-packages",
  ".tox*\\*\\Lib\\site-packages",
  "*/src",
  "*\\src",
]
report.fail_under = 100
report.omit = [
  "src/python_discovery/_windows/*",
  "tests/windows/*",
]
report.partial_branches = [
  "assert any\\(",
]
report.show_missing = true
html.show_contexts = true
html.skip_covered = false

[tool.towncrier]
name = "python-discovery"
directory = "docs/changelog"
filename = "docs/changelog.rst"
template = "docs/changelog/template.jinja2"
title_format = false
issue_format = ":issue:`{issue}`"
type = [
  { directory = "feature", name = "Added", showcontent = true },
  { directory = "change", name = "Changes", showcontent = true },
  { directory = "bugfix", name = "Fixed", showcontent = true },
  { directory = "doc", name = "Documentation", showcontent = true },
  { directory = "breaking", name = "Breaking changes", showcontent = true },
  { directory = "security", name = "Security", showcontent = true },
  { directory = "performance", name = "Performance", showcontent = true },
  { directory = "deprecation", name = "Deprecated", showcontent = true },
  { directory = "removal", name = "Removed", showcontent = true },
  { directory = "packaging", name = "Packaging", showcontent = true },
]

[tool.nab]
mode = "universal"
base-group = "project-runtime"
uploaded-prior-to = "P7D"
decision-order = "stable"
matrix.python = ">=3.15,<3.16"
matrix.platforms = [ "linux_x86_64" ]
# temporary, delete after 2026-11-02
packages.release-creator.uploaded-prior-to = 2026-10-26T18:24:46Z