pyproject.toml

# --- 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.
  "D100", # do not require module-level docstrings
  "D104", # do not require package docstrings
  "D107", # do not require docstrings in __init__ files
  "D205", # don't require linebreak after docstring (ruff vs black conflict)
  # "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
  "N999", # allow "invalid" module names due to jinja templates
  # "S101",  # assert
  "S311",   # allow psuedorandom generators (we use for stats)
  "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
]

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"

[tool.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"]
".ci/*" = ["D"]
"docs/*" = ["D"]
"notebooks/*" = ["B018", "D", "S101"]
"tests/*" = ["D", "S101"]

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

[tool.ruff.isort]
combine-as-imports = true
extra-standard-library = ["yaml"]
# forced-separate = ["scipy", "sklearn", "statsmodels", "torch"]#, "ds_utils", "src"]
force-sort-within-sections = true
force-wrap-aliases = true
# known-first-party = ["ds_utils"]
known-local-folder = ["src"]                                                                                      # for relative imports
section-order = ["standard-library", "third-party", "sci", "torch", "plot", "pmi", "first-party", "local-folder"]

[tool.ruff.isort.sections]
"sci" = ["numpy", "pandas", "scipy", "sklearn", "statsmodels"]
"torch" = ["torch", "tokenizers", "transformers"]
"plot" = ["cmcrameri", "matplotlib", "plotly", "plotnine", "seaborn"]
"pmi" = ["ds_utils", "psm", "recommender"]

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

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

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

# --- pytest -----------------------------------------------------------------
# ref: https://docs.pytest.org/en/7.3.x/reference/customize.html
[tool.pytest.ini_options]
addopts = '''
    -ra
    --strict-markers
    --ignore=docs/conf.py
    --ignore=setup.py
    --ignore=ci
    --ignore=.eggs
    --import-mode=importlib
    --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"]
pythonpath = "src"
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