-
Notifications
You must be signed in to change notification settings - Fork 368
Expand file tree
/
Copy pathtemplate.py
More file actions
586 lines (475 loc) · 18.9 KB
/
template.py
File metadata and controls
586 lines (475 loc) · 18.9 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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
import os.path
import warnings
import ast
import json
from tests.nodes import convert_node
class Template(object):
def __init__(self, pattern):
self.pattern = TemplateTransformer.load(pattern)
def process(self, code, raw=False):
tree = ast.parse(code) if isinstance(code, str) else code
nodes = []
for node in ast.walk(tree):
if isinstance(node, type(self.pattern)) and is_ast_equal(
node, self.pattern
):
if not raw:
nodes.append(convert_node(node))
else:
nodes.append(node)
return nodes
def process_file(self, filename):
if isinstance(filename, str):
with open(filename, "rb") as file:
tree = ast.parse(file.read())
else:
tree = ast.parse(filename.read())
yield from self.query(tree)
def filter_subdirs(self, dirnames):
dirnames[:] = [d for d in dirnames if d != "build"]
def process_directory(self, directory):
for dirpath, dirnames, filenames in os.walk(directory):
self.filter_subdirs(dirnames)
for filename in filenames:
if filename.endswith((".py", ".pyw")):
filepath = os.path.join(dirpath, filename)
try:
for match in self.query_file(filepath):
yield filepath, match
except SyntaxError as e:
warnings.warn(
"Failed to parse {}:\n{}".format(filepath, e))
class TemplateTransformer(ast.NodeTransformer):
__WILDCARD_NAME = "__past_wildcard"
__MULTIWILDCARD_NAME = "__past_multiwildcard"
@classmethod
def load(cls, pattern):
pattern = pattern.replace("??", cls.__MULTIWILDCARD_NAME).replace(
"?", cls.__WILDCARD_NAME
)
transformed = ast.parse(pattern).body[0]
if isinstance(transformed, ast.Expr):
transformed = transformed.value
if isinstance(transformed, (ast.Attribute, ast.Subscript)):
del transformed.ctx
return cls().visit(transformed)
def must_exist(self, node, path):
if (node is None) or (node == []):
raise TemplateMismatch(path, node, "non empty")
def must_not_exist(self, node, path):
if (node is not None) and (node != []):
raise TemplateMismatch(path, node, "empty")
def visit_Name(self, node):
if node.id == self.__WILDCARD_NAME:
return self.must_exist
elif node.id == self.__MULTIWILDCARD_NAME:
return self.must_exist
return NameOrAttr(node.id)
def transform_wildcard(self, node, attrname):
if getattr(node, attrname, None) in (
self.__WILDCARD_NAME,
self.__MULTIWILDCARD_NAME,
):
setattr(node, attrname, self.must_exist)
def transform_wildcard_body(self, node, attrname):
body = getattr(node, attrname, [])
def _is_multiwildcard(n):
return is_ast_equal(
n, ast.Expr(value=ast.Name(id=self.__MULTIWILDCARD_NAME))
)
if len(body) == 1 and _is_multiwildcard(body[0]):
setattr(node, attrname, self.must_exist)
return
for i, n in enumerate(body):
if _is_multiwildcard(n):
newbody = body[:i] + Middle() + body[i + 1:]
setattr(node, attrname, newbody)
def visit_Attribute(self, node):
self.transform_wildcard(node, "attr")
return self.generic_visit(node)
def visit_FunctionDef(self, node):
self.transform_wildcard(node, "name")
self.transform_wildcard_body(node, "body")
return self.generic_visit(node)
visit_ClassDef = visit_FunctionDef
def visit_arguments(self, node):
positional_final_wildcard = False
for i, a in enumerate(node.args):
if a.arg == self.__MULTIWILDCARD_NAME:
from_end = len(node.args) - (i + 1)
if from_end == 0:
positional_final_wildcard = True
args = (
self.visit_list(node.args[:i])
+ Middle()
+ self.visit_list(node.args[i + 1:])
)
break
else:
if node.args:
args = self.visit_list(node.args)
else:
args = self.must_not_exist
defaults = [
(a.arg, self.visit(d))
for a, d in zip(node.args[-len(node.defaults):], node.defaults)
if a.arg not in {self.__WILDCARD_NAME, self.__MULTIWILDCARD_NAME}
]
if node.vararg is None:
if positional_final_wildcard:
vararg = None
else:
vararg = self.must_not_exist
else:
vararg = self.visit(node.vararg)
kwonly_args_dflts = [
(self.visit(a), (d if d is None else self.visit(d)))
for a, d in zip(node.kwonlyargs, node.kw_defaults)
if a.arg != self.__MULTIWILDCARD_NAME
]
koa_subset = (
positional_final_wildcard and vararg is None and (
not node.kwonlyargs)
) or any(a.arg == self.__MULTIWILDCARD_NAME for a in node.kwonlyargs)
if node.kwarg is None:
if koa_subset:
kwarg = None
else:
kwarg = self.must_not_exist
else:
kwarg = self.visit(node.kwarg)
return DefArgsCheck(
args=args,
defaults=defaults,
vararg=vararg,
kwonly_args_dflts=kwonly_args_dflts,
koa_subset=koa_subset,
kwarg=kwarg,
)
def visit_arg(self, node):
self.transform_wildcard(node, "arg")
return self.generic_visit(node)
def visit_If(self, node):
self.transform_wildcard_body(node, "body")
self.transform_wildcard_body(node, "orelse")
return self.generic_visit(node)
visit_For = visit_While = visit_If
def visit_Try(self, node):
self.transform_wildcard_body(node, "body")
self.transform_wildcard_body(node, "orelse")
self.transform_wildcard_body(node, "finalbody")
return self.generic_visit(node)
def visit_ExceptHandler(self, node):
self.transform_wildcard(node, "name")
self.transform_wildcard_body(node, "body")
return self.generic_visit(node)
def visit_With(self, node):
self.transform_wildcard_body(node, "body")
return self.generic_visit(node)
def visit_Call(self, node):
kwargs_are_subset = False
for i, n in enumerate(node.args):
if is_ast_equal(n, ast.Name(id=self.__MULTIWILDCARD_NAME)):
if i + 1 == len(node.args):
kwargs_are_subset = True
node.args = (
self.visit_list(node.args[:i])
+ Middle()
+ self.visit_list(node.args[i + 1:])
)
break
if kwargs_are_subset or any(
k.arg == self.__MULTIWILDCARD_NAME for k in node.keywords
):
template_keywords = [
self.visit(k)
for k in node.keywords
if k.arg != self.__MULTIWILDCARD_NAME
]
def kwargs_checker(sample_keywords, path):
sample_kwargs = {k.arg: k.value for k in sample_keywords}
for k in template_keywords:
if k.arg == self.__MULTIWILDCARD_NAME:
continue
if k.arg in sample_kwargs:
assert_ast_equal(
sample_kwargs[k.arg], k.value, path + [k.arg])
else:
raise TemplateMismatch(
path, "(missing)", "keyword arg %s" % k.arg
)
if template_keywords:
node.keywords = kwargs_checker
else:
del node.keywords
if node.args == []:
node.args = self.must_not_exist
if getattr(node, "keywords", None) == []:
node.keywords = self.must_not_exist
return self.generic_visit(node)
def transform_import_names(self, node):
if len(node.names) == 1 and node.names[0].name == self.__MULTIWILDCARD_NAME:
del node.names
else:
for alias in node.names:
self.visit_alias(alias)
def visit_Import(self, node):
self.transform_import_names(node)
return node
def visit_ImportFrom(self, node):
self.transform_wildcard(node, "module")
self.transform_import_names(node)
if node.level == 0:
del node.level
return node
def visit_alias(self, node):
self.transform_wildcard(node, "name")
if node.asname is None:
del node.asname
else:
self.transform_wildcard(node, "asname")
def generic_visit(self, node):
for field, old_value in ast.iter_fields(node):
old_value = getattr(node, field, None)
if isinstance(old_value, list):
new_values = []
for value in old_value:
if isinstance(value, ast.AST):
value = self.visit(value)
if value is None:
continue
elif isinstance(value, list):
new_values.extend(value)
continue
new_values.append(value)
if not new_values:
delattr(node, field)
old_value[:] = new_values
elif isinstance(old_value, ast.AST):
new_node = self.visit(old_value)
if new_node is None:
delattr(node, field)
else:
setattr(node, field, new_node)
return node
def visit_list(self, l):
return [self.visit(n) for n in l]
class NameOrAttr(object):
def __init__(self, name):
self.name = name
def __repr__(self):
return "past.NameOrAttr({%r})" % self.name
def __call__(self, node, path):
if isinstance(node, ast.Name):
if node.id != self.name:
raise TemplatePlainObjMismatch(
path + ["id"], node.id, self.name)
elif isinstance(node, ast.Attribute):
if node.attr != self.name:
raise TemplatePlainObjMismatch(
path + ["attr"], node.attr, self.name)
else:
raise TemplateNodeTypeMismatch(path, node, "Name or Attribute")
class Middle(object):
def __init__(self, front=None, back=None):
super(Middle, self).__init__()
self.front = front or []
self.back = back or []
def __radd__(self, other):
if not isinstance(other, list):
raise TypeError(
"Cannot add {} and Middle objects".format(type(other)))
return Middle(other + self.front, self.back)
def __add__(self, other):
if not isinstance(other, list):
raise TypeError(
"Cannot add Middle and {} objects".format(type(other)))
return Middle(self.front, self.back + other)
def __call__(self, sample_list, path):
if not isinstance(sample_list, list):
raise TemplateNodeTypeMismatch(path, sample_list, list)
if self.front:
nfront = len(self.front)
if len(sample_list) < nfront:
raise TemplateNodeListMismatch(
path + ["<front>"], sample_list, self.front
)
check_node_list(path, sample_list[:nfront], self.front)
if self.back:
nback = len(self.back)
if len(sample_list) < nback:
raise TemplateNodeListMismatch(
path + ["<back>"], sample_list, self.back
)
check_node_list(path, sample_list[-nback:], self.back, -nback)
class TemplateMismatch(AssertionError):
def __init__(self, path, got, expected):
self.path = path
self.expected = expected
self.got = got
def __str__(self):
return ("Mismatch at {}.\n" "Found : {}\n" "Expected: {}").format(
format_path(self.path), self.got, self.expected
)
class TemplateNodeTypeMismatch(TemplateMismatch):
def __str__(self):
expected = (
type(self.expected).__name__
if isinstance(self.expected, ast.AST)
else self.expected
)
return "At {}, found {} node instead of {}".format(
format_path(self.path), type(self.got).__name__, expected
)
class TemplateNodeListMismatch(TemplateMismatch):
def __str__(self):
return "At {}, found {} node(s) instead of {}".format(
format_path(self.path), len(self.got), len(self.expected)
)
class TemplatePlainListMismatch(TemplateMismatch):
def __str__(self):
return ("At {}, lists differ.\nFound : {}\nExpected: {}").format(
format_path(self.path), self.got, self.expected
)
class TemplatePlainObjMismatch(TemplateMismatch):
def __str__(self):
return "At {}, found {!r} instead of {!r}".format(
format_path(self.path), self.got, self.expected
)
class DefArgsCheck:
def __init__(self, args, defaults, vararg, kwonly_args_dflts, koa_subset, kwarg):
self.args = args
self.defaults = defaults
self.vararg = vararg
self.kwonly_args_dflts = kwonly_args_dflts
self.koa_subset = koa_subset
self.kwarg = kwarg
def __repr__(self):
return (
"past.DefArgsCheck(args={s.args}, defaults={s.defaults}, "
"vararg={s.vararg}, kwonly_args_dflts={s.kwonly_args_dflts}, "
"koa_subset={s.koa_subset}, kwarg={s.kwarg}"
).format(s=self)
def __call__(self, sample_node, path):
if self.args:
if isinstance(self.args, list):
check_node_list(path + ["args"], sample_node.args, self.args)
else:
assert_ast_equal(sample_node.args, self.args)
if self.defaults:
sample_args_w_defaults = sample_node.args[-len(
sample_node.defaults):]
sample_arg_defaults = {
a.arg: d for a, d in zip(sample_args_w_defaults, sample_node.defaults)
}
for argname, dflt in self.defaults:
try:
sample_dflt = sample_arg_defaults[argname]
except KeyError:
raise TemplateMismatch(
path + ["defaults", argname], "(missing default)", dflt
)
else:
assert_ast_equal(dflt, sample_dflt,
path + ["defaults", argname])
if self.vararg:
assert_ast_equal(sample_node.vararg, self.vararg)
sample_kwonlyargs = {
k.arg: (k, d)
for k, d in zip(sample_node.kwonlyargs, sample_node.kw_defaults)
}
for template_arg, template_dflt in self.kwonly_args_dflts:
argname = template_arg.arg
try:
sample_arg, sample_dflt = sample_kwonlyargs[argname]
except KeyError:
raise TemplateMismatch(
path +
["kwonlyargs"], "(missing)", "keyword arg %s" % argname
)
else:
assert_ast_equal(
sample_arg, template_arg, path + ["kwonlyargs", argname]
)
if template_dflt is not None:
assert_ast_equal(
sample_dflt, template_dflt, path +
["kw_defaults", argname]
)
if not self.koa_subset:
template_kwarg_names = {k.arg for k, d in self.kwonly_args_dflts}
excess_names = set(sample_kwonlyargs) - template_kwarg_names
if excess_names:
raise TemplateMismatch(
path +
["kwonlyargs"], excess_names, "(not present in template)"
)
if self.kwarg:
assert_ast_equal(sample_node.kwarg, self.kwarg)
def format_path(path):
formed = path[:1]
for part in path[1:]:
if isinstance(part, int):
formed.append("[%d]" % part)
else:
formed.append("." + part)
return "".join(formed)
def check_node_list(path, sample, template, start_enumerate=0):
if len(sample) != len(template):
raise TemplateNodeListMismatch(path, sample, template)
for i, (sample_node, template_node) in enumerate(
zip(sample, template), start=start_enumerate
):
if callable(template_node):
template_node(sample_node, path + [i])
else:
assert_ast_equal(sample_node, template_node, path + [i])
def assert_ast_equal(sample, template, path=None):
if path is None:
path = ["tree"]
if callable(template):
return template(sample, path)
if not isinstance(sample, type(template)):
raise TemplateNodeTypeMismatch(path, sample, template)
for name, template_field in ast.iter_fields(template):
sample_field = getattr(sample, name)
field_path = path + [name]
if isinstance(template_field, list):
if template_field and (
isinstance(template_field[0], ast.AST) or callable(
template_field[0])
):
check_node_list(field_path, sample_field, template_field)
else:
if sample_field != template_field:
raise TemplatePlainListMismatch(
field_path, sample_field, template_field
)
elif isinstance(template_field, ast.AST):
assert_ast_equal(sample_field, template_field, field_path)
elif callable(template_field):
template_field(sample_field, field_path)
else:
if sample_field != template_field:
raise TemplatePlainObjMismatch(
field_path, sample_field, template_field)
def is_ast_equal(sample, template):
try:
assert_ast_equal(sample, template)
return True
except TemplateMismatch:
return False
def debug_test_case(node):
"""Print JSON parser nodes
Arguments:
node {[type]} -- [description]
"""
print(json.dumps(node.assign_().n, indent=4))
print(json.dumps(node.for_().n, indent=4))
print(json.dumps(node.returns_call().n, indent=4))
def debug_test_case_class(node, test_method):
"""Print JSON parser nodes for class properties
Arguments:
node {[type]} -- [description]
"""
print(json.dumps(node.def_args_(test_method).n, indent=4))