-
Notifications
You must be signed in to change notification settings - Fork 2
/
pyright.py
263 lines (195 loc) · 8.71 KB
/
pyright.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# SPDX-FileCopyrightText: Copyright © 2023 Jamie Nguyen <j@jamielinux.com>
# SPDX-License-Identifier: MIT
# pyright: strict
"""Methods and classes for parsing and formatting pyright's JSON output."""
import dataclasses
import json
import re
import sys
from enum import Enum, auto
from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar
from colorama import Fore
T = TypeVar("T")
__all__ = ["PyrightJsonError", "parse_pyright", "print_filtered", "print_pyright"]
class PyrightJsonError(Exception):
"""An error in the pyright JSON output."""
def __init__(self, msg: str):
"""Error message."""
super().__init__(f"pyright-polite: error: pyright returned unexpected JSON ({msg})")
class Severity(Enum):
"""Severity levels for pyright diagnostics."""
ERROR = auto()
WARNING = auto()
class SeverityColor(Enum):
"""Terminal colors for pyright severity levels."""
ERROR = Fore.RED
WARNING = Fore.CYAN
@dataclasses.dataclass(frozen=True)
class Diagnostic:
"""A single diagnostic from the pyright run."""
file: str
severity: Severity
message: str
start_line: int
start_char: int
rule: Optional[str] = None
@dataclasses.dataclass(frozen=True)
class Summary:
"""The summary from the pyright run."""
analyzed: int
errors: int
warnings: int
informations: int
@dataclasses.dataclass(frozen=True)
class Pyright:
"""All summary and diagnostic information from the pyright run."""
summary: Summary
diagnostics: List[Diagnostic]
def _get_key_validate(dictionary: Dict[str, Any], name: str, key: str, expected_type: Type[T]) -> T:
if key not in dictionary:
raise PyrightJsonError(f"{name} is missing {key}")
if not isinstance(dictionary[key], expected_type):
raise PyrightJsonError(f"{name}.{key} is not of type {expected_type.__name__}")
return dictionary[key]
def _parse_summary(json_output: Dict[str, Any]) -> Summary:
if "summary" not in json_output:
raise PyrightJsonError("summary is missing")
if not isinstance(json_output["summary"], dict):
raise PyrightJsonError("summary is invalid")
summary: Dict[str, Any] = json_output["summary"]
analyzed: int = _get_key_validate(summary, "summary", "filesAnalyzed", int)
errors: int = _get_key_validate(summary, "summary", "errorCount", int)
warnings: int = _get_key_validate(summary, "summary", "warningCount", int)
informations: int = _get_key_validate(summary, "summary", "informationCount", int)
return Summary(analyzed, errors, warnings, informations)
def _parse_diagnostics(json_output: Dict[str, Any]) -> List[Diagnostic]:
diagnostics: List[Diagnostic] = []
if "generalDiagnostics" not in json_output:
raise PyrightJsonError("generalDiagnostics is missing")
if not isinstance(json_output["generalDiagnostics"], list):
raise PyrightJsonError("generalDiagnostics is invalid")
item: Any
for item in json_output["generalDiagnostics"]:
if not isinstance(item, dict):
raise PyrightJsonError("invalid diagnostic")
dictionary: Dict[str, Any] = item
file: str = _get_key_validate(dictionary, "diagnostic", "file", str)
severity_field: str = _get_key_validate(dictionary, "diagnostic", "severity", str)
severity_field = severity_field.upper()
if not any(severity_field == sev.name for sev in Severity):
raise PyrightJsonError("diagnostic with invalid severity")
severity: Severity = getattr(Severity, severity_field)
# When a diagnostic spans multiple lines, pyright indents additional lines by
# four spaces. Well, actually two spaces and two non-breaking spaces due to
# https://github.com/microsoft/pyright/commit/a67c0240ab. pyright's JSON output
# only includes the two non-breaking spaces, so we add two more regular spaces.
message_field: str = _get_key_validate(dictionary, "diagnostic", "message", str)
message: str = message_field.replace("\n", "\n ")
if "range" not in item or not isinstance(item["range"], dict):
raise PyrightJsonError("diagnostic with missing or invalid range")
range_dict: Dict[str, Any] = item["range"]
start_dict: Dict[str, Any] = _get_key_validate(range_dict, "diagnostic", "start", dict)
start_line = _get_key_validate(start_dict, "range.start", "line", int)
start_char = _get_key_validate(start_dict, "range.start", "character", int)
# Not all diagnostics have a rule.
rule: str = dictionary.get("rule", None)
diagnostic: Diagnostic = Diagnostic(file, severity, message, start_line, start_char, rule)
diagnostics.append(diagnostic)
return diagnostics
def _print_analyzed(summary: Summary) -> None:
suffix = "s" if summary.analyzed != 1 else ""
sys.stdout.write(f"Found {summary.analyzed} source file{suffix}\n")
def _print_diagnostics(diagnostics: List[Diagnostic]) -> None:
file: str = ""
for diagnostic in diagnostics:
msg: List[str] = []
if diagnostic.file != file:
file = diagnostic.file
msg.append(f"{file}\n")
msg.append(f" {file}:")
msg.append(f"{Fore.YELLOW}{diagnostic.start_line + 1}{Fore.RESET}:")
msg.append(f"{Fore.YELLOW}{diagnostic.start_char + 1}{Fore.RESET} - ")
color: SeverityColor = SeverityColor[diagnostic.severity.name].value
msg.append(f"{color}{diagnostic.severity.name.lower()}{Fore.RESET}: {diagnostic.message}")
if diagnostic.rule:
msg.append(f" {Fore.LIGHTBLACK_EX}({diagnostic.rule}){Fore.RESET}")
msg.append("\n")
sys.stdout.write("".join(msg))
def _print_summary(summary: Summary) -> None:
msg: str = (
f"{summary.errors} errors, "
f"{summary.warnings} warnings, "
f"{summary.informations} informations"
"\n"
)
sys.stdout.write(msg)
def print_filtered(line: str) -> None:
"""Filter out lines that are usually completely useless to see over and over.
If the input line doesn't match the regex, print it to stdout.
Args:
line (str): The line of text to filter.
"""
ignore_start: Tuple[str, ...] = (
# Assuming Python version 3.11
# Assuming Python platform Linux
"Assuming ",
# Auto-excluding **/node_modules
# Auto-excluding **/__pycache__
# Auto-excluding **/.*
"Auto-excluding ",
# Completed in ...sec
"Completed in ",
# Found 2 source files
"Found ",
# Loading pyproject.toml file at ...
"Loading ",
# No configuration file found.
"No configuration ",
# No include entries specified; assuming ...
"No include entries ",
# No source files found.
"No source ",
# No pyproject.toml file found.
"No pyproject.toml ",
# Please install the new version or set PYRIGHT_PYTHON_FORCE_VERSION to `latest`
"Please install the new version",
# Searching for source files
"Searching ",
# WARNING: there is a new pyright version available (vX.X.X -> vX.X.X).
"WARNING: there is a new pyright",
# pyproject.toml file found at ...
"pyproject.toml file found ",
# pyright MAJOR.MINOR.PATCH
r"pyright \d+\.\d+\.\d+",
# stubPath .../typings is not a valid directory.
"stubPath ",
)
ignore_pattern: re.Pattern[str] = re.compile(rf"^({'|'.join(ignore_start)})")
if not ignore_pattern.search(line):
# readline() may return partial data (ie, without a newline character) if it
# receives an EOF from the stream and there's no "\n". Make sure we append a
# newline character in that situation.
output_line: str = line if line.endswith("\n") else f"{line}\n"
sys.stdout.write(output_line)
def parse_pyright(json_data: str) -> Pyright:
"""Parse pyright's JSON output.
Args:
json_data (str): The JSON output from pyright as a string.
Returns:
Pyright: Pyright object containing the parsed summary and diagnostics.
"""
try:
json_output: Dict[str, Any] = json.loads(json_data)
except json.JSONDecodeError as exc:
raise PyrightJsonError(f"{exc}") from exc
summary: Summary = _parse_summary(json_output)
diagnostics: List[Diagnostic] = _parse_diagnostics(json_output)
return Pyright(summary, diagnostics)
def print_pyright(pyright: Pyright) -> None:
"""Format the summary and diagnostic data we've parsed from pyright.
Args:
pyright (Pyright): Pyright object containing the parsed summary and diagnostics.
"""
_print_analyzed(pyright.summary)
_print_diagnostics(pyright.diagnostics)
_print_summary(pyright.summary)