Pivot to from flake8 to ruff for Python linting #1006
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since the start of the 0.3.x release of the retworkx project we have been using flake8 for Python linting and this has worked well for us. However, recently a new project, ruff [1][2], has shown increasing popularity becuase it provides the same linting coverage but is signficantly faster. Also just from a language solidatry PoV ruff is also written in rust. This commit migrates our linting jobs to use ruff instead of flake8 and sets up a reasonable set of rules as a starting point, which includes the rules equivalent to what we were using before with flake8, pyupgrade, and flake8-pyi, and flake8-quotes. [1] https://docs.astral.sh/ruff/ [2] https://github.com/astral-sh/ruff
Pull Request Test Coverage Report for Build 6539876916
💛 - Coveralls |
There was a problem hiding this comment.
This is great and it is a welcome addition in my opinion. ruff seems to work out-of-the-box with black and the fact that it integrates with pyproject.toml by default is nice.
Just three opinions:
- For the changes in the
.pyito use the non-deprecated aliases, it's worth changing BUT Python 3.8 holds us back - I agree with
PYI001warnings and I think we should fix them in a separate PR - We should put this on hold until Ramp up deprecation of retworkx package and remove tests #1004 is merged to avoid merge conflict headaches
| "rustworkx/__init__.pyi" = ["F403", "F405", "PYI001"] | ||
| "rustworkx/digraph.pyi" = ["F403", "F405", "PYI001"] | ||
| "rustworkx/graph.pyi" = ["F403", "F405", "PYI001"] | ||
| "rustworkx/iterators.pyi" = ["F403", "F405", "PYI001"] |
There was a problem hiding this comment.
I should fix PYI001 in those files, it would avoid us having to define __all__ in them
IvanIsCoding
approved these changes
Oct 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the start of the 0.3.x release of the retworkx project we have been using flake8 for Python linting and this has worked well for us. However, recently a new project, ruff [1][2], has shown increasing popularity becuase it provides the same linting coverage but is signficantly faster. Also just from a language solidatry PoV ruff is also written in rust. This commit migrates our linting jobs to use ruff instead of flake8 and sets up a reasonable set of rules as a starting point, which includes the rules equivalent to what we were using before with flake8, pyupgrade, and flake8-pyi, and flake8-quotes.
[1] https://docs.astral.sh/ruff/
[2] https://github.com/astral-sh/ruff