ruff.toml

# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "site-packages",
    "venv",
    "env",
]

# Same as Black.
line-length = 88
indent-width = 4

# Assume Python 3.11
target-version = "py311"

[lint]
select = [
    # https://docs.astral.sh/ruff/rules/#error-e
    "E",
    # https://docs.astral.sh/ruff/rules/#pyflakes-f
    "F",
    # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
    "SIM",
    # https://docs.astral.sh/ruff/rules/#perflint-perf
    "PERF",
    # https://docs.astral.sh/ruff/rules/#refurb-furb
    "FURB",
    # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
    "B006",
    "B010",
    "B904",
    # https://docs.astral.sh/ruff/rules/#pep8-naming-n
    "N",
]
ignore = [
    # Whitespace before ':' (conflicts with Black)
    "E203",
    # Two spaces before inline comment
    "E261",
    # Line too long
    "E501",
    # Do not assign a lambda expression
    "E731",
    # Name may be undefined from '*' import
    "F405",
    # Local variable is assigned but never used
    "F841",
    # Ambiguous variable name
    "E741",
    # Use a single `with` statement with multiple contexts instead of nested `with` statements
    "SIM117",
    # Checks for nested if statements that can be collapsed into a single if statement.
    "SIM102",
    # Variables in function scope should be lower-case
    "N806",
    # Variables in class scope should not be mixed-case
    "N815",
    # Exception name should be named with Error suffix
    "N818",
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

# Ad hoc exceptions
[lint.pep8-naming]
ignore-names = [
    # N801
    "eHerkenning*", "eSuite*", "BRP_[0-9]_[0-9]",
    # N802
    "*setUp*", "tearDown*", "*assert*",
    "*TimelineLog*", "innNnpId",
]