ruff: maintain configuration, format examples and labgrid.protocols #1523
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
Bastian-Krause
force-pushed
the
bst/ruff
branch
from
df82928 to
aac68b5
Compare
|
Rebased on latest master. |
…end excludes ruff's "exclude" documentation [1] reads: "Note that you'll typically want to use extend-exclude to modify the excluded paths." Do that. The default for the "respect-gitignore" setting [2] is "true", so we can safely drop entries that are already specified there. [1] https://docs.astral.sh/ruff/settings/#exclude [2] https://docs.astral.sh/ruff/settings/#respect-gitignore Signed-off-by: Bastian Krause <[email protected]>
The default value of the "include" setting is ["*.py", "*.pyi", "*.ipynb", "**/pyproject.toml"] [1]. We're only interested in pyproject.toml and *.py files, so add pyproject.toml and the pre-formatted labgrid.remote module (previously specified in the CI configuration only). [1] https://docs.astral.sh/ruff/settings/#include Signed-off-by: Bastian Krause <[email protected]>
Signed-off-by: Bastian Krause <[email protected]>
Signed-off-by: Bastian Krause <[email protected]>
Formatted files were found via: $ diff --changed-group-format='%>' --unchanged-group-format='' <(ruff format --config "include = ['*.py','helpers/*']" --check | grep "Would reformat" | cut -d" " -f3) <(git ls-files *.py For now, single __init__.py files and files in tests/ were omitted. We should enforce formatting of more modules over time. Signed-off-by: Bastian Krause <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1523 +/- ##
======================================
Coverage 56.6% 56.6%
======================================
Files 168 168
Lines 13033 13033
======================================
Hits 7385 7385
Misses 5648 5648
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Emantor
approved these changes
Oct 21, 2024
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.
Description
Thinking and arguing about formatting is usually tedious work. To move a step closer to enforced formatting, maintain ruff's configuration centrally, run
ruff formatonexamples/andlabgrid/protocols/(these shouldn't cause too much friction) and enforce formatting on more code ruff is already happy about.Checklist