netlab/ruff.toml at dev · ipspace/netlab · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# 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",
    # Project-specific exclusions
    "legacy",
    "docs/_build",
    "common.py" # Should be checked if this file is even needed!
]

line-length = 120
indent-width = 2


[lint]
select = [
    "F401", # Module imported but unused
    "F841", # Local variable assigned but never used
    "I",  # import-order (isort)
]

[lint.per-file-ignores]
# Allow re-exports in __init__.py files
"*/__init__.py" = [
    "F401",  # Module imported but unused
    "F403",  # 'from module import *' used
    "E402",  # Module level import not at top of file
]

# Allow print statements in CLI modules and scripts
"netsim/cli/*.py" = ["T201", "T203"]
"netlab" = ["T201", "T203"]
"*.py" = []

# Test files can be more relaxed
"tests/*.py" = [
    "T201",   # print found
    "T203",   # pprint found
    "S101",   # Use of assert detected
    "PLR2004", # Magic value used in comparison
]

# Scripts and setup files
"setup.py" = ["T201", "T203"]
"**/setup.py" = ["T201", "T203"]


[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.
docstring-code-format = false

# Set the line length limit used when formatting code snippets in
# docstrings.
docstring-code-line-length = "dynamic"