pyproject.toml

# --- build-system -----------------------------------------------------------
# ref: https://packaging.python.org/en/latest/tutorials/packaging-projects/
# these should match the "setup-requires" packages in `setup.cfg`
[build-system]
requires = [
  "artifacts-keyring",
  "build",
  "keyring",
  "setuptools>=42",
  "twine",
]
build-backend = "setuptools.build_meta"

# --- black ------------------------------------------------------------------
# ref: https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
[tool.black]
line-length = 100
# target-version = ['py39']
include = '\.pyi?$|\.ipynb$'
extend-exclude = '''
# # A regex preceded with ^/ will apply only to files and directories
# # in the root of the project.
# ^/foo.py  # exclude a file named foo.py in the root of the project (in addition to the defaults)
\.ipynb_checkpoints$|^/\.env|^/\.git|^/\.nox|^/\.pytest_cache|^/\.tox
'''

# --- ruff -------------------------------------------------------------------
[tool.ruff]
select = [
  'A', # flake8 builtins
  'B', # flake8 bugbear
  'C4', # flake8 comprehensions
  'C90', # mccabe
  'D', # pydocstyle
  'E', # pycodestyle
  'F', # pyflakes
  'I', # isort
  'N', # pep8-naming
  # 'PTH', # flake8-use-pathlib
  'Q',  # flake8-quotes
  'S',  # bandit
  'SIM',  # flake8-simplify
  'TRY',  # tryceratops
  'W', # pycodestyle
  # 'T20', # flake8 print
]

# Avoid trying to fix extension types:
unfixable = ["B"]

ignore = [
  "B905",  # zip strict=True; remove once python <3.10 support is dropped.
  # "E203", # not in ruff
  # "E265", # not in ruff
  # "E266", # not in ruff
  "E501", # line too long
  "F401", # unused import
  "F403", # import *
  "F405", # defined from import *
  # "F541", # f-string missing placeholders
  "S101", # assert
  "SIM105", # allow except: pass
  "TRY003", # Avoid specifying messages outside exception class; overly strict, especially for ValueError
  "TRY201", # Allow raise without exception name (align with Sonarlint)
  # "W503", # not in ruff
]

[per-file-ignores]
# # Ignore `E402` (import violations) in all `__init__.py` files,
# # and in `path/to/file.py`.
# "__init__.py" = ["E402"]
# "path/to/file.py" = ["E402"]
"notebooks/*" = ["D"]

exclude = [
  "*.egg-info",
  ".direnv",
  ".eggs",
  ".env",
  ".envrc",
  ".git",
  ".ipynb_checkpoints",
  ".nox",
  ".pytest_cache",
  ".ruff_cache",
  ".tox",
  ".venv",
  "__pypackages__",
  "_build",
  "ci/templates",
  "build",
  "dist",
  "docs/conf.py",
  "venv",
]

# Default autofix behavior
fix = true

# Max line length
line-length = 119

# Directories with source code
src = ["notebooks", "src", "tests"]

# Assumed Python version
target-version = "py39"

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

[tool.ruff.isort]
combine-as-imports = true
force-sort-within-sections = true
force-wrap-aliases = true
# extra-standard-library = ["path"]
known-first-party = ["ds_utils","src",]

[tool.ruff.mccabe]
max-complexity = 18

[tool.ruff.pep8-naming]
ignore-names = []

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

# --- pytest -----------------------------------------------------------------
# ref: https://docs.pytest.org/en/6.2.x/customize.html
[tool.pytest.ini_options]
addopts = '''
    -ra
    --strict-markers
    --ignore=docs/conf.py
    --ignore=setup.py
    --ignore=ci
    --ignore=.eggs
    --tb=short
'''
    # --doctest-modules
    # --doctest-glob=\*.rst
norecursedirs = [
    ".env",
    ".git",
    ".nox",
    ".pytest_cache",
    ".tox",
    "__pycache__",
    "dist",
    "docs",
    "build",
    "migrations",
    "notebooks",
    "writeup",
]
python_files = [
    "test_*.py",
    "*_test.py",
    "tests.py",
]
testpaths = [
    "tests",
]
# log_cli = true


# --- coverage ---------------------------------------------------------------
[tool.coverage.paths]
source = ["src", "*/site-packages"]

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

[tool.coverage.report]
show_missing = true

# --- check-manifest ---------------------------------------------------------
# ref: https://github.com/mgedmin/check-manifest
[tool.check-manifest]
ignore = [
    ".ci/",
    "data/",
    "docker/",
    "functions/",
    "notebooks/",
    "queries/",
    "writeup/",
    "noxfile.py",
    "*.md",
    ".*",
]