cache-dir = "~/.cache/ruff"
indent-width = 4
line-length = 79
target-version = "py310"
namespace-packages = ["tests"]


[lint]
select = ["ALL"]
ignore = [
    "BLE001",
    "COM812",
    "D2",
    "D4",
    "EM101",  # Exception must not use a string literal, assign to variable first
    "EM102",  # Exception must not use an f-string literal, assign to variable first
    "INP001",
    "S101",
    "S324",
    "T201",
    "TRY003",
]

# ARG005 - Unused lambda argument: `args`
# BLE001 - Do not catch blind exception: `Exception`
# D101 - Missing docstring in public class
# D102 - Missing docstring in public method
# E721 - Use `is` and `is not` for type comparisons, or `isinstance()` for isinstance checks
# ERA001 - Found commented-out code
# INP001 - File `beinc_weechat.py` is part of an implicit namespace package. Add an `__init__.py`
# PT008 - Use `return_value=` instead of patching with `lambda`
# PLR2004 - Magic value used in comparison, consider replacing `200` with a constant variable
# S101 - Use of `assert` detected
# S324 - Probable use of insecure hash functions in `hashlib`: `md5`
# T201 - `print` found
# TRY003 - Avoid specifying long messages outside the exception class
# TRY300 - Consider moving this statement to an `else` block

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

# custom settings
[lint.per-file-ignores]
"src/otp2289/generator.py" = ["ERA001"]  # commented example code from RFC 2289
# "tests/test_main.py" = ["ARG005", "E721", "PT008"]


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

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

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

# 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 = false

# 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"

[lint.flake8-quotes]
inline-quotes = "single"