Skip to content
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 1 commit into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 21 additions & 1 deletion vcs-diff-lint
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ CSDIFF_PYLINT = os.path.realpath(os.path.join(os.path.dirname(__file__),
CSDIFF_MYPY = os.path.realpath(os.path.join(os.path.dirname(__file__),
'vcs-diff-lint-csdiff-mypy'))

CSDIFF_RUFF = os.path.realpath(
os.path.join(os.path.dirname(__file__), 'vcs-diff-lint-csdiff-ruff'))


def _run_csdiff(old, new, msg):
popen_diff = Popen(['csdiff', '-c', old, new],
Expand Down Expand Up @@ -170,6 +173,23 @@ class MypyLinter(_Linter):
return cmd, {}


class RuffLinter(_Linter):
"""
Generate Ruff error output compatible with 'csdiff'.
"""
linter_tags = [
"ruff",
"python",
]

def is_compatible(self, file):
return file.type == 'python'

def command(self, projectdir, filenames):
cmd = [CSDIFF_RUFF] + filenames
return cmd, {}


def get_rename_map(options, subdir):
"""
Using the os.getcwd() and 'git diff --namestatus', generate list of
Expand Down Expand Up @@ -213,7 +233,7 @@ class _Worker: # pylint: disable=too-few-public-methods
projectsubdir = None
workdir = None
checkout = None
linters = [PylintLinter, MypyLinter]
linters = [PylintLinter, MypyLinter, RuffLinter]

def __init__(self, options):
self.options = options
Expand Down
64 changes: 64 additions & 0 deletions vcs-diff-lint-csdiff-ruff
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:]
Copy link
Member

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?

Copy link
Member Author

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?

It should, thank you. Good catch.

Should the argv be sanitized?

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 to ruff check which will handle it and error out.

Copy link
Member

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.

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())
1 change: 1 addition & 0 deletions vcs-diff-lint.spec
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Requires: git
Requires: pylint
Requires: python3-mypy
Requires: python3-types-requests
Requires: ruff

%description
Analyze code, and print only reports related to a particular change.
Expand Down
Loading