pyproject.toml

[build-system]
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.1"]
build-backend = "poetry_dynamic_versioning.backend"

[tool.poetry-dynamic-versioning]
enable = true
vcs = "git"
style = "semver"

[tool.poetry]
name = "cyclopts"
version = "0.0.0"  # Do not change, let poetry-dynamic-versioning handle it.
homepage = "https://github.com/BrianPugh/cyclopts"
repository = "https://github.com/BrianPugh/cyclopts"
license = "Apache-2.0"
description = ""
authors = ["Brian Pugh"]
readme = "README.md"
packages = [{include = "cyclopts"}]
include = ["cyclopts/*.so", "cyclopts/*.pyd"]  # Compiled extensions

[tool.poetry.build]
generate-setup-file = false

[tool.poetry.scripts]

[tool.poetry.dependencies]
# Be as loose as possible if writing a library.
python = ">=3.9"
typing-extensions = { version = ">=4.8.0", python = "<3.11" }
importlib-metadata = { version = ">=4.4", python = '<3.10' }
attrs = ">=23.1.0"
rich = ">=13.6.0"
docstring-parser = {version=">=0.15", python = "<4.0"}
rich-rst = "^1.3.1"
tomli = {version = ">=2.0.0", python = "<3.11", optional = true}
pyyaml = {version = ">=6.0.1", optional = true}

[tool.poetry.group.docs.dependencies]
sphinx = "~7.4.7"
sphinx_rtd_theme = ">=3.0.0,<4.0.0"
gitpython = ">=3.1.31"
sphinx-copybutton = "^0.5"
myst-parser = {extras = ["linkify"], version = "^3.0.1"}
sphinx-autodoc-typehints = ">=1.25.2,<3.0.0"
sphinx-rtd-dark-mode = "^1.3.0"

[tool.poetry.group.dev.dependencies]
coverage = {extras = ["toml"], version = ">=5.1"}
pre_commit = ">=2.16.0"
pytest = ">=7.1.2"
pytest-cov = ">=3.0.0"
pytest-mock = ">=3.7.0"
pydantic = "^2.7.0"
toml = "^0.10.2"
pyyaml = ">=6.0.1"

[tool.poetry.group.debug]
optional = true

[tool.poetry.group.debug.dependencies]
ipdb = ">=0.13.9"
line_profiler = ">=3.5.1"

[tool.poetry.extras]
toml = ["tomli"]
yaml = ["pyyaml"]

[tool.coverage.run]
branch = true
omit = [
    "tests/*",
]

[tool.coverage.report]
exclude_lines = [
    # Have to re-enable the standard pragma
    "pragma: no cover",

    # Don't complain about missing debug-only code:
    "def __repr__",
    "if self.debug:",
    "if debug:",
    "if DEBUG:",

    # Don't complain if tests don't hit defensive assertion code:
    "raise AssertionError",
    "raise NotImplementedError",
    "raise TypeError",

    # Don't complain if non-runnable code isn't run:
    "if 0:",
    "if False:",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",

    "if sys.version_info < (3, 10):",
    "if sys.version_info >= (3, 10):",
    "from typing import Annotated",
    "except ImportError:",
]

omit = [
    "cyclopts/protocols.py"
]

[tool.pyright]
venvPath = "."
venv = ".venv"
ignore = ["docs/", "tests/test_py3*.py"]

[tool.ruff]
target-version = 'py38'
line-length = 120
exclude = [
    "migrations",
    "__pycache__",
    "manage.py",
    "settings.py",
    "env",
    ".env",
    "venv",
    ".venv",
]

[tool.ruff.format]
docstring-code-format = true

[tool.ruff.lint]
select = [
    "B",  # flake8-bugbear
    "C4", # flake8-comprehensions
    "D",  # pydocstyle
    "E",  # Error
    "F",  # pyflakes
    "I",  # isort
    "N",  # pep8-naming
    "PGH",  # pygrep-hooks
    "PTH", # flake8-use-pathlib
    "Q",  # flake8-quotes
    "TRY",  # tryceratops
    "UP",  # pyupgrade
    "W",  # Warning
    "YTT", # flake8-2020
]

ignore = [
    "B905",  # zip strict=True; remove once python <3.10 support is dropped.
    "D100",
    "D101",
    "D102",
    "D103",
    "D104",
    "D105",
    "D106",
    "D107",
    "D200",
    "D401",
    "E402",
    "E501",
    "PGH003",  # Use specific rule codes when ignoring type issues
    "TRY003",  # Avoid specifying messages outside exception class; overly strict, especially for ValueError
    "TRY300",  # Consider moving this statement to an `else` block
]

[tool.ruff.lint.flake8-bugbear]
extend-immutable-calls = [
    "chr",
    "typer.Argument",
    "typer.Option",
]

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

[tool.ruff.lint.per-file-ignores]
"tests/*.py" = [
    "D100",
    "D101",
    "D102",
    "D103",
    "D104",
    "D105",
    "D106",
    "D107",
    "D205",
    "D404",
    "S102",  # use of "exec"
    "S106",  # possible hardcoded password.
    "PGH001",  # use of "eval"
]
"docs/*.py" = [
    "F811",  # redefinition
]
"cyclopts/config/*.py" = [
    "PTH123",  # `open()` should be replaced by `Path.open()`. Pyright doesn't understand that it must be a Path.
]

[tool.ruff.lint.pep8-naming]
staticmethod-decorators = [
    "pydantic.validator",
    "pydantic.root_validator",
]

[tool.codespell]
skip = 'poetry.lock,'

[tool.creosote]
venvs=[".venv"]
paths=["cyclopts"]
deps-file="pyproject.toml"
sections=["tool.poetry.dependencies"]
exclude-deps =[
  "importlib-metadata",
  "typing-extensions",
  "docstring-parser",  # Not detected due to deferred import.
  "rich-rst",  # Not detected due to deferred import.
  "rich",  # Not detected due to deferred import.
  "tomli",  # Not detected due to optional feature.
]