-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcheck_quecpython_compat.py
More file actions
366 lines (325 loc) · 11.1 KB
/
check_quecpython_compat.py
File metadata and controls
366 lines (325 loc) · 11.1 KB
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
#!/usr/bin/env python3
"""
Static checker for common QuecPython compatibility issues.
This script is intended for device-side runtime files.
"""
from __future__ import annotations
import argparse
import ast
import io
import os
import re
import tokenize
from dataclasses import dataclass
from typing import Iterable, List, Optional
DEFAULT_EXCLUDE_DIRS = {
".git",
".venv",
"__pycache__",
"node_modules",
"build",
"dist",
"out",
".cursor",
".trae",
"3rd",
}
BANNED_IMPORT_SUGGESTIONS = {
"json": "ujson",
"time": "utime",
"os": "uos",
"re": "ure",
"socket": "usocket",
"ssl": "ussl",
"struct": "ustruct",
"binascii": "ubinascii",
"collections": "ucollections",
"random": "urandom",
"zlib": "uzlib",
"hashlib": "uhashlib",
"typing": None,
"pathlib": None,
"threading": "_thread",
"asyncio": None,
"subprocess": None,
}
@dataclass
class Issue:
file_path: str
line: int
col: int
rule: str
message: str
def format(self) -> str:
return "%s:%d:%d [%s] %s" % (
self.file_path,
self.line,
self.col,
self.rule,
self.message,
)
def should_skip_dir(dir_name: str, excluded: set[str]) -> bool:
return dir_name in excluded
def iter_py_files(root: str, excluded: set[str]) -> Iterable[str]:
if os.path.isfile(root):
if root.endswith(".py"):
yield root
return
for dirpath, dirnames, filenames in os.walk(root):
dirnames[:] = [d for d in dirnames if not should_skip_dir(d, excluded)]
for name in filenames:
if name.endswith(".py"):
yield os.path.join(dirpath, name)
def detect_fstrings(source: str, file_path: str) -> List[Issue]:
issues: List[Issue] = []
stream = io.StringIO(source)
try:
for tok in tokenize.generate_tokens(stream.readline):
if tok.type != tokenize.STRING:
continue
token_text = tok.string
# Prefix before first quote
prefix_match = re.match(r"^([rRuUbBfF]*)['\"]", token_text)
if not prefix_match:
continue
prefix = prefix_match.group(1)
if "f" in prefix.lower():
issues.append(
Issue(
file_path=file_path,
line=tok.start[0],
col=tok.start[1] + 1,
rule="FSTRING",
message="f-string detected in device-side code baseline.",
)
)
except tokenize.TokenError:
# Parsing errors are handled in AST phase.
pass
return issues
def detect_regex_rules(lines: List[str], file_path: str) -> List[Issue]:
checks = [
(r"\bnonlocal\b", "NONLOCAL", "nonlocal detected."),
(r":=", "WALRUS", "walrus operator ':=' detected."),
(r"^\s*async\s+def\b", "ASYNC_DEF", "async function detected."),
(r"\bawait\b", "AWAIT", "await keyword detected."),
(
r"\.\s*removeprefix\s*\(",
"REMOVEPREFIX",
"str.removeprefix() may be unsupported in target baseline.",
),
(
r"\.\s*removesuffix\s*\(",
"REMOVESUFFIX",
"str.removesuffix() may be unsupported in target baseline.",
),
]
issues: List[Issue] = []
for idx, line in enumerate(lines, start=1):
for pattern, rule, msg in checks:
m = re.search(pattern, line)
if m:
issues.append(
Issue(
file_path=file_path,
line=idx,
col=m.start() + 1,
rule=rule,
message=msg,
)
)
return issues
def detect_ast_rules(
source: str, lines: List[str], file_path: str, allow_annotations: bool
) -> List[Issue]:
issues: List[Issue] = []
try:
tree = ast.parse(source, filename=file_path)
except SyntaxError as exc:
issues.append(
Issue(
file_path=file_path,
line=exc.lineno or 1,
col=(exc.offset or 1),
rule="SYNTAX",
message="syntax error: %s" % (exc.msg,),
)
)
return issues
for node in ast.walk(tree):
if isinstance(node, ast.Import):
for alias in node.names:
base = alias.name.split(".")[0]
suggestion = BANNED_IMPORT_SUGGESTIONS.get(base)
if suggestion is not None or base in BANNED_IMPORT_SUGGESTIONS:
msg = "import '%s' is not preferred in QuecPython runtime." % base
if suggestion:
msg += " Use '%s' if applicable." % suggestion
issues.append(
Issue(
file_path=file_path,
line=node.lineno,
col=node.col_offset + 1,
rule="IMPORT",
message=msg,
)
)
elif isinstance(node, ast.ImportFrom):
if node.module:
base = node.module.split(".")[0]
suggestion = BANNED_IMPORT_SUGGESTIONS.get(base)
if suggestion is not None or base in BANNED_IMPORT_SUGGESTIONS:
msg = "from '%s' import ... is not preferred in QuecPython runtime." % (
base,
)
if suggestion:
msg += " Use '%s' if applicable." % suggestion
issues.append(
Issue(
file_path=file_path,
line=node.lineno,
col=node.col_offset + 1,
rule="IMPORT_FROM",
message=msg,
)
)
if allow_annotations:
continue
if isinstance(node, ast.FunctionDef):
if node.returns is not None:
issues.append(
Issue(
file_path=file_path,
line=node.lineno,
col=node.col_offset + 1,
rule="ANNOTATION",
message="function return type annotation detected.",
)
)
for arg in list(node.args.args) + list(node.args.kwonlyargs):
if arg.annotation is not None:
issues.append(
Issue(
file_path=file_path,
line=arg.lineno,
col=arg.col_offset + 1,
rule="ANNOTATION",
message="function argument type annotation detected.",
)
)
if node.args.vararg and node.args.vararg.annotation is not None:
issues.append(
Issue(
file_path=file_path,
line=node.args.vararg.lineno,
col=node.args.vararg.col_offset + 1,
rule="ANNOTATION",
message="vararg type annotation detected.",
)
)
if node.args.kwarg and node.args.kwarg.annotation is not None:
issues.append(
Issue(
file_path=file_path,
line=node.args.kwarg.lineno,
col=node.args.kwarg.col_offset + 1,
rule="ANNOTATION",
message="kwarg type annotation detected.",
)
)
elif isinstance(node, ast.AnnAssign):
issues.append(
Issue(
file_path=file_path,
line=node.lineno,
col=node.col_offset + 1,
rule="ANNOTATION",
message="variable type annotation detected.",
)
)
return issues
def check_file(file_path: str, allow_annotations: bool) -> List[Issue]:
try:
with open(file_path, "r", encoding="utf-8") as f:
source = f.read()
except UnicodeDecodeError:
with open(file_path, "r", encoding="gbk", errors="ignore") as f:
source = f.read()
lines = source.splitlines()
issues: List[Issue] = []
issues.extend(detect_fstrings(source, file_path))
issues.extend(detect_regex_rules(lines, file_path))
issues.extend(detect_ast_rules(source, lines, file_path, allow_annotations))
return issues
def build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(
description=(
"Check common QuecPython compatibility issues in .py files. "
"Target device runtime code paths (for example code/ or /usr mirrors)."
)
)
parser.add_argument(
"path",
nargs="?",
default=".",
help=(
"File or directory to scan. Use device runtime code paths. "
"Default: current directory."
),
)
parser.add_argument(
"--exclude-dir",
action="append",
default=[],
help="Extra directory names to exclude from recursive scan.",
)
parser.add_argument(
"--allow-annotations",
action="store_true",
help="Allow type annotations (host-side scripts), do not report ANNOTATION issues.",
)
parser.add_argument(
"--no-default-excludes",
action="store_true",
help="Do not use built-in excluded directories.",
)
parser.add_argument(
"--fail-on-issues",
dest="fail_on_issues",
action="store_true",
default=True,
help="Exit with code 1 when issues are found (default).",
)
parser.add_argument(
"--no-fail-on-issues",
dest="fail_on_issues",
action="store_false",
help="Always exit with code 0 even when issues are found.",
)
return parser
def main() -> int:
parser = build_parser()
args = parser.parse_args()
excluded = set(args.exclude_dir)
if not args.no_default_excludes:
excluded.update(DEFAULT_EXCLUDE_DIRS)
all_issues: List[Issue] = []
scanned = 0
for file_path in iter_py_files(args.path, excluded):
scanned += 1
all_issues.extend(check_file(file_path, args.allow_annotations))
all_issues.sort(key=lambda x: (x.file_path, x.line, x.col, x.rule))
for issue in all_issues:
print(issue.format())
print("")
print("Scanned files: %d" % scanned)
print("Issues found: %d" % len(all_issues))
print(
"Tip: run this checker on device runtime folders only; "
"for host tooling scripts, use --allow-annotations --no-fail-on-issues."
)
if all_issues and args.fail_on_issues:
return 1
return 0
if __name__ == "__main__":
raise SystemExit(main())