.ruff.toml

target-version = "py310"
line-length = 120
exclude = [
  ".git,",
  "__pycache__",
  "build",
  "sunkit-image/version.py",
]

[lint]
select = [
  "E",
  "F",
  "W",
  "UP",
  "PT",
  "BLE",
  "A",
  "C4",
  "INP",
  "PIE",
  "T20",
  "RET",
  "TID",
  "PTH",
  "PD",
  "PLC",
  "PLE",
  "FLY",
  "NPY",
  "PERF",
  "RUF",
]
extend-ignore = [
  # pycodestyle (E, W)
  "E501", # ignore line length will use a formatter instead
  # pyupgrade (UP)
  "UP038", # Use | in isinstance - not compatible with models and is slower
  # pytest (PT)
  "PT001", # Always use pytest.fixture()
  "PT023", # Always use () on pytest decorators
  # flake8-pie (PIE)
  "PIE808", # Disallow passing 0 as the first argument to range
  # flake8-use-pathlib (PTH)
  "PTH123", # open() should be replaced by Path.open()
  # Ruff (RUF)
  "RUF003", # Ignore ambiguous quote marks, doesn't allow ' in comments
  "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
  "RUF013", # PEP 484 prohibits implicit `Optional`
  "RUF015", # Prefer `next(iter(...))` over single element slice
]

[lint.per-file-ignores]
"setup.py" = [
  "INP001", # File is part of an implicit namespace package.
]
"conftest.py" = [
  "INP001", # File is part of an implicit namespace package.
]
"docs/conf.py" = [
  "E402" # Module imports not at top of file
]
"docs/*.py" = [
  "INP001", # File is part of an implicit namespace package.
]
"examples/**.py" = [
  "T201", # allow use of print in examples
  "INP001", # File is part of an implicit namespace package.
]
"__init__.py" = [
  "E402", # Module level import not at top of cell
  "F401", # Unused import
  "F403", # from {name} import * used; unable to detect undefined names
  "F405", # {name} may be undefined, or defined from star imports
]
"test_*.py" = [
  "E402", # Module level import not at top of cell
]

[lint.pydocstyle]
convention = "numpy"