pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = [
    "setuptools>=61.2",
    "setuptools_scm",
]

[project]
authors = [{name = "Common Partial Wave Analysis", email = "compwa-admin@ep1.rub.de"}]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Education",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: Apache Software License",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.7",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Scientific/Engineering",
    "Typing :: Typed",
]
dependencies = [
    "PyYAML",
    "attrs >=20.1.0", # on_setattr and https://www.attrs.org/en/stable/api.html#next-gen
    "jsonschema",
    "particle",
    "tqdm >=4.24.0", # autonotebook
    'python-constraint2; python_version >="3.8.0"',
    'python-constraint; python_version <"3.8.0"',
    'typing-extensions; python_version <"3.8.0"', # Literal, Protocol
]
description = "Rule-based particle reaction problem solver on a quantum number level"
dynamic = ["version"]
keywords = [
    "HEP",
    "PWA",
    "amplitude analysis",
    "partial wave analysis",
    "particle physics",
    "particles",
    "physics",
]
license = {file = "LICENSE"}
maintainers = [{email = "compwa-admin@ep1.rub.de"}]
name = "qrules"
requires-python = ">=3.7"

[project.optional-dependencies]
all = [
    "qrules[viz]",
]
dev = [
    "qrules[all]",
    "qrules[doc]",
    "qrules[jupyter]",
    "qrules[sty]",
    "qrules[test]",
    "sphinx-autobuild",
    "tox >=1.9", # for skip_install, use_develop
]
doc = [
    "Sphinx >=3",
    "myst-nb", # nb_ configuration prefixes
    "qrules[viz]",
    "sphinx-book-theme",
    "sphinx-codeautolink[ipython]",
    "sphinx-comments",
    "sphinx-copybutton",
    "sphinx-design",
    "sphinx-hep-pdgref",
    "sphinx-thebe",
    "sphinx-togglebutton",
    "sphinxcontrib-bibtex >=2",
    'sphinx-api-relink >=0.0.4',
    'sphinx-pybtex-etal-style',
]
jupyter = [
    "ipywidgets",
    "jupyterlab",
    "jupyterlab-code-formatter >=3.0.0",
    "jupyterlab-lsp",
    "python-lsp-server[rope]",
    'jupyterlab-git',
    'jupyterlab-myst',
    'python-lsp-ruff',
]
sty = [
    "mypy >=0.730", # attrs and error code support
    "pre-commit >=1.4.0",
    "qrules[types]",
    'ruff',
]
test = [
    "ipython",
    "nbmake",
    "pydot <2", # problem with pydot.graph_from_dot_data
    "pytest",
    "pytest-cov",
    "pytest-profiling",
    "pytest-xdist",
    'importlib-metadata; python_version <"3.8.0"',
    'nbmake <1.3; python_version=="3.7.*"',
]
types = [
    "ipython",
    "pydot <2", # problem with pydot.graph_from_dot_data
    "pytest",
    "types-PyYAML",
    "types-setuptools",
    'sphinx-api-relink >=0.0.4',
]
viz = [
    "graphviz",
]

[project.readme]
content-type = "text/markdown"
file = "README.md"

[project.urls]
Changelog = "https://github.com/ComPWA/qrules/releases"
Documentation = "https://qrules.rtfd.io"
Source = "https://github.com/ComPWA/qrules"
Tracker = "https://github.com/ComPWA/qrules/issues"

[tool.setuptools]
include-package-data = false
package-dir = {"" = "src"}

[tool.setuptools.package-data]
qrules = [
    "additional_definitions.yml",
    "particle-validation.json",
    "py.typed",
]

[tool.setuptools.packages.find]
namespaces = false
where = ["src"]

[tool.setuptools_scm]
local_scheme = "no-local-version"
version_scheme = "post-release"
write_to = "src/qrules/version.py"

[tool.coverage.run]
branch = true
source = ["src"]

[tool.mypy]
disallow_incomplete_defs = true
disallow_untyped_defs = true
exclude = "_build"
show_error_codes = true
warn_unused_configs = true

[[tool.mypy.overrides]]
check_untyped_defs = true
disallow_incomplete_defs = false
disallow_untyped_defs = false
module = ["tests.*"]

