Safe-Synthesizer/ruff.toml at main · NVIDIA-NeMo/Safe-Synthesizer · 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# 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",
    "**/*.ipynb",
]

# Lint floor = minimum supported Python (requires-python >=3.11), not the
# 3.13 dev default. Keeps pyupgrade (UP006/UP007/UP035) from rewriting code
# into 3.12+/3.13-only syntax that would break the 3.11 CI leg.
target-version = "py311"
line-length = 120
indent-width = 4

[lint]
select = [
    # pycodestyle
    "E4", # import errors
    "E7", # statement errors
    "E9", # runtime errors
    # pyflakes
    "F",
    # whitespace
    "W291", # trailing whitespace
    "W292", # no newline at end of file
    "W293", # whitespace before comment
    # isort
    "I001", # unsorted imports
    "I002", # missing required import
    # pyupgrade -- modern Python 3.11+ syntax
    "UP006", # use builtin generics (list, dict, set, tuple)
    "UP007", # use X | Y for unions and optionals
    "UP035", # deprecated typing imports (List, Dict, Optional, Union, etc.)
    # flake8-future-annotations
    "FA100", # missing `from __future__ import annotations`
    # flake8-bugbear
    "B006", # mutable default argument
    # flake8-print
    "T201", # print() found
    # pydocstyle -- docstring formatting (convention=google below)
    "D200", # single-line docstring should fit on one line
    "D201", # no blank line before docstring
    "D202", # no blank line after docstring
    "D209", # closing quotes on separate line
    "D210", # no whitespace surrounding docstring text
    "D300", # use triple double quotes
    "D301", # use r"" for backslashes
    "D403", # capitalize first word
    "D410", # blank line after section
    "D411", # blank line before section
    "D414", # empty docstring section
    "D419", # empty docstring
]
ignore = []

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

[lint.pydocstyle]
convention = "google"

[lint.per-file-ignores]
"tests/**" = ["T201"] # print() is fine in tests
"tools/**" = ["T201"] # print() is fine in tooling scripts
"script/**" = ["T201"] # print() is fine in standalone scripts

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