-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add support for ruff #18
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
#! /usr/bin/python3 | ||
|
||
""" | ||
The csdiff tool doesn't support the Ruff's JSON output yet. So this just a | ||
trivial wrapper which reads Ruff's report and transforms it to JSON which is | ||
supported by csdiff. | ||
The script accepts the same parameters as `ruff check` itself. | ||
""" | ||
|
||
import os | ||
import sys | ||
import json | ||
from subprocess import Popen, PIPE | ||
|
||
|
||
def ruff_check(): | ||
""" | ||
Run `ruff check` and return a dict with its results | ||
""" | ||
cmd = ["ruff", "check", "--output-format=json"] + sys.argv[1:] | ||
with Popen(cmd, stdout=PIPE) as proc: | ||
out, _err = proc.communicate(timeout=60) | ||
return json.loads(out) | ||
|
||
|
||
def ruff_code_to_name(code): | ||
""" | ||
Convert noqa code e.g. F401 to its human-readable name, e.g. unused-import | ||
""" | ||
# This implementation will likely kill all ruff performance benefits | ||
cmd = ["ruff", "rule", code, "--output-format=json"] | ||
with Popen(cmd, stdout=PIPE) as proc: | ||
out, _err = proc.communicate(timeout=60) | ||
data = json.loads(out) | ||
return data["name"] | ||
|
||
|
||
def main(): | ||
""" | ||
The main fuction | ||
""" | ||
defects = ruff_check() | ||
for defect in defects: | ||
path = os.path.relpath(defect["filename"]) | ||
column = defect["location"]["column"] or "" | ||
colsep = ":" if column else "" | ||
event = "{0}[{1}]".format( | ||
defect["code"], ruff_code_to_name(defect["code"])) | ||
|
||
print("Error: RUFF_WARNING:") | ||
print("{file}:{line}{colsep}{column}: {event}: {msg}".format( | ||
file=path, | ||
line=defect["location"]["row"], | ||
colsep=colsep, | ||
column=column, | ||
event=event, | ||
msg=defect["message"], | ||
)) | ||
print() | ||
|
||
|
||
if __name__ == "__main__": | ||
sys.exit(main()) |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it be added as a weak deps to spec file?
Should the argv be sanitized?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should, thank you. Good catch.
I don't know, I did the same that
vcs-diff-lint-csdiff-pylint
does. But probably not? Worst case scenario, the bad values are going to be passed toruff check
which will handle it and error out.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, with the shell=False (that is the default) this is not a problem.