Repository navigation
Expand file tree
/
Copy pathpymini.py
More file actions
2380 lines (2094 loc) · 90.6 KB
/
Copy pathpymini.py
File metadata and controls
2380 lines (2094 loc) · 90.6 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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import ast
import copy
import keyword
from collections import Counter
from typing import Dict, List, Optional, Set
from .utils import variable_name_generator
class Transformer:
def transform(self, *trees):
for tree in trees:
self.visit(tree)
return trees
class NodeTransformer(Transformer, ast.NodeTransformer):
pass
class NodeVisitor(Transformer, ast.NodeVisitor):
pass
class Pipeline:
def __init__(self, *transformers):
self.transformers = transformers
def transform(self, *trees):
for transformer in self.transformers:
trees = transformer.transform(*trees)
return trees
class ReturnSimplifier(NodeTransformer):
"""Simplify return statements in the following form:
x = (some code)
return x
to
return (some code)
NOTE: unused_assignments must be modified in-place, since the set is passed
to RemoveUnusedVariables at initialization. Can't return a new set.
"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.unused_assignments = set()
def _can_simplify_return(self, previous: ast.stmt, current: ast.stmt) -> bool:
return (
isinstance(previous, ast.Assign)
and len(previous.targets) == 1
and isinstance(previous.targets[0], ast.Name)
and isinstance(current, ast.Return)
and isinstance(current.value, ast.Name)
and current.value.id == previous.targets[0].id
)
def _simplify_body(self, body: List[ast.stmt]) -> List[ast.stmt]:
for previous, current in zip(body, body[1:]):
if self._can_simplify_return(previous, current):
self.unused_assignments.add(id(previous))
current.value = copy.deepcopy(previous.value)
return body
def generic_visit(self, node):
node = super().generic_visit(node)
for field, value in ast.iter_fields(node):
if isinstance(value, list) and value and all(isinstance(item, ast.stmt) for item in value):
setattr(node, field, self._simplify_body(value))
return node
class RemoveUnusedVariables(NodeTransformer):
"""Remove all unused variables.
NOTE: cannot store a copy of unused_assignments, as this set is modified
in-place
after initialization.
"""
def __init__(self, unused_assignments: Set[int]):
super().__init__()
self.unused_assignments = unused_assignments
def visit_Assign(self, node: ast.Assign) -> Optional[ast.Assign]:
if id(node) in self.unused_assignments:
return None
return self.generic_visit(node)
class VariableNameCollector(NodeVisitor):
"""Collects all variable names in scope."""
def __init__(self):
self.names = set()
def visit_Name(self, node):
self.names.add(node.id)
class ScopeLocalNameCollector(ast.NodeVisitor):
def __init__(self):
self.reserved_names = set()
self.bindings = set()
self.loads = set()
self.external_bindings = set()
self.args = set()
def visit_Name(self, node):
self.reserved_names.add(node.id)
if isinstance(node.ctx, ast.Store):
self.bindings.add(node.id)
elif isinstance(node.ctx, ast.Load):
self.loads.add(node.id)
def visit_arg(self, node):
self.reserved_names.add(node.arg)
self.bindings.add(node.arg)
self.args.add(node.arg)
if node.annotation is not None:
self.visit(node.annotation)
def visit_Global(self, node):
self.reserved_names.update(node.names)
self.external_bindings.update(node.names)
visit_Nonlocal = visit_Global
def visit_ExceptHandler(self, node):
if node.name:
self.reserved_names.add(node.name)
self.bindings.add(node.name)
if node.type is not None:
self.visit(node.type)
for statement in node.body:
self.visit(statement)
def visit_Import(self, node):
for alias in node.names:
bound_name = alias.asname or alias.name.split(".", 1)[0]
self.reserved_names.add(bound_name)
self.bindings.add(bound_name)
def visit_ImportFrom(self, node):
for alias in node.names:
if alias.name == "*":
continue
bound_name = alias.asname or alias.name
self.reserved_names.add(bound_name)
self.bindings.add(bound_name)
def _visit_nested_function(self, node):
self.reserved_names.add(node.name)
self.bindings.add(node.name)
for decorator in node.decorator_list:
self.visit(decorator)
for default in node.args.defaults:
self.visit(default)
for default in node.args.kw_defaults:
if default is not None:
self.visit(default)
for argument in (
[*node.args.posonlyargs, *node.args.args, *node.args.kwonlyargs]
+ ([node.args.vararg] if node.args.vararg is not None else [])
+ ([node.args.kwarg] if node.args.kwarg is not None else [])
):
if argument is not None and argument.annotation is not None:
self.visit(argument.annotation)
returns = getattr(node, "returns", None)
if returns is not None:
self.visit(returns)
def visit_FunctionDef(self, node):
self._visit_nested_function(node)
visit_AsyncFunctionDef = visit_FunctionDef
def visit_ClassDef(self, node):
self.reserved_names.add(node.name)
self.bindings.add(node.name)
for decorator in node.decorator_list:
self.visit(decorator)
for base in node.bases:
self.visit(base)
for keyword in node.keywords:
self.visit(keyword)
def visit_Lambda(self, node):
return None
def visit_ListComp(self, node):
return None
def visit_SetComp(self, node):
return None
def visit_DictComp(self, node):
return None
def visit_GeneratorExp(self, node):
return None
class ParentSetter(NodeTransformer):
"""Adds parent attribute to each node.
>>> def apply(src):
... tree = ast.parse(src)
... ParentSetter().visit(tree)
... return tree
...
>>> tree = apply("lorem = 'demiurgic'\\nipsum = 'demiurgic'")
>>> isinstance(tree.body[0].parent, ast.Module)
True
>>> isinstance(tree.body[0].value.parent, ast.Assign)
True
"""
def visit(self, node):
for child in ast.iter_child_nodes(node):
child.parent = node
self.visit(child)
return node
class CommentRemover(NodeTransformer):
"""Drop all comments, both single-line and docstrings.
>>> def apply(code):
... tree = ast.parse(code)
... tree = ParentSetter().visit(tree)
... tree = CommentRemover().visit(tree)
... return ast.unparse(tree)
...
>>> apply('1 + 1 # comment')
'1 + 1'
>>> print(apply('''
... def square(x):
... \\'\\'\\'Return the square of x.\\'\\'\\'
... return x ** 2
... '''))
def square(x):
return x ** 2
>>> print(apply('''
... def square(x):
... \\'\\'\\'Return the square of x.\\'\\'\\'
... '''))
def square(x):
0
"""
def visit_Expr(self, node):
if isinstance(node.value, ast.Constant) and isinstance(node.value.value, str):
if len(node.parent.body) == 1: # if body is just the comment
return ast.parse('0').body[0] # replace comment with 0
return None # otherwise, remove comment
return node
class VariableShortener(NodeTransformer):
"""Renames variables according to provided mapping.
>>> shortener = VariableShortener(variable_name_generator(), mapping={'donotrename': 'donotrename'})
>>> apply = lambda src: ast.unparse(shortener.visit(ast.parse(src)))
>>> print(apply('mamamia = 1; donotrename = 2;'))
a = 1
donotrename = 2
"""
# Compression passes in this transformer use these guardrails:
# - repeated-name aliasing is statement-local and deleted after the
# statement, so helpers do not leak across later code
# - repeated-string hoisting now runs at function, module, and class scope,
# with cleanup deletes for module/class helpers
# - preserve-public-API mode can rename top-level classes, methods, and
# class-body attributes, but it emits explicit aliases and fixes class
# __name__/__qualname__ for compatibility
# - attribute rewriting is limited to owners we can prove from the AST
# (`self`, `cls`, or known class names), not arbitrary dynamic receivers
#
# Keep regression coverage in tests/test_api.py and the checked-in example
# outputs under tests/examples in sync whenever these rules change.
def __init__(
self,
generator,
mapping=None,
modules=(),
keep_global_variables=False,
rename_arguments=False,
reserved_names=None,
):
self.mapping = mapping or {}
self.mapping_values = set(self.mapping.values())
self.generator = generator
self.reserved_names = set(reserved_names or ())
self.nodes_to_append = []
self.public_global_names = set()
self.scope_stack = []
self.local_rename_scopes = []
self.instance_type_scopes = [{}]
self.class_context_stack = []
self.class_member_mappings = {}
self.callable_argument_infos = {}
self.class_method_argument_infos = {}
self._class_public_member_reference_cache = {}
self._module_attribute_reference_cache = {}
self._scope_analysis_cache = {}
self.modules = set(modules) # don't alias variables imported from these modules
self.keep_global_variables = keep_global_variables
self.rename_arguments = rename_arguments
def _is_node_global(self, node):
"""Check if a node is global."""
return (
not hasattr(node, 'parent') or isinstance(node.parent, ast.Module)
)
def _rename_identifier(self, old_name):
if old_name not in self.mapping:
while True:
candidate = next(self.generator)
if candidate not in self.mapping_values and candidate not in self.reserved_names:
self.mapping[old_name] = candidate
self.mapping_values.add(candidate)
break
return self.mapping[old_name]
def _lookup_local_identifier(self, old_name):
for scope in reversed(self.local_rename_scopes):
if old_name in scope["mapping"]:
return scope["mapping"][old_name]
return None
def _lookup_visible_identifier(self, old_name):
local_name = self._lookup_local_identifier(old_name)
if local_name is not None:
return local_name
return self.mapping.get(old_name)
def _rename_local_identifier(self, old_name):
if old_name in self.mapping_values:
return old_name
scope = self.local_rename_scopes[-1]
if old_name not in scope["mapping"]:
new_name = next(scope["generator"])
scope["mapping"][old_name] = new_name
scope["used_names"].add(new_name)
return scope["mapping"][old_name]
def _push_instance_scope(self):
self.instance_type_scopes.append({})
def _pop_instance_scope(self):
self.instance_type_scopes.pop()
def _set_instance_type(self, name, class_name):
scope = self.instance_type_scopes[-1]
if class_name is None:
scope.pop(name, None)
else:
scope[name] = class_name
def _lookup_instance_type(self, name):
for scope in reversed(self.instance_type_scopes):
if name in scope:
return scope[name]
return None
def _append_public_alias(self, old_name, new_name):
if old_name != new_name:
self.nodes_to_append.append(ast.parse(f"{old_name} = {new_name}").body[0])
def _generated_assignment(self, source):
node = ast.parse(source).body[0]
node._pymini_generated = True
return node
def _containing_module(self, node):
current = node
while hasattr(current, "parent") and not isinstance(current.parent, ast.Module):
current = current.parent
return current.parent if hasattr(current, "parent") else None
def _current_class_context(self):
if self.class_context_stack:
return self.class_context_stack[-1]
return None
def _preserve_function_name(self, name):
return name.startswith("__") and name.endswith("__")
def _estimated_short_name_length(self):
return 1
def _rename_savings(self, old_name, count):
return max(0, len(old_name) - self._estimated_short_name_length()) * count
def _public_class_alias_cost(self, old_name):
short_name = "a"
return sum(
len(statement)
for statement in (
f"{old_name}={short_name}",
f"{short_name}.__name__={old_name!r}",
f"{short_name}.__qualname__={old_name!r}",
)
)
def _public_member_alias_cost(self, old_name):
return len(f"{old_name}=a")
def _public_global_alias_cost(self, old_name):
return len(f"{old_name}=a")
def _public_class_reference_count(self, node, old_name):
module = self._containing_module(node)
count = 1
if module is None:
return count
for current in ast.walk(module):
if isinstance(current, ast.Name) and current.id == old_name:
count += 1
return count
def _class_public_member_references(self, class_node):
cache_key = id(class_node)
cached = self._class_public_member_reference_cache.get(cache_key)
if cached is not None:
return cached
name_loads = Counter()
attribute_loads_by_base = {}
for current in ast.walk(class_node):
if isinstance(current, ast.Name) and isinstance(current.ctx, ast.Load):
name_loads[current.id] += 1
elif isinstance(current, ast.Attribute) and isinstance(current.value, ast.Name):
base_name = current.value.id
base_counts = attribute_loads_by_base.get(base_name)
if base_counts is None:
base_counts = Counter()
attribute_loads_by_base[base_name] = base_counts
base_counts[current.attr] += 1
cached = {
"name_loads": name_loads,
"attribute_loads_by_base": attribute_loads_by_base,
}
self._class_public_member_reference_cache[cache_key] = cached
return cached
def _module_attribute_references(self, module):
cache_key = id(module)
cached = self._module_attribute_reference_cache.get(cache_key)
if cached is not None:
return cached
attribute_loads_by_base = {}
for current in ast.walk(module):
if not isinstance(current, ast.Attribute) or not isinstance(current.value, ast.Name):
continue
base_name = current.value.id
base_counts = attribute_loads_by_base.get(base_name)
if base_counts is None:
base_counts = Counter()
attribute_loads_by_base[base_name] = base_counts
base_counts[current.attr] += 1
self._module_attribute_reference_cache[cache_key] = attribute_loads_by_base
return attribute_loads_by_base
def _public_member_reference_count(self, class_node, class_name, member_name):
references = self._class_public_member_references(class_node)
count = 1 + references["name_loads"].get(member_name, 0)
attribute_loads_by_base = references["attribute_loads_by_base"]
for base_name in {"self", "cls", class_name}:
count += attribute_loads_by_base.get(base_name, {}).get(member_name, 0)
module = self._containing_module(class_node)
if module is not None:
count += self._module_attribute_references(module).get(class_name, {}).get(member_name, 0)
return count
def _public_global_reference_count(self, node, old_name):
module = self._containing_module(node)
count = 1
if module is None:
return count
for current in ast.walk(module):
if (
isinstance(current, ast.Name)
and isinstance(current.ctx, ast.Load)
and current.id == old_name
):
count += 1
return count
def _should_rename_public_class(self, node, old_name):
return self._rename_savings(
old_name,
self._public_class_reference_count(node, old_name),
) > self._public_class_alias_cost(old_name)
def _should_rename_public_member(self, class_node, class_name, member_name):
return self._rename_savings(
member_name,
self._public_member_reference_count(class_node, class_name, member_name),
) > self._public_member_alias_cost(member_name)
def _should_rename_public_global(self, node, old_name):
return self._rename_savings(
old_name,
self._public_global_reference_count(node, old_name),
) > self._public_global_alias_cost(old_name)
def _is_method_definition(self, node):
return isinstance(getattr(node, "parent", None), ast.ClassDef)
def _is_class_body_assignment(self, node):
return isinstance(getattr(node, "parent", None), ast.ClassDef)
def _should_preserve_binding_targets(self, node):
return self.keep_global_variables and (
self._is_node_global(node) or self._is_class_body_assignment(node)
)
def _binding_names_from_target(self, target):
names = set()
if isinstance(target, ast.Name):
names.add(target.id)
elif isinstance(target, (ast.Tuple, ast.List)):
for element in target.elts:
names.update(self._binding_names_from_target(element))
return names
def _function_argument_nodes(self, arguments):
return [
*arguments.posonlyargs,
*arguments.args,
*arguments.kwonlyargs,
*([arguments.vararg] if arguments.vararg is not None else []),
*([arguments.kwarg] if arguments.kwarg is not None else []),
]
def _is_staticmethod(self, node):
for decorator in node.decorator_list:
if isinstance(decorator, ast.Name) and decorator.id == "staticmethod":
return True
if isinstance(decorator, ast.Attribute) and decorator.attr == "staticmethod":
return True
return False
def _should_rename_argument(self, name):
return (
self.rename_arguments
and not self._preserve_function_name(name)
and (len(name) > 1 or name in {"self", "cls"})
)
def _rename_function_arguments(self, node):
argument_mapping = {}
positional_params = [arg.arg for arg in [*node.args.posonlyargs, *node.args.args]]
for argument in self._function_argument_nodes(node.args):
old_name = argument.arg
if not self._should_rename_argument(old_name):
continue
new_name = self._rename_local_identifier(old_name)
argument.arg = new_name
if old_name != new_name:
argument_mapping[old_name] = new_name
receiver_names = set()
if self._is_method_definition(node) and not self._is_staticmethod(node) and positional_params:
receiver_name = positional_params.pop(0)
receiver_names.add(receiver_name)
receiver_names.add(argument_mapping.get(receiver_name, receiver_name))
return {
"rename_map": argument_mapping,
"positional_params": positional_params,
"receiver_names": receiver_names,
}
def _record_callable_argument_info(self, old_name, new_name, argument_info):
if not argument_info["rename_map"] and not argument_info["positional_params"]:
return
copied = {
"rename_map": dict(argument_info["rename_map"]),
"positional_params": list(argument_info["positional_params"]),
}
self.callable_argument_infos[old_name] = copied
self.callable_argument_infos[new_name] = copied
def _call_argument_info(self, func):
if isinstance(func, ast.Name):
return self.callable_argument_infos.get(func.id)
if not isinstance(func, ast.Attribute):
return None
base_name = func.value.id if isinstance(func.value, ast.Name) else None
class_context = self._current_class_context()
if base_name is not None:
if class_context is not None and base_name in (
class_context["receiver_names"]
| {class_context["old_name"], class_context["new_name"]}
):
return class_context["argument_infos"].get(func.attr)
instance_class = self._lookup_instance_type(base_name)
if instance_class in self.class_method_argument_infos:
return self.class_method_argument_infos[instance_class].get(func.attr)
if base_name in self.class_method_argument_infos:
return self.class_method_argument_infos[base_name].get(func.attr)
receiver_class = self._receiver_class_name(func.value)
if receiver_class in self.class_method_argument_infos:
return self.class_method_argument_infos[receiver_class].get(func.attr)
return None
def _rewrite_keywords_as_positional(self, node, argument_info):
if any(isinstance(arg, ast.Starred) for arg in node.args):
return
positional_params = argument_info["positional_params"]
if not positional_params:
return
next_position = len(node.args)
rewritten_keywords = []
can_convert = True
for keyword in node.keywords:
if (
can_convert
and keyword.arg is not None
and next_position < len(positional_params)
and keyword.arg == positional_params[next_position]
):
node.args.append(keyword.value)
next_position += 1
continue
can_convert = False
rewritten_keywords.append(keyword)
node.keywords = rewritten_keywords
def _rename_assignment_target(self, target, create_new=True):
if isinstance(target, ast.Name):
if self._is_active_parameter_name(target.id) or self._preserve_function_name(target.id):
return
if (
self.local_rename_scopes
and self.scope_stack
and target.id in self.scope_stack[-1]["bindings"]
and target.id not in self.scope_stack[-1]["globals"]
):
target.id = self._rename_local_identifier(target.id)
return
if target.id in self.mapping:
target.id = self.mapping[target.id]
elif create_new and target.id not in self.mapping_values:
target.id = self._rename_identifier(target.id)
return
if isinstance(target, (ast.Tuple, ast.List)):
for element in target.elts:
self._rename_assignment_target(element, create_new=create_new)
def _is_in_expression_scope(self, node):
current = getattr(node, "parent", None)
expression_scopes = (
ast.Lambda,
ast.ListComp,
ast.SetComp,
ast.DictComp,
ast.GeneratorExp,
)
while current is not None:
if isinstance(current, expression_scopes):
return True
current = getattr(current, "parent", None)
return False
def _is_in_function_signature(self, node):
current = getattr(node, "parent", None)
while current is not None:
if isinstance(current, (ast.FunctionDef, ast.AsyncFunctionDef)):
return False
if isinstance(current, (ast.arguments, ast.arg)):
return True
current = getattr(current, "parent", None)
return False
def _scope_analysis(self, node):
cache_key = id(node)
cached = self._scope_analysis_cache.get(cache_key)
if cached is not None:
return cached
collector = ScopeLocalNameCollector()
args_node = getattr(node, "args", None)
if args_node is not None:
collector.visit(args_node)
for statement in getattr(node, "body", []):
collector.visit(statement)
cached = {
"reserved_names": frozenset(collector.reserved_names),
"bindings": frozenset(collector.bindings - collector.external_bindings),
"external_bindings": frozenset(collector.external_bindings),
"args": frozenset(collector.args),
}
self._scope_analysis_cache[cache_key] = cached
return cached
def _scope_bindings(self, node):
analysis = self._scope_analysis(node)
return {
"bindings": set(analysis["bindings"]),
"globals": set(analysis["external_bindings"]),
"args": set(analysis["args"]),
}
def _is_preserved_public_global_reference(self, name):
if name not in self.public_global_names:
return False
for scope in reversed(self.scope_stack):
if name in scope["globals"]:
continue
if name in scope["bindings"]:
return False
return True
def _is_preserved_function_parameter_reference(self, node):
if self.rename_arguments:
return False
if self._is_in_function_signature(node):
return False
for scope in reversed(self.scope_stack):
if node.id in scope["globals"]:
continue
if node.id in scope["bindings"]:
return node.id in scope["args"]
return False
def _is_active_parameter_name(self, name):
for scope in reversed(self.scope_stack):
if name in scope["globals"]:
continue
if name in scope["bindings"]:
if name not in scope["args"]:
return False
if not self.rename_arguments:
return True
return name not in scope.get("renamed_args", set())
return False
def _local_scope_state(self, node):
analysis = self._scope_analysis(node)
reserved_names = set(analysis["reserved_names"])
local_bindings = analysis["bindings"]
for name in analysis["reserved_names"] - local_bindings:
visible_name = self._lookup_visible_identifier(name)
if visible_name is not None:
reserved_names.add(visible_name)
used_names = set(reserved_names)
return {
"mapping": {},
"used_names": used_names,
"generator": variable_name_generator(used_names),
}
def _receiver_class_name(self, node):
if isinstance(node, ast.Name):
return self._lookup_instance_type(node.id)
if isinstance(node, ast.Call):
func = node.func
if isinstance(func, ast.Name):
if func.id in self.class_member_mappings or func.id in self.class_method_argument_infos:
return func.id
class_context = self._current_class_context()
if class_context is not None and func.id in {
class_context["old_name"],
class_context["new_name"],
}:
return func.id
return None
def _record_instance_assignment(self, target, value):
class_name = self._receiver_class_name(value)
if isinstance(target, ast.Name):
self._set_instance_type(target.id, class_name)
return
if isinstance(target, (ast.Tuple, ast.List)):
for element in target.elts:
self._record_instance_assignment(element, value)
def _visit_ImportOrImportFrom(self, node):
"""Shorten imported library names.
>>> shortener = VariableShortener(variable_name_generator(), modules=('donotaliasme',))
>>> apply = lambda src: ast.unparse(shortener.visit(ast.parse(src)))
>>> apply('import demiurgic')
'import demiurgic as a'
>>> apply('from demiurgic import palpitation')
'from demiurgic import palpitation as b'
>>> apply('from demiurgic import a') # single-letter import should be left alone
'from demiurgic import a'
>>> print(apply('import demiurgic;demiurgic.palpitation()')) # TODO: bug - variable should remember object its bound to
import demiurgic as a
a.palpitation()
>>> print(apply('import demiurgic as dei;dei.palpitation()'))
import demiurgic as c
c.palpitation()
>>> print(apply('import demiurgic;import donotaliasme;from donotaliasme import dolor;'))
import demiurgic as a
import donotaliasme
from donotaliasme import dolor
"""
if self.keep_global_variables and self._is_node_global(node):
return self.generic_visit(node)
if isinstance(node, ast.Import) or node.module not in self.modules:
for alias in node.names:
if isinstance(node, ast.ImportFrom) or alias.name not in self.modules:
old = alias.asname or alias.name
if len(old) > 1:
alias.asname = self._rename_identifier(old)
return self.generic_visit(node)
visit_Import = _visit_ImportOrImportFrom
visit_ImportFrom = _visit_ImportOrImportFrom
def visit_ClassDef(self, node):
"""Shorten class names.
>>> shortener = VariableShortener(variable_name_generator())
>>> apply = lambda src: ast.unparse(shortener.visit(ast.parse(src)))
>>> apply('class Demiurgic: pass\\nholy = Demiurgic()')
'class a:\\n pass\\nb = a()'
>>> shortener = VariableShortener(variable_name_generator(), keep_global_variables=True)
>>> def apply(src):
... tree = ast.parse(src)
... shortener.visit(tree)
... append_public_aliases(tree, shortener.nodes_to_append)
... return ast.unparse(tree)
...
>>> apply('class Demiurgic: pass\\nholy = Demiurgic()')
'class Demiurgic:\\n pass\\nholy = Demiurgic()'
"""
old_name = node.name
parent_class_context = self._current_class_context()
rename_public_class = False
if self.keep_global_variables and self._is_node_global(node):
if (
len(node.name) > 1
and node.name not in self.mapping_values
and self._should_rename_public_class(node, old_name)
):
node.name = self._rename_identifier(old_name)
rename_public_class = old_name != node.name
class_context = {
"old_name": old_name,
"new_name": node.name,
"aliases": [],
"member_mapping": {},
"argument_infos": {},
"receiver_names": {"self", "cls"},
}
self.class_context_stack.append(class_context)
self.scope_stack.append(self._scope_bindings(node))
self._push_instance_scope()
try:
node = self.generic_visit(node)
finally:
self._pop_instance_scope()
self.scope_stack.pop()
self.class_context_stack.pop()
if class_context["member_mapping"]:
self.class_member_mappings[old_name] = dict(class_context["member_mapping"])
self.class_member_mappings[node.name] = dict(class_context["member_mapping"])
if class_context["argument_infos"]:
self.class_method_argument_infos[old_name] = dict(class_context["argument_infos"])
self.class_method_argument_infos[node.name] = dict(class_context["argument_infos"])
constructor_info = class_context["argument_infos"].get("__init__")
if constructor_info is not None:
copied = {
"rename_map": dict(constructor_info["rename_map"]),
"positional_params": list(constructor_info["positional_params"]),
}
self.callable_argument_infos[old_name] = copied
self.callable_argument_infos[node.name] = {
"rename_map": dict(copied["rename_map"]),
"positional_params": list(copied["positional_params"]),
}
if class_context["aliases"]:
node.body.extend(class_context["aliases"])
if rename_public_class:
return [
node,
self._generated_assignment(f"{old_name} = {node.name}"),
self._generated_assignment(f"{node.name}.__name__ = {old_name!r}"),
self._generated_assignment(f"{node.name}.__qualname__ = {old_name!r}"),
]
return node
if self.local_rename_scopes and not self._is_node_global(node):
node.name = self._rename_local_identifier(node.name)
elif node.name not in self.mapping_values:
node.name = self._rename_identifier(node.name)
if parent_class_context is not None and old_name != node.name:
parent_class_context["member_mapping"][old_name] = node.name
if self.keep_global_variables:
parent_class_context["aliases"].append(
self._generated_assignment(f"{old_name} = {node.name}")
)
class_context = {
"old_name": old_name,
"new_name": node.name,
"aliases": [],
"member_mapping": {},
"argument_infos": {},
"receiver_names": {"self", "cls"},
}
self.class_context_stack.append(class_context)
self.scope_stack.append(self._scope_bindings(node))
self._push_instance_scope()
try:
node = self.generic_visit(node)
finally:
self._pop_instance_scope()
self.scope_stack.pop()
self.class_context_stack.pop()
if class_context["member_mapping"]:
self.class_member_mappings[old_name] = dict(class_context["member_mapping"])
self.class_member_mappings[node.name] = dict(class_context["member_mapping"])
if class_context["argument_infos"]:
self.class_method_argument_infos[old_name] = dict(class_context["argument_infos"])
self.class_method_argument_infos[node.name] = dict(class_context["argument_infos"])
constructor_info = class_context["argument_infos"].get("__init__")
if constructor_info is not None:
copied = {
"rename_map": dict(constructor_info["rename_map"]),
"positional_params": list(constructor_info["positional_params"]),
}
self.callable_argument_infos[old_name] = copied
self.callable_argument_infos[node.name] = {
"rename_map": dict(copied["rename_map"]),
"positional_params": list(copied["positional_params"]),
}
return node
def visit_FunctionDef(self, node):
"""Shorten function names.
>>> shortener = VariableShortener(variable_name_generator())
>>> apply = lambda src: ast.unparse(shortener.visit(ast.parse(src)))
>>> apply('def demiurgic(palpitation): return palpitation\\nholy = demiurgic()')
'def a(palpitation):\\n return palpitation\\nb = a()'
>>> shortener = VariableShortener(variable_name_generator(), keep_global_variables=True)
>>> def apply(src):
... tree = ast.parse(src)
... shortener.visit(tree)
... append_public_aliases(tree, shortener.nodes_to_append)
... return ast.unparse(tree)
...
>>> apply('def demiurgic(palpitation): return palpitation\\nholy = demiurgic()')
'def a(palpitation):\\n return palpitation\\nholy = a()\\ndemiurgic = a'
"""
old_name = node.name
if self._preserve_function_name(node.name):
self.scope_stack.append(self._scope_bindings(node))
self.local_rename_scopes.append(self._local_scope_state(node))
self._push_instance_scope()
try:
argument_info = self._rename_function_arguments(node)
self.scope_stack[-1]["renamed_args"] = set(argument_info["rename_map"])
class_context = self._current_class_context()
if class_context is not None:
class_context["receiver_names"].update(argument_info["receiver_names"])
if argument_info["rename_map"] or argument_info["positional_params"]:
copied = {
"rename_map": dict(argument_info["rename_map"]),
"positional_params": list(argument_info["positional_params"]),
}
class_context["argument_infos"][old_name] = copied
return self.generic_visit(node)
finally:
self._pop_instance_scope()
self.local_rename_scopes.pop()
self.scope_stack.pop()
if self._is_method_definition(node):
class_context = self._current_class_context()
class_name = class_context["old_name"] if class_context is not None else ""
if (
len(old_name) > 1
and (
not self.keep_global_variables
or class_context is None
or self._should_rename_public_member(node.parent, class_name, old_name)
)
):
node.name = self._rename_identifier(old_name)
if class_context is not None and old_name != node.name:
class_context["member_mapping"][old_name] = node.name
if self.keep_global_variables:
class_context["aliases"].append(
self._generated_assignment(f"{old_name} = {node.name}")
)
self.scope_stack.append(self._scope_bindings(node))
self.local_rename_scopes.append(self._local_scope_state(node))
self._push_instance_scope()
try:
argument_info = self._rename_function_arguments(node)
self.scope_stack[-1]["renamed_args"] = set(argument_info["rename_map"])