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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
|
# copyright 2003-2013 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of astroid.
#
# astroid is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation, either version 2.1 of the License, or (at your
# option) any later version.
#
# astroid is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
# for more details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with astroid. If not, see <http://www.gnu.org/licenses/>.
"""Module for some node classes. More nodes in scoped_nodes.py
"""
import abc
import pprint
import warnings
try:
from functools import singledispatch as _singledispatch
except ImportError:
from singledispatch import singledispatch as _singledispatch
import six
from astroid import as_string
from astroid import bases
from astroid import context as contextmod
from astroid import decorators
from astroid import exceptions
from astroid import manager
from astroid import mixins
from astroid import util
BUILTINS = six.moves.builtins.__name__
MANAGER = manager.AstroidManager()
def unpack_infer(stmt, context=None):
"""recursively generate nodes inferred by the given statement.
If the inferred value is a list or a tuple, recurse on the elements
"""
if isinstance(stmt, (List, Tuple)):
for elt in stmt.elts:
for inferred_elt in unpack_infer(elt, context):
yield inferred_elt
return
# if inferred is a final node, return it and stop
inferred = next(stmt.infer(context))
if inferred is stmt:
yield inferred
return
# else, infer recursivly, except YES object that should be returned as is
for inferred in stmt.infer(context):
if inferred is util.YES:
yield inferred
else:
for inf_inf in unpack_infer(inferred, context):
yield inf_inf
def are_exclusive(stmt1, stmt2, exceptions=None):
"""return true if the two given statements are mutually exclusive
`exceptions` may be a list of exception names. If specified, discard If
branches and check one of the statement is in an exception handler catching
one of the given exceptions.
algorithm :
1) index stmt1's parents
2) climb among stmt2's parents until we find a common parent
3) if the common parent is a If or TryExcept statement, look if nodes are
in exclusive branches
"""
# index stmt1's parents
stmt1_parents = {}
children = {}
node = stmt1.parent
previous = stmt1
while node:
stmt1_parents[node] = 1
children[node] = previous
previous = node
node = node.parent
# climb among stmt2's parents until we find a common parent
node = stmt2.parent
previous = stmt2
while node:
if node in stmt1_parents:
# if the common parent is a If or TryExcept statement, look if
# nodes are in exclusive branches
if isinstance(node, If) and exceptions is None:
if (node.locate_child(previous)[1]
is not node.locate_child(children[node])[1]):
return True
elif isinstance(node, TryExcept):
c2attr, c2node = node.locate_child(previous)
c1attr, c1node = node.locate_child(children[node])
if c1node is not c2node:
if ((c2attr == 'body'
and c1attr == 'handlers'
and children[node].catch(exceptions)) or
(c2attr == 'handlers' and c1attr == 'body' and previous.catch(exceptions)) or
(c2attr == 'handlers' and c1attr == 'orelse') or
(c2attr == 'orelse' and c1attr == 'handlers')):
return True
elif c2attr == 'handlers' and c1attr == 'handlers':
return previous is not children[node]
return False
previous = node
node = node.parent
return False
def _container_getitem(instance, elts, index):
"""Get a slice or an item, using the given *index*, for the given sequence."""
if isinstance(index, slice):
new_cls = instance.__class__()
new_cls.elts = elts[index]
new_cls.parent = instance.parent
return new_cls
else:
return elts[index]
class NodeNG(object):
"""Base Class for all Astroid node classes.
It represents a node of the new abstract syntax tree.
"""
is_statement = False
optional_assign = False # True for For (and for Comprehension if py <3.0)
is_function = False # True for FunctionDef nodes
# attributes below are set by the builder module or by raw factories
lineno = None
col_offset = None
# parent node in the tree
parent = None
# attributes containing child node(s) redefined in most concrete classes:
_astroid_fields = ()
# attributes containing non-nodes:
_other_fields = ()
# attributes containing AST-dependent fields:
_other_other_fields = ()
# instance specific inference function infer(node, context)
_explicit_inference = None
def __init__(self, lineno=None, col_offset=None, parent=None):
self.lineno = lineno
self.col_offset = col_offset
self.parent = parent
def infer(self, context=None, **kwargs):
"""main interface to the interface system, return a generator on inferred
values.
If the instance has some explicit inference function set, it will be
called instead of the default interface.
"""
if self._explicit_inference is not None:
# explicit_inference is not bound, give it self explicitly
try:
# pylint: disable=not-callable
return self._explicit_inference(self, context, **kwargs)
except exceptions.UseInferenceDefault:
pass
if not context:
return self._infer(context, **kwargs)
key = (self, context.lookupname,
context.callcontext, context.boundnode)
if key in context.inferred:
return iter(context.inferred[key])
return context.cache_generator(key, self._infer(context, **kwargs))
def _repr_name(self):
"""return self.name or self.attrname or '' for nice representation"""
return getattr(self, 'name', getattr(self, 'attrname', ''))
def __str__(self):
rname = self._repr_name()
cname = type(self).__name__
if rname:
string = '%(cname)s.%(rname)s(%(fields)s)'
alignment = len(cname) + len(rname) + 2
else:
string = '%(cname)s(%(fields)s)'
alignment = len(cname) + 1
result = []
for field in self._other_fields + self._astroid_fields:
value = getattr(self, field)
width = 80 - len(field) - alignment
lines = pprint.pformat(value, indent=2,
width=width).splitlines(True)
inner = [lines[0]]
for line in lines[1:]:
inner.append(' ' * alignment + line)
result.append('%s=%s' % (field, ''.join(inner)))
return string % {'cname': cname,
'rname': rname,
'fields': (',\n' + ' ' * alignment).join(result)}
def __repr__(self):
rname = self._repr_name()
if rname:
string = '<%(cname)s.%(rname)s l.%(lineno)s at 0x%(id)x>'
else:
string = '<%(cname)s l.%(lineno)s at 0x%(id)x>'
return string % {'cname': type(self).__name__,
'rname': rname,
'lineno': self.fromlineno,
'id': id(self)}
def accept(self, visitor):
func = getattr(visitor, "visit_" + self.__class__.__name__.lower())
return func(self)
def get_children(self):
for field in self._astroid_fields:
attr = getattr(self, field)
if attr is None:
continue
if isinstance(attr, (list, tuple)):
for elt in attr:
yield elt
else:
yield attr
def last_child(self):
"""an optimized version of list(get_children())[-1]"""
for field in self._astroid_fields[::-1]:
attr = getattr(self, field)
if not attr: # None or empty listy / tuple
continue
if isinstance(attr, (list, tuple)):
return attr[-1]
else:
return attr
return None
def parent_of(self, node):
"""return true if i'm a parent of the given node"""
parent = node.parent
while parent is not None:
if self is parent:
return True
parent = parent.parent
return False
def statement(self):
"""return the first parent node marked as statement node"""
if self.is_statement:
return self
return self.parent.statement()
def frame(self):
"""return the first parent frame node (i.e. Module, FunctionDef or
ClassDef)
"""
return self.parent.frame()
def scope(self):
"""return the first node defining a new scope (i.e. Module,
FunctionDef, ClassDef, Lambda but also GenExpr)
"""
return self.parent.scope()
def root(self):
"""return the root node of the tree, (i.e. a Module)"""
if self.parent:
return self.parent.root()
return self
def child_sequence(self, child):
"""search for the right sequence where the child lies in"""
for field in self._astroid_fields:
node_or_sequence = getattr(self, field)
if node_or_sequence is child:
return [node_or_sequence]
# /!\ compiler.ast Nodes have an __iter__ walking over child nodes
if (isinstance(node_or_sequence, (tuple, list))
and child in node_or_sequence):
return node_or_sequence
msg = 'Could not find %s in %s\'s children'
raise exceptions.AstroidError(msg % (repr(child), repr(self)))
def locate_child(self, child):
"""return a 2-uple (child attribute name, sequence or node)"""
for field in self._astroid_fields:
node_or_sequence = getattr(self, field)
# /!\ compiler.ast Nodes have an __iter__ walking over child nodes
if child is node_or_sequence:
return field, child
if isinstance(node_or_sequence, (tuple, list)) and child in node_or_sequence:
return field, node_or_sequence
msg = 'Could not find %s in %s\'s children'
raise exceptions.AstroidError(msg % (repr(child), repr(self)))
# FIXME : should we merge child_sequence and locate_child ? locate_child
# is only used in are_exclusive, child_sequence one time in pylint.
def next_sibling(self):
"""return the next sibling statement"""
return self.parent.next_sibling()
def previous_sibling(self):
"""return the previous sibling statement"""
return self.parent.previous_sibling()
def nearest(self, nodes):
"""return the node which is the nearest before this one in the
given list of nodes
"""
myroot = self.root()
mylineno = self.fromlineno
nearest = None, 0
for node in nodes:
assert node.root() is myroot, \
'nodes %s and %s are not from the same module' % (self, node)
lineno = node.fromlineno
if node.fromlineno > mylineno:
break
if lineno > nearest[1]:
nearest = node, lineno
# FIXME: raise an exception if nearest is None ?
return nearest[0]
# these are lazy because they're relatively expensive to compute for every
# single node, and they rarely get looked at
@decorators.cachedproperty
def fromlineno(self):
if self.lineno is None:
return self._fixed_source_line()
else:
return self.lineno
@decorators.cachedproperty
def tolineno(self):
if not self._astroid_fields:
# can't have children
lastchild = None
else:
lastchild = self.last_child()
if lastchild is None:
return self.fromlineno
else:
return lastchild.tolineno
# TODO / FIXME:
assert self.fromlineno is not None, self
assert self.tolineno is not None, self
def _fixed_source_line(self):
"""return the line number where the given node appears
we need this method since not all nodes have the lineno attribute
correctly set...
"""
line = self.lineno
_node = self
try:
while line is None:
_node = next(_node.get_children())
line = _node.lineno
except StopIteration:
_node = self.parent
while _node and line is None:
line = _node.lineno
_node = _node.parent
return line
def block_range(self, lineno):
"""handle block line numbers range for non block opening statements
"""
return lineno, self.tolineno
def set_local(self, name, stmt):
"""delegate to a scoped parent handling a locals dictionary"""
self.parent.set_local(name, stmt)
def nodes_of_class(self, klass, skip_klass=None):
"""return an iterator on nodes which are instance of the given class(es)
klass may be a class object or a tuple of class objects
"""
if isinstance(self, klass):
yield self
for child_node in self.get_children():
if skip_klass is not None and isinstance(child_node, skip_klass):
continue
for matching in child_node.nodes_of_class(klass, skip_klass):
yield matching
def _infer_name(self, frame, name):
# overridden for ImportFrom, Import, Global, TryExcept and Arguments
return None
def _infer(self, context=None):
"""we don't know how to resolve a statement by default"""
# this method is overridden by most concrete classes
raise exceptions.InferenceError(self.__class__.__name__)
def inferred(self):
'''return list of inferred values for a more simple inference usage'''
return list(self.infer())
def infered(self):
warnings.warn('%s.infered() is deprecated and slated for removal '
'in astroid 2.0, use %s.inferred() instead.'
% (type(self).__name__, type(self).__name__),
PendingDeprecationWarning, stacklevel=2)
return self.inferred()
def instanciate_class(self):
"""instanciate a node if it is a ClassDef node, else return self"""
return self
def has_base(self, node):
return False
def callable(self):
return False
def eq(self, value):
return False
def as_string(self):
return as_string.to_code(self)
def repr_tree(self, ids=False, include_linenos=False,
ast_state=False, indent=' ', max_depth=0, max_width=80):
"""Returns a string representation of the AST from this node.
:param ids: If true, includes the ids with the node type names.
:param include_linenos: If true, includes the line numbers and
column offsets.
:param ast_state: If true, includes information derived from
the whole AST like local and global variables.
:param indent: A string to use to indent the output string.
:param max_depth: If set to a positive integer, won't return
nodes deeper than max_depth in the string.
:param max_width: Only positive integer values are valid, the
default is 80. Attempts to format the output string to stay
within max_width characters, but can exceed it under some
circumstances.
"""
@_singledispatch
def _repr_tree(node, result, done, cur_indent='', depth=1):
"""Outputs a representation of a non-tuple/list, non-node that's
contained within an AST, including strings.
"""
lines = pprint.pformat(node,
width=max(max_width - len(cur_indent),
1)).splitlines(True)
result.append(lines[0])
result.extend([cur_indent + line for line in lines[1:]])
return len(lines) != 1
# pylint: disable=unused-variable; doesn't understand singledispatch
@_repr_tree.register(tuple)
@_repr_tree.register(list)
def _repr_seq(node, result, done, cur_indent='', depth=1):
"""Outputs a representation of a sequence that's contained within an AST."""
cur_indent += indent
result.append('[')
if len(node) == 0:
broken = False
elif len(node) == 1:
broken = _repr_tree(node[0], result, done, cur_indent, depth)
elif len(node) == 2:
broken = _repr_tree(node[0], result, done, cur_indent, depth)
if not broken:
result.append(', ')
else:
result.append(',\n')
result.append(cur_indent)
broken = (_repr_tree(node[1], result, done, cur_indent, depth)
or broken)
else:
result.append('\n')
result.append(cur_indent)
for child in node[:-1]:
_repr_tree(child, result, done, cur_indent, depth)
result.append(',\n')
result.append(cur_indent)
_repr_tree(node[-1], result, done, cur_indent, depth)
broken = True
result.append(']')
return broken
# pylint: disable=unused-variable; doesn't understand singledispatch
@_repr_tree.register(NodeNG)
def _repr_node(node, result, done, cur_indent='', depth=1):
"""Outputs a strings representation of an astroid node."""
if node in done:
result.append(indent + '<Recursion on %s with id=%s' %
(type(node).__name__, id(node)))
return False
else:
done.add(node)
if max_depth and depth > max_depth:
result.append('...')
return False
depth += 1
cur_indent += indent
if ids:
result.append('%s<0x%x>(\n' % (type(node).__name__, id(node)))
else:
result.append('%s(' % type(node).__name__)
fields = []
if include_linenos:
fields.extend(('lineno', 'col_offset'))
fields.extend(node._other_fields)
fields.extend(node._astroid_fields)
if ast_state:
fields.extend(node._other_other_fields)
if len(fields) == 0:
broken = False
elif len(fields) == 1:
result.append('%s=' % fields[0])
broken = _repr_tree(getattr(node, fields[0]), result, done,
cur_indent, depth)
else:
result.append('\n')
result.append(cur_indent)
for field in fields[:-1]:
result.append('%s=' % field)
_repr_tree(getattr(node, field), result, done, cur_indent,
depth)
result.append(',\n')
result.append(cur_indent)
result.append('%s=' % fields[-1])
_repr_tree(getattr(node, fields[-1]), result, done, cur_indent,
depth)
broken = True
result.append(')')
return broken
result = []
_repr_tree(self, result, set())
return ''.join(result)
def bool_value(self):
"""Determine the bool value of this node
The boolean value of a node can have three
possible values:
* False. For instance, empty data structures,
False, empty strings, instances which return
explicitly False from the __nonzero__ / __bool__
method.
* True. Most of constructs are True by default:
classes, functions, modules etc
* YES: the inference engine is uncertain of the
node's value.
"""
return util.YES
class Statement(NodeNG):
"""Statement node adding a few attributes"""
is_statement = True
def next_sibling(self):
"""return the next sibling statement"""
stmts = self.parent.child_sequence(self)
index = stmts.index(self)
try:
return stmts[index +1]
except IndexError:
pass
def previous_sibling(self):
"""return the previous sibling statement"""
stmts = self.parent.child_sequence(self)
index = stmts.index(self)
if index >= 1:
return stmts[index -1]
@six.add_metaclass(abc.ABCMeta)
class _BaseContainer(mixins.ParentAssignTypeMixin,
NodeNG, bases.Instance):
"""Base class for Set, FrozenSet, Tuple and List."""
_astroid_fields = ('elts',)
def __init__(self, lineno=None, col_offset=None, parent=None):
self.elts = []
super(_BaseContainer, self).__init__(lineno, col_offset, parent)
def postinit(self, elts):
self.elts = elts
@classmethod
def from_constants(cls, elts=None):
# pylint: disable=abstract-class-instantiated; False positive on Pylint #627.
node = cls()
if elts is None:
node.elts = []
else:
node.elts = [const_factory(e) for e in elts]
return node
def itered(self):
return self.elts
def bool_value(self):
return bool(self.elts)
@abc.abstractmethod
def pytype(self):
pass
class LookupMixIn(object):
"""Mixin looking up a name in the right scope
"""
def lookup(self, name):
"""lookup a variable name
return the scope node and the list of assignments associated to the
given name according to the scope where it has been found (locals,
globals or builtin)
The lookup is starting from self's scope. If self is not a frame itself
and the name is found in the inner frame locals, statements will be
filtered to remove ignorable statements according to self's location
"""
return self.scope().scope_lookup(self, name)
def ilookup(self, name):
"""inferred lookup
return an iterator on inferred values of the statements returned by
the lookup method
"""
frame, stmts = self.lookup(name)
context = contextmod.InferenceContext()
return bases._infer_stmts(stmts, context, frame)
def _filter_stmts(self, stmts, frame, offset):
"""filter statements to remove ignorable statements.
If self is not a frame itself and the name is found in the inner
frame locals, statements will be filtered to remove ignorable
statements according to self's location
"""
# if offset == -1, my actual frame is not the inner frame but its parent
#
# class A(B): pass
#
# we need this to resolve B correctly
if offset == -1:
myframe = self.frame().parent.frame()
else:
myframe = self.frame()
# If the frame of this node is the same as the statement
# of this node, then the node is part of a class or
# a function definition and the frame of this node should be the
# the upper frame, not the frame of the definition.
# For more information why this is important,
# see Pylint issue #295.
# For example, for 'b', the statement is the same
# as the frame / scope:
#
# def test(b=1):
# ...
if self.statement() is myframe and myframe.parent:
myframe = myframe.parent.frame()
if not myframe is frame or self is frame:
return stmts
mystmt = self.statement()
# line filtering if we are in the same frame
#
# take care node may be missing lineno information (this is the case for
# nodes inserted for living objects)
if myframe is frame and mystmt.fromlineno is not None:
assert mystmt.fromlineno is not None, mystmt
mylineno = mystmt.fromlineno + offset
else:
# disabling lineno filtering
mylineno = 0
_stmts = []
_stmt_parents = []
for node in stmts:
stmt = node.statement()
# line filtering is on and we have reached our location, break
if mylineno > 0 and stmt.fromlineno > mylineno:
break
assert hasattr(node, 'assign_type'), (node, node.scope(),
node.scope().locals)
assign_type = node.assign_type()
if node.has_base(self):
break
_stmts, done = assign_type._get_filtered_stmts(self, node, _stmts, mystmt)
if done:
break
optional_assign = assign_type.optional_assign
if optional_assign and assign_type.parent_of(self):
# we are inside a loop, loop var assigment is hidding previous
# assigment
_stmts = [node]
_stmt_parents = [stmt.parent]
continue
# XXX comment various branches below!!!
try:
pindex = _stmt_parents.index(stmt.parent)
except ValueError:
pass
else:
# we got a parent index, this means the currently visited node
# is at the same block level as a previously visited node
if _stmts[pindex].assign_type().parent_of(assign_type):
# both statements are not at the same block level
continue
# if currently visited node is following previously considered
# assignement and both are not exclusive, we can drop the
# previous one. For instance in the following code ::
#
# if a:
# x = 1
# else:
# x = 2
# print x
#
# we can't remove neither x = 1 nor x = 2 when looking for 'x'
# of 'print x'; while in the following ::
#
# x = 1
# x = 2
# print x
#
# we can remove x = 1 when we see x = 2
#
# moreover, on loop assignment types, assignment won't
# necessarily be done if the loop has no iteration, so we don't
# want to clear previous assigments if any (hence the test on
# optional_assign)
if not (optional_assign or are_exclusive(_stmts[pindex], node)):
del _stmt_parents[pindex]
del _stmts[pindex]
if isinstance(node, AssignName):
if not optional_assign and stmt.parent is mystmt.parent:
_stmts = []
_stmt_parents = []
elif isinstance(node, DelName):
_stmts = []
_stmt_parents = []
continue
if not are_exclusive(self, node):
_stmts.append(node)
_stmt_parents.append(stmt.parent)
return _stmts
# Name classes
class AssignName(LookupMixIn, mixins.ParentAssignTypeMixin, NodeNG):
"""class representing an AssignName node"""
_other_fields = ('name',)
def __init__(self, name=None, lineno=None, col_offset=None, parent=None):
self.name = name
super(AssignName, self).__init__(lineno, col_offset, parent)
class DelName(LookupMixIn, mixins.ParentAssignTypeMixin, NodeNG):
"""class representing a DelName node"""
_other_fields = ('name',)
def __init__(self, name=None, lineno=None, col_offset=None, parent=None):
self.name = name
super(DelName, self).__init__(lineno, col_offset, parent)
class Name(LookupMixIn, NodeNG):
"""class representing a Name node"""
_other_fields = ('name',)
def __init__(self, name=None, lineno=None, col_offset=None, parent=None):
self.name = name
super(Name, self).__init__(lineno, col_offset, parent)
class Arguments(mixins.AssignTypeMixin, NodeNG):
"""class representing an Arguments node"""
if six.PY3:
# Python 3.4+ uses a different approach regarding annotations,
# each argument is a new class, _ast.arg, which exposes an
# 'annotation' attribute. In astroid though, arguments are exposed
# as is in the Arguments node and the only way to expose annotations
# is by using something similar with Python 3.3:
# - we expose 'varargannotation' and 'kwargannotation' of annotations
# of varargs and kwargs.
# - we expose 'annotation', a list with annotations for
# for each normal argument. If an argument doesn't have an
# annotation, its value will be None.
_astroid_fields = ('args', 'defaults', 'kwonlyargs',
'kw_defaults', 'annotations', 'varargannotation',
'kwargannotation')
varargannotation = None
kwargannotation = None
else:
_astroid_fields = ('args', 'defaults', 'kwonlyargs', 'kw_defaults')
_other_fields = ('vararg', 'kwarg')
def __init__(self, vararg=None, kwarg=None, parent=None):
self.vararg = vararg
self.kwarg = kwarg
self.parent = parent
self.args = []
self.defaults = []
self.kwonlyargs = []
self.kw_defaults = []
self.annotations = []
def postinit(self, args, defaults, kwonlyargs, kw_defaults,
annotations, varargannotation=None, kwargannotation=None):
self.args = args
self.defaults = defaults
self.kwonlyargs = kwonlyargs
self.kw_defaults = kw_defaults
self.annotations = annotations
self.varargannotation = varargannotation
self.kwargannotation = kwargannotation
def _infer_name(self, frame, name):
if self.parent is frame:
return name
return None
@decorators.cachedproperty
def fromlineno(self):
lineno = super(Arguments, self).fromlineno
return max(lineno, self.parent.fromlineno or 0)
def format_args(self):
"""return arguments formatted as string"""
result = []
if self.args:
result.append(
_format_args(self.args, self.defaults,
getattr(self, 'annotations', None))
)
if self.vararg:
result.append('*%s' % self.vararg)
if self.kwonlyargs:
if not self.vararg:
result.append('*')
result.append(_format_args(self.kwonlyargs, self.kw_defaults))
if self.kwarg:
result.append('**%s' % self.kwarg)
return ', '.join(result)
def default_value(self, argname):
"""return the default value for an argument
:raise `NoDefault`: if there is no default value defined
"""
i = _find_arg(argname, self.args)[0]
if i is not None:
idx = i - (len(self.args) - len(self.defaults))
if idx >= 0:
return self.defaults[idx]
i = _find_arg(argname, self.kwonlyargs)[0]
if i is not None and self.kw_defaults[i] is not None:
return self.kw_defaults[i]
raise exceptions.NoDefault()
def is_argument(self, name):
"""return True if the name is defined in arguments"""
if name == self.vararg:
return True
if name == self.kwarg:
return True
return self.find_argname(name, True)[1] is not None
def find_argname(self, argname, rec=False):
"""return index and Name node with given name"""
if self.args: # self.args may be None in some cases (builtin function)
return _find_arg(argname, self.args, rec)
return None, None
def get_children(self):
"""override get_children to skip over None elements in kw_defaults"""
for child in super(Arguments, self).get_children():
if child is not None:
yield child
def _find_arg(argname, args, rec=False):
for i, arg in enumerate(args):
if isinstance(arg, Tuple):
if rec:
found = _find_arg(argname, arg.elts)
if found[0] is not None:
return found
elif arg.name == argname:
return i, arg
return None, None
def _format_args(args, defaults=None, annotations=None):
values = []
if args is None:
return ''
if annotations is None:
annotations = []
if defaults is not None:
default_offset = len(args) - len(defaults)
packed = six.moves.zip_longest(args, annotations)
for i, (arg, annotation) in enumerate(packed):
if isinstance(arg, Tuple):
values.append('(%s)' % _format_args(arg.elts))
else:
argname = arg.name
if annotation is not None:
argname += ':' + annotation.as_string()
values.append(argname)
if defaults is not None and i >= default_offset:
if defaults[i-default_offset] is not None:
values[-1] += '=' + defaults[i-default_offset].as_string()
return ', '.join(values)
class AssignAttr(mixins.ParentAssignTypeMixin, NodeNG):
"""class representing an AssignAttr node"""
_astroid_fields = ('expr',)
_other_fields = ('attrname',)
expr = None
def __init__(self, attrname=None, lineno=None, col_offset=None, parent=None):
self.attrname = attrname
super(AssignAttr, self).__init__(lineno, col_offset, parent)
def postinit(self, expr=None):
self.expr = expr
class Assert(Statement):
"""class representing an Assert node"""
_astroid_fields = ('test', 'fail',)
test = None
fail = None
def postinit(self, test=None, fail=None):
self.fail = fail
self.test = test
class Assign(mixins.AssignTypeMixin, Statement):
"""class representing an Assign node"""
_astroid_fields = ('targets', 'value',)
targets = None
value = None
def postinit(self, targets=None, value=None):
self.targets = targets
self.value = value
class AugAssign(mixins.AssignTypeMixin, Statement):
"""class representing an AugAssign node"""
_astroid_fields = ('target', 'value')
_other_fields = ('op',)
target = None
value = None
def __init__(self, op=None, lineno=None, col_offset=None, parent=None):
self.op = op
super(AugAssign, self).__init__(lineno, col_offset, parent)
def postinit(self, target=None, value=None):
self.target = target
self.value = value
# This is set by inference.py
def _infer_augassign(self, context=None):
raise NotImplementedError
def type_errors(self, context=None):
"""Return a list of TypeErrors which can occur during inference.
Each TypeError is represented by a :class:`BinaryOperationError`,
which holds the original exception.
"""
try:
results = self._infer_augassign(context=context)
return [result for result in results
if isinstance(result, exceptions.BinaryOperationError)]
except exceptions.InferenceError:
return []
class Repr(NodeNG):
"""class representing a Repr node"""
_astroid_fields = ('value',)
value = None
def postinit(self, value=None):
self.value = value
class BinOp(NodeNG):
"""class representing a BinOp node"""
_astroid_fields = ('left', 'right')
_other_fields = ('op',)
left = None
right = None
def __init__(self, op=None, lineno=None, col_offset=None, parent=None):
self.op = op
super(BinOp, self).__init__(lineno, col_offset, parent)
def postinit(self, left=None, right=None):
self.left = left
self.right = right
# This is set by inference.py
def _infer_binop(self, context=None):
raise NotImplementedError
def type_errors(self, context=None):
"""Return a list of TypeErrors which can occur during inference.
Each TypeError is represented by a :class:`BinaryOperationError`,
which holds the original exception.
"""
try:
results = self._infer_binop(context=context)
return [result for result in results
if isinstance(result, exceptions.BinaryOperationError)]
except exceptions.InferenceError:
return []
class BoolOp(NodeNG):
"""class representing a BoolOp node"""
_astroid_fields = ('values',)
_other_fields = ('op',)
values = None
def __init__(self, op=None, lineno=None, col_offset=None, parent=None):
self.op = op
super(BoolOp, self).__init__(lineno, col_offset, parent)
def postinit(self, values=None):
self.values = values
class Break(Statement):
"""class representing a Break node"""
class Call(NodeNG):
"""class representing a Call node"""
_astroid_fields = ('func', 'args', 'keywords')
func = None
args = None
keywords = None
def postinit(self, func=None, args=None, keywords=None):
self.func = func
self.args = args
self.keywords = keywords
@property
def starargs(self):
args = self.args or []
return [arg for arg in args if isinstance(arg, Starred)]
@property
def kwargs(self):
keywords = self.keywords or []
return [keyword for keyword in keywords if keyword.arg is None]
class Compare(NodeNG):
"""class representing a Compare node"""
_astroid_fields = ('left', 'ops',)
left = None
ops = None
def postinit(self, left=None, ops=None):
self.left = left
self.ops = ops
def get_children(self):
"""override get_children for tuple fields"""
yield self.left
for _, comparator in self.ops:
yield comparator # we don't want the 'op'
def last_child(self):
"""override last_child"""
# XXX maybe if self.ops:
return self.ops[-1][1]
#return self.left
class Comprehension(NodeNG):
"""class representing a Comprehension node"""
_astroid_fields = ('target', 'iter', 'ifs')
target = None
iter = None
ifs = None
def __init__(self, parent=None):
self.parent = parent
def postinit(self, target=None, iter=None, ifs=None):
self.target = target
self.iter = iter
self.ifs = ifs
optional_assign = True
def assign_type(self):
return self
def ass_type(self):
warnings.warn('%s.ass_type() is deprecated and slated for removal'
'in astroid 2.0, use %s.assign_type() instead.'
% (type(self).__name__, type(self).__name__),
PendingDeprecationWarning, stacklevel=2)
return self.assign_type()
def _get_filtered_stmts(self, lookup_node, node, stmts, mystmt):
"""method used in filter_stmts"""
if self is mystmt:
if isinstance(lookup_node, (Const, Name)):
return [lookup_node], True
elif self.statement() is mystmt:
# original node's statement is the assignment, only keeps
# current node (gen exp, list comp)
return [node], True
return stmts, False
class Const(NodeNG, bases.Instance):
"""represent a constant node like num, str, bool, None, bytes"""
_other_fields = ('value',)
def __init__(self, value, lineno=None, col_offset=None, parent=None):
self.value = value
super(Const, self).__init__(lineno, col_offset, parent)
def getitem(self, index, context=None):
if isinstance(self.value, six.string_types):
return Const(self.value[index])
if isinstance(self.value, bytes) and six.PY3:
# Bytes aren't instances of six.string_types
# on Python 3. Also, indexing them should return
# integers.
return Const(self.value[index])
raise TypeError('%r (value=%s)' % (self, self.value))
def has_dynamic_getattr(self):
return False
def itered(self):
if isinstance(self.value, six.string_types):
return self.value
raise TypeError()
def pytype(self):
return self._proxied.qname()
def bool_value(self):
return bool(self.value)
class Continue(Statement):
"""class representing a Continue node"""
class Decorators(NodeNG):
"""class representing a Decorators node"""
_astroid_fields = ('nodes',)
nodes = None
def postinit(self, nodes):
self.nodes = nodes
def scope(self):
# skip the function node to go directly to the upper level scope
return self.parent.parent.scope()
class DelAttr(mixins.ParentAssignTypeMixin, NodeNG):
"""class representing a DelAttr node"""
_astroid_fields = ('expr',)
_other_fields = ('attrname',)
expr = None
def __init__(self, attrname=None, lineno=None, col_offset=None, parent=None):
self.attrname = attrname
super(DelAttr, self).__init__(lineno, col_offset, parent)
def postinit(self, expr=None):
self.expr = expr
class Delete(mixins.AssignTypeMixin, Statement):
"""class representing a Delete node"""
_astroid_fields = ('targets',)
targets = None
def postinit(self, targets=None):
self.targets = targets
class Dict(NodeNG, bases.Instance):
"""class representing a Dict node"""
_astroid_fields = ('items',)
def __init__(self, lineno=None, col_offset=None, parent=None):
self.items = []
super(Dict, self).__init__(lineno, col_offset, parent)
def postinit(self, items):
self.items = items
@classmethod
def from_constants(cls, items=None):
node = cls()
if items is None:
node.items = []
else:
node.items = [(const_factory(k), const_factory(v))
for k, v in items.items()]
return node
def pytype(self):
return '%s.dict' % BUILTINS
def get_children(self):
"""get children of a Dict node"""
# overrides get_children
for key, value in self.items:
yield key
yield value
def last_child(self):
"""override last_child"""
if self.items:
return self.items[-1][1]
return None
def itered(self):
return self.items[::2]
def getitem(self, lookup_key, context=None):
for key, value in self.items:
# TODO(cpopa): no support for overriding yet, {1:2, **{1: 3}}.
if isinstance(key, DictUnpack):
try:
return value.getitem(lookup_key, context)
except IndexError:
continue
for inferredkey in key.infer(context):
if inferredkey is util.YES:
continue
if isinstance(inferredkey, Const) \
and inferredkey.value == lookup_key:
return value
# This should raise KeyError, but all call sites only catch
# IndexError. Let's leave it like that for now.
raise IndexError(lookup_key)
def bool_value(self):
return bool(self.items)
class Expr(Statement):
"""class representing a Expr node"""
_astroid_fields = ('value',)
value = None
def postinit(self, value=None):
self.value = value
class Ellipsis(NodeNG): # pylint: disable=redefined-builtin
"""class representing an Ellipsis node"""
def bool_value(self):
return True
class EmptyNode(NodeNG):
"""class representing an EmptyNode node"""
class ExceptHandler(mixins.AssignTypeMixin, Statement):
"""class representing an ExceptHandler node"""
_astroid_fields = ('type', 'name', 'body',)
type = None
name = None
body = None
def postinit(self, type=None, name=None, body=None):
self.type = type
self.name = name
self.body = body
@decorators.cachedproperty
def blockstart_tolineno(self):
if self.name:
return self.name.tolineno
elif self.type:
return self.type.tolineno
else:
return self.lineno
def catch(self, exceptions):
if self.type is None or exceptions is None:
return True
for node in self.type.nodes_of_class(Name):
if node.name in exceptions:
return True
class Exec(Statement):
"""class representing an Exec node"""
_astroid_fields = ('expr', 'globals', 'locals',)
expr = None
globals = None
locals = None
def postinit(self, expr=None, globals=None, locals=None):
self.expr = expr
self.globals = globals
self.locals = locals
class ExtSlice(NodeNG):
"""class representing an ExtSlice node"""
_astroid_fields = ('dims',)
dims = None
def postinit(self, dims=None):
self.dims = dims
class For(mixins.BlockRangeMixIn, mixins.AssignTypeMixin, Statement):
"""class representing a For node"""
_astroid_fields = ('target', 'iter', 'body', 'orelse',)
target = None
iter = None
body = None
orelse = None
def postinit(self, target=None, iter=None, body=None, orelse=None):
self.target = target
self.iter = iter
self.body = body
self.orelse = orelse
optional_assign = True
@decorators.cachedproperty
def blockstart_tolineno(self):
return self.iter.tolineno
class AsyncFor(For):
"""Asynchronous For built with `async` keyword."""
class Await(NodeNG):
"""Await node for the `await` keyword."""
_astroid_fields = ('value', )
value = None
def postinit(self, value=None):
self.value = value
class ImportFrom(mixins.ImportFromMixin, Statement):
"""class representing a ImportFrom node"""
_other_fields = ('modname', 'names', 'level')
def __init__(self, fromname, names, level=0, lineno=None,
col_offset=None, parent=None):
self.modname = fromname
self.names = names
self.level = level
super(ImportFrom, self).__init__(lineno, col_offset, parent)
class Attribute(NodeNG):
"""class representing a Attribute node"""
_astroid_fields = ('expr',)
_other_fields = ('attrname',)
expr = None
def __init__(self, attrname=None, lineno=None, col_offset=None, parent=None):
self.attrname = attrname
super(Attribute, self).__init__(lineno, col_offset, parent)
def postinit(self, expr=None):
self.expr = expr
class Global(Statement):
"""class representing a Global node"""
_other_fields = ('names',)
def __init__(self, names, lineno=None, col_offset=None, parent=None):
self.names = names
super(Global, self).__init__(lineno, col_offset, parent)
def _infer_name(self, frame, name):
return name
class If(mixins.BlockRangeMixIn, Statement):
"""class representing an If node"""
_astroid_fields = ('test', 'body', 'orelse')
test = None
body = None
orelse = None
def postinit(self, test=None, body=None, orelse=None):
self.test = test
self.body = body
self.orelse = orelse
@decorators.cachedproperty
def blockstart_tolineno(self):
return self.test.tolineno
def block_range(self, lineno):
"""handle block line numbers range for if statements"""
if lineno == self.body[0].fromlineno:
return lineno, lineno
if lineno <= self.body[-1].tolineno:
return lineno, self.body[-1].tolineno
return self._elsed_block_range(lineno, self.orelse,
self.body[0].fromlineno - 1)
class IfExp(NodeNG):
"""class representing an IfExp node"""
_astroid_fields = ('test', 'body', 'orelse')
test = None
body = None
orelse = None
def postinit(self, test=None, body=None, orelse=None):
self.test = test
self.body = body
self.orelse = orelse
class Import(mixins.ImportFromMixin, Statement):
"""class representing an Import node"""
_other_fields = ('names',)
def __init__(self, names=None, lineno=None, col_offset=None, parent=None):
self.names = names
super(Import, self).__init__(lineno, col_offset, parent)
class Index(NodeNG):
"""class representing an Index node"""
_astroid_fields = ('value',)
value = None
def postinit(self, value=None):
self.value = value
class Keyword(NodeNG):
"""class representing a Keyword node"""
_astroid_fields = ('value',)
_other_fields = ('arg',)
value = None
def __init__(self, arg=None, lineno=None, col_offset=None, parent=None):
self.arg = arg
super(Keyword, self).__init__(lineno, col_offset, parent)
def postinit(self, value=None):
self.value = value
class List(_BaseContainer):
"""class representing a List node"""
def pytype(self):
return '%s.list' % BUILTINS
def getitem(self, index, context=None):
return _container_getitem(self, self.elts, index)
class Nonlocal(Statement):
"""class representing a Nonlocal node"""
_other_fields = ('names',)
def __init__(self, names, lineno=None, col_offset=None, parent=None):
self.names = names
super(Nonlocal, self).__init__(lineno, col_offset, parent)
def _infer_name(self, frame, name):
return name
class Pass(Statement):
"""class representing a Pass node"""
class Print(Statement):
"""class representing a Print node"""
_astroid_fields = ('dest', 'values',)
dest = None
values = None
def __init__(self, nl=None, lineno=None, col_offset=None, parent=None):
self.nl = nl
super(Print, self).__init__(lineno, col_offset, parent)
def postinit(self, dest=None, values=None):
self.dest = dest
self.values = values
class Raise(Statement):
"""class representing a Raise node"""
exc = None
if six.PY2:
_astroid_fields = ('exc', 'inst', 'tback')
inst = None
tback = None
def postinit(self, exc=None, inst=None, tback=None):
self.exc = exc
self.inst = inst
self.tback = tback
else:
_astroid_fields = ('exc', 'cause')
exc = None
cause = None
def postinit(self, exc=None, cause=None):
self.exc = exc
self.cause = cause
def raises_not_implemented(self):
if not self.exc:
return
for name in self.exc.nodes_of_class(Name):
if name.name == 'NotImplementedError':
return True
class Return(Statement):
"""class representing a Return node"""
_astroid_fields = ('value',)
value = None
def postinit(self, value=None):
self.value = value
class Set(_BaseContainer):
"""class representing a Set node"""
def pytype(self):
return '%s.set' % BUILTINS
class Slice(NodeNG):
"""class representing a Slice node"""
_astroid_fields = ('lower', 'upper', 'step')
lower = None
upper = None
step = None
def postinit(self, lower=None, upper=None, step=None):
self.lower = lower
self.upper = upper
self.step = step
def _wrap_attribute(self, attr):
"""Wrap the empty attributes of the Slice in a Const node."""
if not attr:
const = const_factory(attr)
const.parent = self
return const
return attr
@decorators.cachedproperty
def _proxied(self):
builtins = MANAGER.astroid_cache[BUILTINS]
return builtins.getattr('slice')[0]
def pytype(self):
return '%s.slice' % BUILTINS
def igetattr(self, attrname, context=None):
if attrname == 'start':
yield self._wrap_attribute(self.lower)
elif attrname == 'stop':
yield self._wrap_attribute(self.upper)
elif attrname == 'step':
yield self._wrap_attribute(self.step)
else:
for value in self.getattr(attrname, context=context):
yield value
def getattr(self, attrname, context=None):
return self._proxied.getattr(attrname, context)
class Starred(mixins.ParentAssignTypeMixin, NodeNG):
"""class representing a Starred node"""
_astroid_fields = ('value',)
value = None
def postinit(self, value=None):
self.value = value
class Subscript(NodeNG):
"""class representing a Subscript node"""
_astroid_fields = ('value', 'slice')
value = None
slice = None
def postinit(self, value=None, slice=None):
self.value = value
self.slice = slice
class TryExcept(mixins.BlockRangeMixIn, Statement):
"""class representing a TryExcept node"""
_astroid_fields = ('body', 'handlers', 'orelse',)
body = None
handlers = None
orelse = None
def postinit(self, body=None, handlers=None, orelse=None):
self.body = body
self.handlers = handlers
self.orelse = orelse
def _infer_name(self, frame, name):
return name
def block_range(self, lineno):
"""handle block line numbers range for try/except statements"""
last = None
for exhandler in self.handlers:
if exhandler.type and lineno == exhandler.type.fromlineno:
return lineno, lineno
if exhandler.body[0].fromlineno <= lineno <= exhandler.body[-1].tolineno:
return lineno, exhandler.body[-1].tolineno
if last is None:
last = exhandler.body[0].fromlineno - 1
return self._elsed_block_range(lineno, self.orelse, last)
class TryFinally(mixins.BlockRangeMixIn, Statement):
"""class representing a TryFinally node"""
_astroid_fields = ('body', 'finalbody',)
body = None
finalbody = None
def postinit(self, body=None, finalbody=None):
self.body = body
self.finalbody = finalbody
def block_range(self, lineno):
"""handle block line numbers range for try/finally statements"""
child = self.body[0]
# py2.5 try: except: finally:
if (isinstance(child, TryExcept) and child.fromlineno == self.fromlineno
and lineno > self.fromlineno and lineno <= child.tolineno):
return child.block_range(lineno)
return self._elsed_block_range(lineno, self.finalbody)
class Tuple(_BaseContainer):
"""class representing a Tuple node"""
def pytype(self):
return '%s.tuple' % BUILTINS
def getitem(self, index, context=None):
return _container_getitem(self, self.elts, index)
class UnaryOp(NodeNG):
"""class representing an UnaryOp node"""
_astroid_fields = ('operand',)
_other_fields = ('op',)
operand = None
def __init__(self, op=None, lineno=None, col_offset=None, parent=None):
self.op = op
super(UnaryOp, self).__init__(lineno, col_offset, parent)
def postinit(self, operand=None):
self.operand = operand
# This is set by inference.py
def _infer_unaryop(self, context=None):
raise NotImplementedError
def type_errors(self, context=None):
"""Return a list of TypeErrors which can occur during inference.
Each TypeError is represented by a :class:`UnaryOperationError`,
which holds the original exception.
"""
try:
results = self._infer_unaryop(context=context)
return [result for result in results
if isinstance(result, exceptions.UnaryOperationError)]
except exceptions.InferenceError:
return []
class While(mixins.BlockRangeMixIn, Statement):
"""class representing a While node"""
_astroid_fields = ('test', 'body', 'orelse',)
test = None
body = None
orelse = None
def postinit(self, test=None, body=None, orelse=None):
self.test = test
self.body = body
self.orelse = orelse
@decorators.cachedproperty
def blockstart_tolineno(self):
return self.test.tolineno
def block_range(self, lineno):
"""handle block line numbers range for for and while statements"""
return self. _elsed_block_range(lineno, self.orelse)
class With(mixins.BlockRangeMixIn, mixins.AssignTypeMixin, Statement):
"""class representing a With node"""
_astroid_fields = ('items', 'body')
items = None
body = None
def postinit(self, items=None, body=None):
self.items = items
self.body = body
@decorators.cachedproperty
def blockstart_tolineno(self):
return self.items[-1][0].tolineno
def get_children(self):
for expr, var in self.items:
yield expr
if var:
yield var
for elt in self.body:
yield elt
class AsyncWith(With):
"""Asynchronous `with` built with the `async` keyword."""
class Yield(NodeNG):
"""class representing a Yield node"""
_astroid_fields = ('value',)
value = None
def postinit(self, value=None):
self.value = value
class YieldFrom(Yield):
""" Class representing a YieldFrom node. """
class DictUnpack(NodeNG):
"""Represents the unpacking of dicts into dicts using PEP 448."""
# constants ##############################################################
CONST_CLS = {
list: List,
tuple: Tuple,
dict: Dict,
set: Set,
type(None): Const,
type(NotImplemented): Const,
}
def _update_const_classes():
"""update constant classes, so the keys of CONST_CLS can be reused"""
klasses = (bool, int, float, complex, str)
if six.PY2:
klasses += (unicode, long)
klasses += (bytes,)
for kls in klasses:
CONST_CLS[kls] = Const
_update_const_classes()
def const_factory(value):
"""return an astroid node for a python value"""
# XXX we should probably be stricter here and only consider stuff in
# CONST_CLS or do better treatment: in case where value is not in CONST_CLS,
# we should rather recall the builder on this value than returning an empty
# node (another option being that const_factory shouldn't be called with something
# not in CONST_CLS)
assert not isinstance(value, NodeNG)
try:
return CONST_CLS[value.__class__](value)
except (KeyError, AttributeError):
node = EmptyNode()
node.object = value
return node
# Backward-compatibility aliases
Backquote = util.proxy_alias('Backquote', Repr)
Discard = util.proxy_alias('Discard', Expr)
AssName = util.proxy_alias('AssName', AssignName)
AssAttr = util.proxy_alias('AssAttr', AssignAttr)
Getattr = util.proxy_alias('Getattr', Attribute)
CallFunc = util.proxy_alias('CallFunc', Call)
From = util.proxy_alias('From', ImportFrom)
|