Skip to content

Development: introduce Ruff as linter/formatter #3039

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.

Sign up for GitHub

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

Merged
dgtlmoon merged 6 commits into from
Apr 18, 2025
Merged

Development: introduce Ruff as linter/formatter #3039

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
345ad47
add: ignore `.python-version` created by pyenv
xLinkOut Mar 21, 2025
d734c7d
add(dep): Ruff as dependency
xLinkOut Mar 21, 2025
687b695
new(ruff): Ruff configuration file
xLinkOut Mar 21, 2025
86ab7de
chg(ruff): assume python 3.10 as minimum supported version
xLinkOut Mar 22, 2025
31733ab
new: pre-commit hook that use Ruff to lint and format
xLinkOut Mar 22, 2025
9423af7
chg(actions): use ruff for linting
xLinkOut Mar 22, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ dist/
.env
.venv/
venv/
.python-version

# IDEs
.idea
Expand Down
48 changes: 48 additions & 0 deletions .ruff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Assume Python 3.11
target-version = "py311"

@dgtlmoon dgtlmoon Mar 21, 2025

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

we actually test and support 3.10/3.11 and 3.12, so that needs to be taken into account (so the github build workflow, maybe it can be integrated there somehow?)

@xLinkOut xLinkOut Mar 22, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I assumed that the lower supported version was 3.11. I'll change that config to py310, so Ruff know which upgrade suggestions can be safely applied.


# Formatting options
line-length = 100
indent-width = 4

exclude = [
"__pycache__",
".eggs",
".git",
".tox",
".venv",
"*.egg-info",
"*.pyc",
]

[lint]
# https://docs.astral.sh/ruff/rules/
select = [
"B", # flake8-bugbear
"B9",
"C",
"E", # pycodestyle
"F", # Pyflakes
"I", # isort
"N", # pep8-naming
"UP", # pyupgrade
"W", # pycodestyle
]
ignore = [
"B007", # unused-loop-control-variable
"B909", # loop-iterator-mutation
"E203", # whitespace-before-punctuation
"E266", # multiple-leading-hashes-for-block-comment
"E501", # redundant-backslash
"F403", # undefined-local-with-import-star
"N802", # invalid-function-name
"N806", # non-lowercase-variable-in-function
"N815", # mixed-case-variable-in-class-scope
]

[lint.mccabe]
max-complexity = 12

[format]
indent-style = "space"
quote-style = "preserve"
2 changes: 2 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,5 @@ pluggy ~= 1.5

# Needed for testing, cross-platform for process and system monitoring
psutil==7.0.0

ruff >= 0.11.2