ruff.toml

# Same as Black.
line-length = 100
indent-width = 4
target-version = "py311"

[lint]
preview = true
select = ["A", "E3", "E4", "E5", "E7", "E9", "F", "UP", "B", "S", "I", "N", "C90", "C4", "BLE"]
#select = ["ALL"]
ignore = [
    "CPY001", # Missing copyright notice at top of file
    "D100", # Missing docstring in public module
    "D101", # Missing docstring in public class
    "D102", # Missing docstring in public method
    "D103", # Missing docstring in public function
    "D104", # Missing docstring in public package
    "D105", # Missing docstring in magic method
    "D106", # Missing docstring in public nested class
    "D107", # Missing docstring in __init__
    "D202", # No blank lines allowed after function docstring (found {num_lines})
    "D203", # 1 blank line required before class docstring
    "D210", # No whitespaces allowed surrounding docstring text
    "D211", # No blank lines allowed before class docstring
    "D212", # Multi-line docstring summary should start at the first line
    "D407", # Missing dashed underline after section ("{name}")
    "D413", # Missing blank line after last section ("{name}")
    "D401", # First line of docstring should be in imperative mood: "{first_line}"
    "D400", # First line should end with a period
    "D415", # First line should end with a period, question mark, or exclamation point
    "ERA001", # Found commented out code
    "G004", # Logging statement uses f-string
    "PGH003", # Use specific rule codes when ignoring type issues
    "RUF012", # Mutable class attributes should be annotated with typing.ClassVar
    "S101", # Use of assert in pytest
    "T201", # print found
    "T203", # pprint found
    "TRY301", # Abstract raise to an inner function
    "TRY400", # Use logging.exception instead of logging.error
    "UP007", # Use X | Y for type annotations
    "S105", # Possible hardcoded password assigned to: "password"

]

# 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]+?))$"

[format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = true

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"