pyproject.toml

# cspell: ignore tomlsort

[build-system]
build-backend = "setuptools.build_meta"
requires = [
  "setuptools >= 65.3.0", # required by pyproject+setuptools_scm integration and editable installs
  "setuptools_scm[toml] >= 7.0.5" # required for "no-local-version" scheme
]

[project]
authors = [
  {"email" = "sorin.sbarnea@gmail.com", "name" = "Sorin Sbarnea"}
]
classifiers = [
  # https://pypi.org/classifiers/
  "Development Status :: 5 - Production/Stable",
  "Environment :: Console",
  "Intended Audience :: Developers",
  "Intended Audience :: Information Technology",
  "Intended Audience :: System Administrators",
  "Operating System :: MacOS",
  "Operating System :: POSIX :: Linux",
  "Operating System :: POSIX",
  "Programming Language :: Python :: 3",
  "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",
  "Topic :: System :: Systems Administration",
  "Topic :: Utilities"
]
description = "subprocess-tee extends standard library subprocess.run to allow display and capture of executed command output."
dynamic = ["version", "dependencies", "optional-dependencies"]
keywords = ["subprocess", "asyncio"]
license = "MIT"
maintainers = [
  {"email" = "sorin.sbarnea@gmail.com", "name" = "Sorin Sbarnea"}
]
name = "subprocess-tee"
readme = "README.md"
# https://peps.python.org/pep-0621/#readme
requires-python = ">=3.9"

[project.urls]
changelog = "https://github.com/pycontribs/subprocess-tee/releases"
documentation = "https://subprocess-tee.readthedocs.io"
homepage = "https://github.com/pycontribs/subprocess-tee"
repository = "https://github.com/pycontribs/subprocess-tee"

[tool.black]
target-version = ["py39"]

[tool.codespell]
skip = ".tox,.mypy_cache,build,.git,.eggs,pip-wheel-metadata"

[tool.coverage.report]
exclude_also = ["pragma: no cover", "if TYPE_CHECKING:"]
# Increase it just so it would pass on any single-python run
fail_under = 78
ignore_errors = true
omit = ["**/.cache/*", "src/*/_version.py"]
show_missing = true
skip_covered = true
skip_empty = true

[tool.coverage.run]
# Do not use branch until bug is fixes:
# https://github.com/nedbat/coveragepy/issues/605
branch = false
concurrency = ["multiprocessing", "thread"]
omit = ["**/.cache/*", "src/*/_version.py"]
parallel = true
source = ["src"]

[tool.mypy]
check_untyped_defs = true
color_output = true
disallow_any_generics = true
disallow_any_unimported = true
disallow_untyped_calls = true
disallow_untyped_defs = true
error_summary = true
incremental = false
no_implicit_optional = true
python_version = "3.9"
show_error_code_links = true
show_error_codes = true
strict = true
warn_redundant_casts = true
warn_return_any = true
warn_unused_configs = true

[tool.pylint.IMPORTS]
preferred-modules = ["py:pathlib", "unittest:pytest"]

[tool.pylint.MASTER]
# Ignore as being generated:
ignore-paths = "^(src/.*/_version|.config/).*$"

[tool.pylint."MESSAGES CONTROL"]
disable = [
  # Disabled on purpose:
  "line-too-long", # covered by black
  "protected-access", # covered by ruff SLF001
  "redefined-builtin", # covered by ruff
  "too-many-branches", # covered by ruff C901
  "unused-argument", # covered vby ruff
  "wrong-import-order", # covered by ruff
  # TODO(ssbarnea): remove temporary skips adding during initial adoption:
  "duplicate-code",
  # unable to disable it inside tests
  # https://github.com/PyCQA/pylint/issues/850
  "cyclic-import",
  # https://github.com/PyCQA/pylint/issues/8453
  "preferred-module"
]
enable = [
  "useless-suppression" # Identify unneeded pylint disable statements
]
# increase from default is 50 which is too aggressive
max-statements = 60

[tool.pylint.REPORTING]
output-format = "colorized"

[tool.pylint.SUMMARY]
# We don't need the score spamming console, as we either pass or fail
score = "n"

[tool.pyright]
pythonVersion = "3.9"

[tool.pytest.ini_options]
addopts = ["--strict-config", "--strict-markers", "-p", "no:pytest_cov", "--durations=10", "--durations-min=1.0", "--failed-first", "--instafail"]
filterwarnings = [
  "ignore:No data was collected:coverage.exceptions.CoverageWarning"
]
testpaths = ["test"]

[tool.ruff]
cache-dir = "./.cache/.ruff"
fix = true
# Same as Black.
line-length = 88
preview = true
target-version = "py39"

[tool.ruff.lint]
ignore = [
  "COM812", # conflicts with ISC001 on format
  "CPY001", # missing-copyright-notice
  "D203", # incompatible with D211
  "D213", # incompatible with D212
  "E501", # we use black
  "ERA001", # auto-removal of commented out code affects development and vscode integration
  "INP001", # "is part of an implicit namespace package", all false positives
  "ISC001", # conflicts with COM812 on format
  "PLW2901", # PLW2901: Redefined loop variable
  "RET504", # Unnecessary variable assignment before `return` statement
  # temporary disabled until we fix them:
  "ANN",
  "PLR",
  "ASYNC230"
]
select = ["ALL"]

[tool.ruff.lint.isort]
known-first-party = ["src"]

[tool.ruff.lint.per-file-ignores]
"test/*.py" = ["S", "T201"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.setuptools.dynamic]
dependencies = {file = [".config/requirements.in"]}
optional-dependencies.docs = {file = [".config/requirements-docs.in"]}
optional-dependencies.test = {file = [".config/requirements-test.in"]}

[tool.setuptools_scm]
# To prevent accidental pick of mobile version tags such 'v6'
git_describe_command = [
  "git",
  "describe",
  "--dirty",
  "--long",
  "--tags",
  "--match",
  "v*.*"
]
local_scheme = "no-local-version"
tag_regex = "^(?P<prefix>v)?(?P<version>[0-9.]+)(?P<suffix>.*)?$"
write_to = "src/subprocess_tee/_version.py"

[tool.tomlsort]
in_place = true
sort_inline_tables = true
sort_table_keys = true

[tool.uv.pip]
annotation-style = "line"
custom-compile-command = "tox run -e deps"
no-emit-package = [
  "ansible-core",
  "pip",
  "resolvelib",
  "setuptools",
  "subprocess-tee",
  "tox-extra",
  "tox-uv",
  "tox",
  "types-pyyaml",
  "typing-extensions",
  "uv",
  "virtualenv"
]

[tool.vulture]
exclude = [
  ".eggs",
  ".tox",
  "build",
  "venv",
  "src/subprocess_tee/_version.py",
  "src/subprocess_tee/_types.py"
]
paths = ["src", "test"]