Skip to content

Pass a single copy of the document's source around for flake8 #441

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

Merged
merged 1 commit into from
Sep 10, 2023
Merged

Pass a single copy of the document's source around for flake8 #441

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 11 additions & 6 deletions pylsp/plugins/flake8_lint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,15 @@ def pylsp_lint(workspace, document):
flake8_executable = settings.get("executable", "flake8")

args = build_args(opts)
output = run_flake8(flake8_executable, args, document)
return parse_stdout(document, output)

# ensure the same source is used for flake8 execution and result parsing;
# single source access improves performance as it is only one disk access
source = document.source
output = run_flake8(flake8_executable, args, document, source)
return parse_stdout(source, output)

def run_flake8(flake8_executable, args, document):

def run_flake8(flake8_executable, args, document, source):
"""Run flake8 with the provided arguments, logs errors
from stderr if any.
"""
Expand Down Expand Up @@ -127,7 +131,7 @@ def run_flake8(flake8_executable, args, document):
p = Popen( # pylint: disable=consider-using-with
cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE, **popen_kwargs
)
(stdout, stderr) = p.communicate(document.source.encode())
(stdout, stderr) = p.communicate(source.encode())
if stderr:
log.error("Error while running flake8 '%s'", stderr.decode())
return stdout.decode()
Expand Down Expand Up @@ -155,7 +159,7 @@ def build_args(options):
return args


def parse_stdout(document, stdout):
def parse_stdout(source, stdout):
"""
Build a diagnostics from flake8's output, it should extract every result and format
it into a dict that looks like this:
Expand Down Expand Up @@ -183,6 +187,7 @@ def parse_stdout(document, stdout):
A list of dictionaries.
"""

document_lines = source.splitlines(True)
diagnostics = []
lines = stdout.splitlines()
for raw_line in lines:
Expand Down Expand Up @@ -212,7 +217,7 @@ def parse_stdout(document, stdout):
"end": {
"line": line,
# no way to determine the column
"character": len(document.lines[line]),
"character": len(document_lines[line]),
},
},
"message": msg,
Expand Down