Skip to content

Switch from using flake8 to using ruff #431

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

Open
fabi200123 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Switch from using flake8 to using ruff #431

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d74f4cd
Use flake8+ruff for format
fabi200123 May 15, 2026
4bc248c
Format code with Ruff + Flake8
fabi200123 May 18, 2026
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
26 changes: 26 additions & 0 deletions ruff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
line-length = 88
target-version = "py310"

extend-exclude = [
"doc",
"tools",
"*openstack/common*",
"*lib/python*",
"*egg",
]

[lint]
select = ["E", "W", "F"]

ignore = [
Copy link
Copy Markdown
Member

@claudiubelu claudiubelu May 25, 2026

Choose a reason for hiding this comment

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

Should probably add the explanations for these ignores too.

"E251",
"E305",
"E731",
"E117",
"W605",
"F632",
"E501",
]

[format]
quote-style = "preserve"
1 change: 1 addition & 0 deletions test-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ oslotest>=3.8.0 # Apache-2.0
stestr>=4.2.1 # Apache-2.0
flake8>=7.0.0
pyflakes>=3.2.0
ruff>=0.5.0 # MIT
27 changes: 25 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ minversion = 4.0.2
envlist = py3,pep8,cover
skipsdist = True

[vars]
all_path = {toxinidir}

[testenv]
usedevelop = True
setenv = VIRTUAL_ENV={envdir}
Expand All @@ -12,8 +15,25 @@ deps =
git+https://github.com/cloudbase/python-coriolisclient.git
commands = stestr run --slowest --exclude-regex coriolis.tests.integration {posargs}

[testenv:fmt]
description = Format the code based on the coding style standards.
deps =
ruff
commands =
ruff check --select I --fix {[vars]all_path}
ruff format {[vars]all_path}

[testenv:pep8]
commands = flake8 {posargs}
description = Verify the coding style (pep8).
deps =
ruff
flake8>=7.0.0
pyflakes>=3.2.0
hacking>=7.0.0,<7.1.0
commands =
ruff format --diff {[vars]all_path}
ruff check {[vars]all_path}
flake8 {[vars]all_path}

[testenv:cover]
setenv =
Expand Down Expand Up @@ -48,6 +68,9 @@ omit = coriolis/tests/*
[flake8]
# E125 is deliberately excluded. See https://github.com/jcrocholl/pep8/issues/126
# E251 Skipped due to https://github.com/jcrocholl/pep8/issues/301
#
# E501 (line too long) is left to ruff
Copy link
Copy Markdown
Member

@claudiubelu claudiubelu May 25, 2026

Choose a reason for hiding this comment

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

E501 is left to ruff, but E501 is ignored in ruff, as seen in ruff.toml.

# E203 (whitespace before ':') conflicts with how ruff formats slices.
Copy link
Copy Markdown
Member

@claudiubelu claudiubelu May 25, 2026

Choose a reason for hiding this comment

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

What about H301, H306?


ignore = E125,E251,W503,W504,E305,E731,E117,W605,F632,H401,H403,H404,H405,H202
ignore = E125,E251,W503,W504,E305,E731,E117,W605,F632,H401,H403,H404,H405,H202,E501,E203,H301,H306
exclude = .venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,tools