Skip to content

[3.13] Lint: Create a project-wide .ruff.toml settings file (GH-133124) #137670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 3.13
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .ruff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Default settings for Ruff in CPython

# PYTHON_FOR_REGEN
target-version = "py310"

# PEP 8
line-length = 79

# Enable automatic fixes by default.
# To override this, use ``fix = false`` in a subdirectory's config file
# or ``--no-fix`` on the command line.
fix = true
5 changes: 2 additions & 3 deletions Doc/.ruff.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
extend = "../.ruff.toml" # Inherit the project-wide settings

target-version = "py312" # Align with the version in oldest_supported_sphinx
fix = true
output-format = "full"
line-length = 79
extend-exclude = [
"includes/*",
# Temporary exclusions:
Expand Down
4 changes: 3 additions & 1 deletion Lib/test/.ruff.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
fix = true
extend = "../../.ruff.toml" # Inherit the project-wide settings

target-version = "py312"

extend-exclude = [
# Excluded (run with the other AC files in its own separate ruff job in pre-commit)
"test_clinic.py",
Expand Down
1 change: 1 addition & 0 deletions Tools/build/.ruff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
extend = "../../.ruff.toml" # Inherit the project-wide settings
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include the other stuff from main?

https://github.com/python/cpython/blob/main/Tools/build/.ruff.toml

Suggested change
extend = "../../.ruff.toml" # Inherit the project-wide settings
extend = "../../.ruff.toml" # Inherit the project-wide settings
[per-file-target-version]
"deepfreeze.py" = "py311" # requires `code.co_exceptiontable`
"stable_abi.py" = "py311" # requires 'tomllib'
[format]
preview = true
docstring-code-format = true
[lint]
select = [
"C4", # flake8-comprehensions
"E", # pycodestyle
"F", # pyflakes
"I", # isort
"ISC", # flake8-implicit-str-concat
"LOG", # flake8-logging
"PGH", # pygrep-hooks
"PT", # flake8-pytest-style
"PYI", # flake8-pyi
"RUF100", # Ban unused `# noqa` comments
"UP", # pyupgrade
"W", # pycodestyle
"YTT", # flake8-2020
]
ignore = [
"E501", # Line too long
"F541", # f-string without any placeholders
"PYI024", # Use `typing.NamedTuple` instead of `collections.namedtuple`
"PYI025", # Use `from collections.abc import Set as AbstractSet`
"UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
]
[lint.per-file-ignores]
"{check_extension_modules,freeze_modules}.py" = [
"UP031", # Use format specifiers instead of percent format
]
"generate_{re_casefix,sre_constants,token}.py" = [
"UP031", # Use format specifiers instead of percent format
]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, maybe. I just wanted to keep the backport atomic and as close as possible to the specific PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We haven't backported Tools/build/.ruff.toml previously, I would suggest @webknjaz you just delete it from this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could do that or actually look into backporting the rest in a follow-up.

3 changes: 1 addition & 2 deletions Tools/clinic/.ruff.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
target-version = "py310"
fix = true
extend = "../../.ruff.toml" # Inherit the project-wide settings

[lint]
select = [
Expand Down
Loading