[[tool.mypy.overrides]]
ignore_errors = true
module = ["typings.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["IPython.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["constraint.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["jsonschema.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["particle.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["pybtex.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["pydot.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["sphinx.*"]

[[tool.mypy.overrides]]
ignore_missing_imports = true
module = ["tqdm.*"]

[tool.pixi.project]
channels = ["conda-forge"]
platforms = ["linux-64"]

[tool.pixi.activation.env]
PRETTIER_LEGACY_CLI = "1"

[tool.pixi.dependencies]
graphviz = "*"
python = "3.9.*"

[tool.pixi.environments]
default = {features = [
    "all",
    "dev",
    "doc",
    "jupyter",
    "sty",
    "test",
    "types",
    "viz",
]}

[tool.pixi.feature.dev.tasks.ci]
depends_on = ["cov", "docnb", "linkcheck", "sty"]

[tool.pixi.feature.dev.tasks.cov]
cmd = """
pytest tests/unit \
    --cov-fail-under=90 \
    --cov-report=html \
    --cov-report=xml \
    --cov=qrules
"""

[tool.pixi.feature.dev.tasks.doc]
cmd = """
sphinx-build \
    --builder html \
    --keep-going \
    --show-traceback --fail-on-warning \
    docs/ docs/_build/html
"""
env = {FORCE_COLOR = "yes"}

[tool.pixi.feature.dev.tasks.doclive]
cmd = """
sphinx-autobuild \
    --builder html \
    --open-browser \
    --re-ignore '.*/__pycache__/.*' \
    --re-ignore '.*/.ipynb_checkpoints/.*' \
    --re-ignore '.*\\.tmp' \
    --re-ignore 'docs/_build/.*' \
    --re-ignore 'docs/_images/.*' \
    --re-ignore 'docs/_static/logo\\..*' \
    --re-ignore 'docs/.*\\.csv' \
    --re-ignore 'docs/.*\\.gv' \
    --re-ignore 'docs/.*\\.inv' \
    --re-ignore 'docs/.*\\.json' \
    --re-ignore 'docs/.*\\.pickle' \
    --re-ignore 'docs/.*\\.yaml' \
    --re-ignore 'docs/.*\\.yml' \
    --re-ignore 'docs/api/.*' \
    --watch docs \
    --watch src \
    docs/ docs/_build/html
"""
env = {FORCE_COLOR = "yes"}

[tool.pixi.feature.dev.tasks.docnb]
cmd = "pixi run doc"
env = {EXECUTE_NB = "yes", FORCE_COLOR = "yes"}

[tool.pixi.feature.dev.tasks.docnb-force]
cmd = "pixi run doc"
env = {FORCE_COLOR = "yes", FORCE_EXECUTE_NB = "yes", PYTHONHASHSEED = "0"}

[tool.pixi.feature.dev.tasks.docnblive]
cmd = "pixi run doclive"
env = {EXECUTE_NB = "yes", FORCE_COLOR = "yes", PYTHONHASHSEED = "0"}

[tool.pixi.feature.dev.tasks.linkcheck]
cmd = """
sphinx-build \
    --builder linkcheck \
    --show-traceback \
    docs/ docs/_build/linkcheck
"""
env = {FORCE_COLOR = "yes"}

[tool.pixi.feature.dev.tasks.nb]
cmd = "pytest --nbmake docs"

[tool.pixi.feature.dev.tasks.pydeps]
cmd = """
pydeps qrules \
    -o ../module_structure.svg \
    --exclude *._* \
    --max-bacon=1 \
    --noshow
"""

[tool.pixi.feature.dev.tasks.sty]
cmd = "pre-commit run  -a"
env = {SKIP = "pyright"}

[tool.pixi.feature.dev.tasks.test]
cmd = """
pytest  \
    --cov-fail-under=90 \
    --cov-report=html \
    --cov-report=xml \
    --cov=qrules
"""

[tool.pixi.feature.dev.tasks.tests]
cmd = "pytest src tests/unit"

[tool.pixi.pypi-dependencies]
qrules = {path = ".", editable = true}

[tool.pyright]
exclude = [
    "**/.git",
    "**/.ipynb_checkpoints",
    "**/.mypy_cache",
    "**/.pytest_cache",
    "**/.tox",
    "**/__pycache__",
    "**/_build",
]
reportArgumentType = false
reportAssignmentType = false
reportAttributeAccessIssue = false
reportCallIssue = false
reportGeneralTypeIssues = false
reportIncompatibleMethodOverride = false
reportIndexIssue = false
reportInvalidTypeArguments = false
reportMissingParameterType = false
reportMissingTypeArgument = false
reportMissingTypeStubs = false
reportOperatorIssue = false
reportOverlappingOverload = false
reportPrivateImportUsage = false
reportPrivateUsage = false
reportReturnType = false
reportUnboundVariable = false
reportUnknownArgumentType = false
reportUnknownLambdaType = false
reportUnknownMemberType = false
reportUnknownParameterType = false
reportUnknownVariableType = false
reportUnnecessaryComparison = false
reportUnnecessaryContains = false
reportUnnecessaryIsInstance = false
reportUntypedFunctionDecorator = false
reportUnusedClass = true
reportUnusedFunction = true
reportUnusedImport = true
reportUnusedVariable = true
typeCheckingMode = "strict"

[tool.pytest.ini_options]
addopts = [
    "--color=yes",
    "--doctest-continue-on-failure",
    "--doctest-modules",
    "--durations=3",
    "--ignore=docs/abbreviate_signature.py",
    "--ignore=docs/conf.py",
]
filterwarnings = [
    "error",
    "ignore: The `hash` argument is deprecated in favor of `unsafe_hash` and will be removed in or after August 2025.:DeprecationWarning",
    "ignore:'importlib.abc.Traversable' is deprecated and slated for removal in Python 3.14:DeprecationWarning",
    "ignore:Passing a schema to Validator.iter_errors is deprecated.*:DeprecationWarning",
    "ignore:datetime.datetime.utcfromtimestamp\\(\\) is deprecated and scheduled for removal in a future version.*:DeprecationWarning",
    "ignore:unclosed .*:ResourceWarning",
]
markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]
norecursedirs = [
    ".ipynb_checkpoints",
    ".virtual_documents",
    "_build",
]
testpaths = [
    "docs",
    "src",
    "tests",
]

[tool.ruff]
extend-exclude = ["typings"]
extend-include = ["*.ipynb"]
preview = true
show-fixes = true
src = [
    "src",
    "tests",
]

[tool.ruff.format]
docstring-code-format = true
line-ending = "lf"

[tool.ruff.lint]
ignore = [
    "ANN401",
    "COM812",
    "CPY001",
    "D101",
    "D102",
    "D103",
    "D105",
    "D107",
    "D203",
    "D213",
    "D407",
    "D416",
    "DOC",
    "E501",
    "FBT00",
    "FURB101",
    "FURB103",
    "FURB140",
    "G004",
    "ISC001",
    "PLR0913",
    "PLR2004",
    "PLR5501",
    "PLW1514",
    "PLW2901",
    "PT001",
    "PTH",
    "SIM108",
]
select = ["ALL"]
task-tags = ["cspell"]

[tool.ruff.lint.flake8-builtins]
builtins-ignorelist = ["display"]

[tool.ruff.lint.flake8-comprehensions]
allow-dict-calls-with-keyword-arguments = true

[tool.ruff.lint.flake8-tidy-imports]
ban-relative-imports = "all"

[tool.ruff.lint.isort]
split-on-trailing-comma = false

[tool.ruff.lint.per-file-ignores]
"*.ipynb" = [
    "ANN",
    "B018",
    "C90",
    "D",
    "E303",
    "E402",
    "E703",
    "N806",
    "N816",
    "PLR09",
    "PLW0602",
    "PLW0603",
    "S101",
    "T20",
    "TCH00",
]
"docs/*" = [
    "E402",
    "INP001",
    "S101",
    "S113",
    "T201",
]
"docs/_extend_docstrings.py" = [
    "A002",
    "PLC0415",
]
"docs/conf.py" = [
    "A001",
    "D100",
    "FLY002",
]
"setup.py" = ["D100"]
"src/qrules/conservation_rules.py" = ["FA100"]
"tests/*" = [
    "ANN",
    "D",
    "INP001",
    "PGH001",
    "PLC2701",
    "PLR6301",
    "S101",
    "S307",
    "SLF001",
    "T20",
]

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

[tool.ruff.lint.pylint]
allow-dunder-method-names = ["_repr_pretty_"]

[tool.tomlsort]
all = false
ignore_case = true
in_place = true
sort_first = [
    "build-system",
    "project",
    "tool.setuptools",
    "tool.setuptools_scm",
]
spaces_indent_inline_array = 4
trailing_comma_inline_array = true