-
-
Notifications
You must be signed in to change notification settings - Fork 278
/
Copy pathunittest_scoped_nodes.py
2346 lines (2091 loc) · 77.1 KB
/
unittest_scoped_nodes.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
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
# Copyright (c) 2006-2014 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
# Copyright (c) 2011, 2013-2015 Google, Inc.
# Copyright (c) 2013-2020 Claudiu Popa <pcmanticore@gmail.com>
# Copyright (c) 2013 Phil Schaf <flying-sheep@web.de>
# Copyright (c) 2014 Eevee (Alex Munroe) <amunroe@yelp.com>
# Copyright (c) 2015-2016 Ceridwen <ceridwenv@gmail.com>
# Copyright (c) 2015 Rene Zhang <rz99@cornell.edu>
# Copyright (c) 2015 Florian Bruhin <me@the-compiler.org>
# Copyright (c) 2015 Philip Lorenz <philip@bithub.de>
# Copyright (c) 2016 Jakub Wilk <jwilk@jwilk.net>
# Copyright (c) 2017, 2019 Łukasz Rogalski <rogalski.91@gmail.com>
# Copyright (c) 2017-2018 Bryce Guinta <bryce.paul.guinta@gmail.com>
# Copyright (c) 2017 Derek Gustafson <degustaf@gmail.com>
# Copyright (c) 2018-2019 Ville Skyttä <ville.skytta@iki.fi>
# Copyright (c) 2018 brendanator <brendan.maginnis@gmail.com>
# Copyright (c) 2018 Anthony Sottile <asottile@umich.edu>
# Copyright (c) 2019-2021 hippo91 <guillaume.peillex@gmail.com>
# Copyright (c) 2019 Ashley Whetter <ashley@awhetter.co.uk>
# Copyright (c) 2019 Hugo van Kemenade <hugovk@users.noreply.github.com>
# Copyright (c) 2019 Peter de Blanc <peter@standard.ai>
# Copyright (c) 2020 David Gilman <davidgilman1@gmail.com>
# Copyright (c) 2020 Tim Martin <tim@asymptotic.co.uk>
# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
# Copyright (c) 2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2021 doranid <ddandd@gmail.com>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Copyright (c) 2021 Andrew Haigh <hello@nelf.in>
# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
# For details: https://github.com/PyCQA/astroid/blob/main/LICENSE
"""tests for specific behaviour of astroid scoped nodes (i.e. module, class and
function)
"""
import datetime
import os
import sys
import textwrap
import unittest
from functools import partial
from typing import Any, List, Union
import pytest
from astroid import MANAGER, builder, nodes, objects, test_utils, util
from astroid.bases import BoundMethod, Generator, Instance, UnboundMethod
from astroid.const import PY38_PLUS
from astroid.exceptions import (
AttributeInferenceError,
DuplicateBasesError,
InconsistentMroError,
InferenceError,
MroError,
NameInferenceError,
NoDefault,
ResolveError,
TooManyLevelsError,
)
from astroid.nodes.scoped_nodes.scoped_nodes import _is_metaclass
from . import resources
try:
import six # pylint: disable=unused-import
HAS_SIX = True
except ImportError:
HAS_SIX = False
def _test_dict_interface(
self: Any,
node: Union[nodes.ClassDef, nodes.FunctionDef, nodes.Module],
test_attr: str,
) -> None:
self.assertIs(node[test_attr], node[test_attr])
self.assertIn(test_attr, node)
node.keys()
node.values()
node.items()
iter(node)
class ModuleLoader(resources.SysPathSetup):
def setUp(self) -> None:
super().setUp()
self.module = resources.build_file("data/module.py", "data.module")
self.module2 = resources.build_file("data/module2.py", "data.module2")
self.nonregr = resources.build_file("data/nonregr.py", "data.nonregr")
self.pack = resources.build_file("data/__init__.py", "data")
class ModuleNodeTest(ModuleLoader, unittest.TestCase):
def test_special_attributes(self) -> None:
self.assertEqual(len(self.module.getattr("__name__")), 1)
self.assertIsInstance(self.module.getattr("__name__")[0], nodes.Const)
self.assertEqual(self.module.getattr("__name__")[0].value, "data.module")
self.assertEqual(len(self.module.getattr("__doc__")), 1)
self.assertIsInstance(self.module.getattr("__doc__")[0], nodes.Const)
self.assertEqual(
self.module.getattr("__doc__")[0].value, "test module for astroid\n"
)
self.assertEqual(len(self.module.getattr("__file__")), 1)
self.assertIsInstance(self.module.getattr("__file__")[0], nodes.Const)
self.assertEqual(
self.module.getattr("__file__")[0].value,
os.path.abspath(resources.find("data/module.py")),
)
self.assertEqual(len(self.module.getattr("__dict__")), 1)
self.assertIsInstance(self.module.getattr("__dict__")[0], nodes.Dict)
self.assertRaises(AttributeInferenceError, self.module.getattr, "__path__")
self.assertEqual(len(self.pack.getattr("__path__")), 1)
self.assertIsInstance(self.pack.getattr("__path__")[0], nodes.List)
def test_dict_interface(self) -> None:
_test_dict_interface(self, self.module, "YO")
def test_getattr(self) -> None:
yo = self.module.getattr("YO")[0]
self.assertIsInstance(yo, nodes.ClassDef)
self.assertEqual(yo.name, "YO")
red = next(self.module.igetattr("redirect"))
self.assertIsInstance(red, nodes.FunctionDef)
self.assertEqual(red.name, "four_args")
namenode = next(self.module.igetattr("NameNode"))
self.assertIsInstance(namenode, nodes.ClassDef)
self.assertEqual(namenode.name, "Name")
# resolve packageredirection
mod = resources.build_file(
"data/appl/myConnection.py", "data.appl.myConnection"
)
ssl = next(mod.igetattr("SSL1"))
cnx = next(ssl.igetattr("Connection"))
self.assertEqual(cnx.__class__, nodes.ClassDef)
self.assertEqual(cnx.name, "Connection")
self.assertEqual(cnx.root().name, "data.SSL1.Connection1")
self.assertEqual(len(self.nonregr.getattr("enumerate")), 2)
self.assertRaises(InferenceError, self.nonregr.igetattr, "YOAA")
def test_wildcard_import_names(self) -> None:
m = resources.build_file("data/all.py", "all")
self.assertEqual(m.wildcard_import_names(), ["Aaa", "_bla", "name"])
m = resources.build_file("data/notall.py", "notall")
res = sorted(m.wildcard_import_names())
self.assertEqual(res, ["Aaa", "func", "name", "other"])
def test_public_names(self) -> None:
m = builder.parse(
"""
name = 'a'
_bla = 2
other = 'o'
class Aaa: pass
def func(): print('yo')
__all__ = 'Aaa', '_bla', 'name'
"""
)
values = sorted(["Aaa", "name", "other", "func"])
self.assertEqual(sorted(m.public_names()), values)
m = builder.parse(
"""
name = 'a'
_bla = 2
other = 'o'
class Aaa: pass
def func(): return 'yo'
"""
)
res = sorted(m.public_names())
self.assertEqual(res, values)
m = builder.parse(
"""
from missing import tzop
trop = "test"
__all__ = (trop, "test1", tzop, 42)
"""
)
res = sorted(m.public_names())
self.assertEqual(res, ["trop", "tzop"])
m = builder.parse(
"""
test = tzop = 42
__all__ = ('test', ) + ('tzop', )
"""
)
res = sorted(m.public_names())
self.assertEqual(res, ["test", "tzop"])
def test_module_getattr(self) -> None:
data = """
appli = application
appli += 2
del appli
"""
astroid = builder.parse(data, __name__)
# test del statement not returned by getattr
self.assertEqual(len(astroid.getattr("appli")), 2, astroid.getattr("appli"))
def test_relative_to_absolute_name(self) -> None:
# package
mod = nodes.Module("very.multi.package", "doc")
mod.package = True
modname = mod.relative_to_absolute_name("utils", 1)
self.assertEqual(modname, "very.multi.package.utils")
modname = mod.relative_to_absolute_name("utils", 2)
self.assertEqual(modname, "very.multi.utils")
modname = mod.relative_to_absolute_name("utils", 0)
self.assertEqual(modname, "very.multi.package.utils")
modname = mod.relative_to_absolute_name("", 1)
self.assertEqual(modname, "very.multi.package")
# non package
mod = nodes.Module("very.multi.module", "doc")
mod.package = False
modname = mod.relative_to_absolute_name("utils", 0)
self.assertEqual(modname, "very.multi.utils")
modname = mod.relative_to_absolute_name("utils", 1)
self.assertEqual(modname, "very.multi.utils")
modname = mod.relative_to_absolute_name("utils", 2)
self.assertEqual(modname, "very.utils")
modname = mod.relative_to_absolute_name("", 1)
self.assertEqual(modname, "very.multi")
def test_relative_to_absolute_name_beyond_top_level(self) -> None:
mod = nodes.Module("a.b.c", "")
mod.package = True
for level in (5, 4):
with self.assertRaises(TooManyLevelsError) as cm:
mod.relative_to_absolute_name("test", level)
expected = (
"Relative import with too many levels "
f"({level-1}) for module {mod.name!r}"
)
self.assertEqual(expected, str(cm.exception))
def test_import_1(self) -> None:
data = """from . import subpackage"""
sys.path.insert(0, resources.find("data"))
astroid = builder.parse(data, "package", "data/package/__init__.py")
try:
m = astroid.import_module("", level=1)
self.assertEqual(m.name, "package")
inferred = list(astroid.igetattr("subpackage"))
self.assertEqual(len(inferred), 1)
self.assertEqual(inferred[0].name, "package.subpackage")
finally:
del sys.path[0]
def test_import_2(self) -> None:
data = """from . import subpackage as pouet"""
astroid = builder.parse(data, "package", "data/package/__init__.py")
sys.path.insert(0, resources.find("data"))
try:
m = astroid.import_module("", level=1)
self.assertEqual(m.name, "package")
inferred = list(astroid.igetattr("pouet"))
self.assertEqual(len(inferred), 1)
self.assertEqual(inferred[0].name, "package.subpackage")
finally:
del sys.path[0]
def test_file_stream_in_memory(self) -> None:
data = """irrelevant_variable is irrelevant"""
astroid = builder.parse(data, "in_memory")
with astroid.stream() as stream:
self.assertEqual(stream.read().decode(), data)
def test_file_stream_physical(self) -> None:
path = resources.find("data/all.py")
astroid = builder.AstroidBuilder().file_build(path, "all")
with open(path, "rb") as file_io:
with astroid.stream() as stream:
self.assertEqual(stream.read(), file_io.read())
def test_file_stream_api(self) -> None:
path = resources.find("data/all.py")
file_build = builder.AstroidBuilder().file_build(path, "all")
with self.assertRaises(AttributeError):
# pylint: disable=pointless-statement
file_build.file_stream
def test_stream_api(self) -> None:
path = resources.find("data/all.py")
astroid = builder.AstroidBuilder().file_build(path, "all")
stream = astroid.stream()
self.assertTrue(hasattr(stream, "close"))
with stream:
with open(path, "rb") as file_io:
self.assertEqual(stream.read(), file_io.read())
class FunctionNodeTest(ModuleLoader, unittest.TestCase):
def test_special_attributes(self) -> None:
func = self.module2["make_class"]
self.assertEqual(len(func.getattr("__name__")), 1)
self.assertIsInstance(func.getattr("__name__")[0], nodes.Const)
self.assertEqual(func.getattr("__name__")[0].value, "make_class")
self.assertEqual(len(func.getattr("__doc__")), 1)
self.assertIsInstance(func.getattr("__doc__")[0], nodes.Const)
self.assertEqual(
func.getattr("__doc__")[0].value,
"check base is correctly resolved to Concrete0",
)
self.assertEqual(len(self.module.getattr("__dict__")), 1)
self.assertIsInstance(self.module.getattr("__dict__")[0], nodes.Dict)
def test_dict_interface(self) -> None:
_test_dict_interface(self, self.module["global_access"], "local")
def test_default_value(self) -> None:
func = self.module2["make_class"]
self.assertIsInstance(func.args.default_value("base"), nodes.Attribute)
self.assertRaises(NoDefault, func.args.default_value, "args")
self.assertRaises(NoDefault, func.args.default_value, "kwargs")
self.assertRaises(NoDefault, func.args.default_value, "any")
# self.assertIsInstance(func.mularg_class('args'), nodes.Tuple)
# self.assertIsInstance(func.mularg_class('kwargs'), nodes.Dict)
# self.assertIsNone(func.mularg_class('base'))
def test_navigation(self) -> None:
function = self.module["global_access"]
self.assertEqual(function.statement(), function)
self.assertEqual(function.statement(future=True), function)
l_sibling = function.previous_sibling()
# check taking parent if child is not a stmt
self.assertIsInstance(l_sibling, nodes.Assign)
child = function.args.args[0]
self.assertIs(l_sibling, child.previous_sibling())
r_sibling = function.next_sibling()
self.assertIsInstance(r_sibling, nodes.ClassDef)
self.assertEqual(r_sibling.name, "YO")
self.assertIs(r_sibling, child.next_sibling())
last = r_sibling.next_sibling().next_sibling().next_sibling()
self.assertIsInstance(last, nodes.Assign)
self.assertIsNone(last.next_sibling())
first = l_sibling.root().body[0]
self.assertIsNone(first.previous_sibling())
def test_four_args(self) -> None:
func = self.module["four_args"]
local = sorted(func.keys())
self.assertEqual(local, ["a", "b", "c", "d"])
self.assertEqual(func.type, "function")
def test_format_args(self) -> None:
func = self.module2["make_class"]
self.assertEqual(
func.args.format_args(), "any, base=data.module.YO, *args, **kwargs"
)
func = self.module["four_args"]
self.assertEqual(func.args.format_args(), "a, b, c, d")
def test_format_args_keyword_only_args(self) -> None:
node = (
builder.parse(
"""
def test(a: int, *, b: dict):
pass
"""
)
.body[-1]
.args
)
formatted = node.format_args()
self.assertEqual(formatted, "a: int, *, b: dict")
def test_is_generator(self) -> None:
self.assertTrue(self.module2["generator"].is_generator())
self.assertFalse(self.module2["not_a_generator"].is_generator())
self.assertFalse(self.module2["make_class"].is_generator())
def test_is_abstract(self) -> None:
method = self.module2["AbstractClass"]["to_override"]
self.assertTrue(method.is_abstract(pass_is_abstract=False))
self.assertEqual(method.qname(), "data.module2.AbstractClass.to_override")
self.assertEqual(method.pytype(), "builtins.instancemethod")
method = self.module2["AbstractClass"]["return_something"]
self.assertFalse(method.is_abstract(pass_is_abstract=False))
# non regression : test raise "string" doesn't cause an exception in is_abstract
func = self.module2["raise_string"]
self.assertFalse(func.is_abstract(pass_is_abstract=False))
def test_is_abstract_decorated(self) -> None:
methods = builder.extract_node(
"""
import abc
class Klass(object):
@abc.abstractproperty
def prop(self): #@
pass
@abc.abstractmethod
def method1(self): #@
pass
some_other_decorator = lambda x: x
@some_other_decorator
def method2(self): #@
pass
"""
)
assert len(methods) == 3
prop, method1, method2 = methods
assert isinstance(prop, nodes.FunctionDef)
assert prop.is_abstract(pass_is_abstract=False)
assert isinstance(method1, nodes.FunctionDef)
assert method1.is_abstract(pass_is_abstract=False)
assert isinstance(method2, nodes.FunctionDef)
assert not method2.is_abstract(pass_is_abstract=False)
# def test_raises(self):
# method = self.module2["AbstractClass"]["to_override"]
# self.assertEqual(
# [str(term) for term in method.raises()],
# ["Call(Name('NotImplementedError'), [], None, None)"],
# )
# def test_returns(self):
# method = self.module2["AbstractClass"]["return_something"]
# # use string comp since Node doesn't handle __cmp__
# self.assertEqual(
# [str(term) for term in method.returns()], ["Const('toto')", "Const(None)"]
# )
def test_lambda_pytype(self) -> None:
data = """
def f():
g = lambda: None
"""
astroid = builder.parse(data)
g = list(astroid["f"].ilookup("g"))[0]
self.assertEqual(g.pytype(), "builtins.function")
def test_lambda_qname(self) -> None:
astroid = builder.parse("lmbd = lambda: None", __name__)
self.assertEqual(f"{__name__}.<lambda>", astroid["lmbd"].parent.value.qname())
def test_is_method(self) -> None:
data = """
class A:
def meth1(self):
return 1
@classmethod
def meth2(cls):
return 2
@staticmethod
def meth3():
return 3
def function():
return 0
@staticmethod
def sfunction():
return -1
"""
astroid = builder.parse(data)
self.assertTrue(astroid["A"]["meth1"].is_method())
self.assertTrue(astroid["A"]["meth2"].is_method())
self.assertTrue(astroid["A"]["meth3"].is_method())
self.assertFalse(astroid["function"].is_method())
self.assertFalse(astroid["sfunction"].is_method())
def test_argnames(self) -> None:
code = "def f(a, b, c, *args, **kwargs): pass"
astroid = builder.parse(code, __name__)
self.assertEqual(astroid["f"].argnames(), ["a", "b", "c", "args", "kwargs"])
def test_return_nothing(self) -> None:
"""test inferred value on a function with empty return"""
data = """
def func():
return
a = func()
"""
astroid = builder.parse(data)
call = astroid.body[1].value
func_vals = call.inferred()
self.assertEqual(len(func_vals), 1)
self.assertIsInstance(func_vals[0], nodes.Const)
self.assertIsNone(func_vals[0].value)
def test_no_returns_is_implicitly_none(self) -> None:
code = """
def f():
print('non-empty, non-pass, no return statements')
value = f()
value
"""
node = builder.extract_node(code)
inferred = next(node.infer())
assert isinstance(inferred, nodes.Const)
assert inferred.value is None
def test_only_raises_is_not_implicitly_none(self) -> None:
code = """
def f():
raise SystemExit()
f()
"""
node = builder.extract_node(code)
assert isinstance(node, nodes.Call)
inferred = next(node.infer())
assert inferred is util.Uninferable
def test_abstract_methods_are_not_implicitly_none(self) -> None:
code = """
from abc import ABCMeta, abstractmethod
class Abstract(metaclass=ABCMeta):
@abstractmethod
def foo(self):
pass
def bar(self):
print('non-empty, non-pass, no return statements')
Abstract().foo() #@
Abstract().bar() #@
class Concrete(Abstract):
def foo(self):
return 123
Concrete().foo() #@
Concrete().bar() #@
"""
afoo, abar, cfoo, cbar = builder.extract_node(code)
assert next(afoo.infer()) is util.Uninferable
for node, value in ((abar, None), (cfoo, 123), (cbar, None)):
inferred = next(node.infer())
assert isinstance(inferred, nodes.Const)
assert inferred.value == value
def test_func_instance_attr(self) -> None:
"""test instance attributes for functions"""
data = """
def test():
print(test.bar)
test.bar = 1
test()
"""
astroid = builder.parse(data, "mod")
func = astroid.body[2].value.func.inferred()[0]
self.assertIsInstance(func, nodes.FunctionDef)
self.assertEqual(func.name, "test")
one = func.getattr("bar")[0].inferred()[0]
self.assertIsInstance(one, nodes.Const)
self.assertEqual(one.value, 1)
def test_type_builtin_descriptor_subclasses(self) -> None:
astroid = builder.parse(
"""
class classonlymethod(classmethod):
pass
class staticonlymethod(staticmethod):
pass
class Node:
@classonlymethod
def clsmethod_subclass(cls):
pass
@classmethod
def clsmethod(cls):
pass
@staticonlymethod
def staticmethod_subclass(cls):
pass
@staticmethod
def stcmethod(cls):
pass
"""
)
node = astroid.locals["Node"][0]
self.assertEqual(node.locals["clsmethod_subclass"][0].type, "classmethod")
self.assertEqual(node.locals["clsmethod"][0].type, "classmethod")
self.assertEqual(node.locals["staticmethod_subclass"][0].type, "staticmethod")
self.assertEqual(node.locals["stcmethod"][0].type, "staticmethod")
def test_decorator_builtin_descriptors(self) -> None:
astroid = builder.parse(
"""
def static_decorator(platform=None, order=50):
def wrapper(f):
f.cgm_module = True
f.cgm_module_order = order
f.cgm_module_platform = platform
return staticmethod(f)
return wrapper
def long_classmethod_decorator(platform=None, order=50):
def wrapper(f):
def wrapper2(f):
def wrapper3(f):
f.cgm_module = True
f.cgm_module_order = order
f.cgm_module_platform = platform
return classmethod(f)
return wrapper3(f)
return wrapper2(f)
return wrapper
def classmethod_decorator(platform=None):
def wrapper(f):
f.platform = platform
return classmethod(f)
return wrapper
def classmethod_wrapper(fn):
def wrapper(cls, *args, **kwargs):
result = fn(cls, *args, **kwargs)
return result
return classmethod(wrapper)
def staticmethod_wrapper(fn):
def wrapper(*args, **kwargs):
return fn(*args, **kwargs)
return staticmethod(wrapper)
class SomeClass(object):
@static_decorator()
def static(node, cfg):
pass
@classmethod_decorator()
def classmethod(cls):
pass
@static_decorator
def not_so_static(node):
pass
@classmethod_decorator
def not_so_classmethod(node):
pass
@classmethod_wrapper
def classmethod_wrapped(cls):
pass
@staticmethod_wrapper
def staticmethod_wrapped():
pass
@long_classmethod_decorator()
def long_classmethod(cls):
pass
"""
)
node = astroid.locals["SomeClass"][0]
self.assertEqual(node.locals["static"][0].type, "staticmethod")
self.assertEqual(node.locals["classmethod"][0].type, "classmethod")
self.assertEqual(node.locals["not_so_static"][0].type, "method")
self.assertEqual(node.locals["not_so_classmethod"][0].type, "method")
self.assertEqual(node.locals["classmethod_wrapped"][0].type, "classmethod")
self.assertEqual(node.locals["staticmethod_wrapped"][0].type, "staticmethod")
self.assertEqual(node.locals["long_classmethod"][0].type, "classmethod")
def test_igetattr(self) -> None:
func = builder.extract_node(
"""
def test():
pass
"""
)
assert isinstance(func, nodes.FunctionDef)
func.instance_attrs["value"] = [nodes.Const(42)]
value = func.getattr("value")
self.assertEqual(len(value), 1)
self.assertIsInstance(value[0], nodes.Const)
self.assertEqual(value[0].value, 42)
inferred = next(func.igetattr("value"))
self.assertIsInstance(inferred, nodes.Const)
self.assertEqual(inferred.value, 42)
def test_return_annotation_is_not_the_last(self) -> None:
func = builder.extract_node(
"""
def test() -> bytes:
pass
pass
return
"""
)
last_child = func.last_child()
self.assertIsInstance(last_child, nodes.Return)
self.assertEqual(func.tolineno, 5)
def test_method_init_subclass(self) -> None:
klass = builder.extract_node(
"""
class MyClass:
def __init_subclass__(cls):
pass
"""
)
method = klass["__init_subclass__"]
self.assertEqual([n.name for n in method.args.args], ["cls"])
self.assertEqual(method.type, "classmethod")
def test_dunder_class_local_to_method(self) -> None:
node = builder.extract_node(
"""
class MyClass:
def test(self):
__class__ #@
"""
)
inferred = next(node.infer())
self.assertIsInstance(inferred, nodes.ClassDef)
self.assertEqual(inferred.name, "MyClass")
def test_dunder_class_local_to_function(self) -> None:
node = builder.extract_node(
"""
def test(self):
__class__ #@
"""
)
with self.assertRaises(NameInferenceError):
next(node.infer())
def test_dunder_class_local_to_classmethod(self) -> None:
node = builder.extract_node(
"""
class MyClass:
@classmethod
def test(cls):
__class__ #@
"""
)
inferred = next(node.infer())
self.assertIsInstance(inferred, nodes.ClassDef)
self.assertEqual(inferred.name, "MyClass")
class ClassNodeTest(ModuleLoader, unittest.TestCase):
def test_dict_interface(self) -> None:
_test_dict_interface(self, self.module["YOUPI"], "method")
def test_cls_special_attributes_1(self) -> None:
cls = self.module["YO"]
self.assertEqual(len(cls.getattr("__bases__")), 1)
self.assertEqual(len(cls.getattr("__name__")), 1)
self.assertIsInstance(cls.getattr("__name__")[0], nodes.Const)
self.assertEqual(cls.getattr("__name__")[0].value, "YO")
self.assertEqual(len(cls.getattr("__doc__")), 1)
self.assertIsInstance(cls.getattr("__doc__")[0], nodes.Const)
self.assertEqual(cls.getattr("__doc__")[0].value, "hehe\n haha")
# YO is an old styled class for Python 2.7
# May want to stop locals from referencing namespaced variables in the future
module_attr_num = 4
self.assertEqual(len(cls.getattr("__module__")), module_attr_num)
self.assertIsInstance(cls.getattr("__module__")[0], nodes.Const)
self.assertEqual(cls.getattr("__module__")[0].value, "data.module")
self.assertEqual(len(cls.getattr("__dict__")), 1)
if not cls.newstyle:
self.assertRaises(AttributeInferenceError, cls.getattr, "__mro__")
for cls in (nodes.List._proxied, nodes.Const(1)._proxied):
self.assertEqual(len(cls.getattr("__bases__")), 1)
self.assertEqual(len(cls.getattr("__name__")), 1)
self.assertEqual(
len(cls.getattr("__doc__")), 1, (cls, cls.getattr("__doc__"))
)
self.assertEqual(cls.getattr("__doc__")[0].value, cls.doc)
self.assertEqual(len(cls.getattr("__module__")), 4)
self.assertEqual(len(cls.getattr("__dict__")), 1)
self.assertEqual(len(cls.getattr("__mro__")), 1)
def test__mro__attribute(self) -> None:
node = builder.extract_node(
"""
class A(object): pass
class B(object): pass
class C(A, B): pass
"""
)
assert isinstance(node, nodes.ClassDef)
mro = node.getattr("__mro__")[0]
self.assertIsInstance(mro, nodes.Tuple)
self.assertEqual(mro.elts, node.mro())
def test__bases__attribute(self) -> None:
node = builder.extract_node(
"""
class A(object): pass
class B(object): pass
class C(A, B): pass
class D(C): pass
"""
)
assert isinstance(node, nodes.ClassDef)
bases = node.getattr("__bases__")[0]
self.assertIsInstance(bases, nodes.Tuple)
self.assertEqual(len(bases.elts), 1)
self.assertIsInstance(bases.elts[0], nodes.ClassDef)
self.assertEqual(bases.elts[0].name, "C")
def test_cls_special_attributes_2(self) -> None:
astroid = builder.parse(
"""
class A(object): pass
class B(object): pass
A.__bases__ += (B,)
""",
__name__,
)
self.assertEqual(len(astroid["A"].getattr("__bases__")), 2)
self.assertIsInstance(astroid["A"].getattr("__bases__")[1], nodes.Tuple)
self.assertIsInstance(astroid["A"].getattr("__bases__")[0], nodes.AssignAttr)
def test_instance_special_attributes(self) -> None:
for inst in (Instance(self.module["YO"]), nodes.List(), nodes.Const(1)):
self.assertRaises(AttributeInferenceError, inst.getattr, "__mro__")
self.assertRaises(AttributeInferenceError, inst.getattr, "__bases__")
self.assertRaises(AttributeInferenceError, inst.getattr, "__name__")
self.assertEqual(len(inst.getattr("__dict__")), 1)
self.assertEqual(len(inst.getattr("__doc__")), 1)
def test_navigation(self) -> None:
klass = self.module["YO"]
self.assertEqual(klass.statement(), klass)
self.assertEqual(klass.statement(future=True), klass)
l_sibling = klass.previous_sibling()
self.assertTrue(isinstance(l_sibling, nodes.FunctionDef), l_sibling)
self.assertEqual(l_sibling.name, "global_access")
r_sibling = klass.next_sibling()
self.assertIsInstance(r_sibling, nodes.ClassDef)
self.assertEqual(r_sibling.name, "YOUPI")
def test_local_attr_ancestors(self) -> None:
module = builder.parse(
"""
class A():
def __init__(self): pass
class B(A): pass
class C(B): pass
class D(object): pass
class F(): pass
class E(F, D): pass
"""
)
# Test old-style (Python 2) / new-style (Python 3+) ancestors lookups
klass2 = module["C"]
it = klass2.local_attr_ancestors("__init__")
anc_klass = next(it)
self.assertIsInstance(anc_klass, nodes.ClassDef)
self.assertEqual(anc_klass.name, "A")
anc_klass = next(it)
self.assertIsInstance(anc_klass, nodes.ClassDef)
self.assertEqual(anc_klass.name, "object")
self.assertRaises(StopIteration, partial(next, it))
it = klass2.local_attr_ancestors("method")
self.assertRaises(StopIteration, partial(next, it))
# Test mixed-style ancestor lookups
klass2 = module["E"]
it = klass2.local_attr_ancestors("__init__")
anc_klass = next(it)
self.assertIsInstance(anc_klass, nodes.ClassDef)
self.assertEqual(anc_klass.name, "object")
self.assertRaises(StopIteration, partial(next, it))
def test_local_attr_mro(self) -> None:
module = builder.parse(
"""
class A(object):
def __init__(self): pass
class B(A):
def __init__(self, arg, arg2): pass
class C(A): pass
class D(C, B): pass
"""
)
dclass = module["D"]
init = dclass.local_attr("__init__")[0]
self.assertIsInstance(init, nodes.FunctionDef)
self.assertEqual(init.parent.name, "B")
cclass = module["C"]
init = cclass.local_attr("__init__")[0]
self.assertIsInstance(init, nodes.FunctionDef)
self.assertEqual(init.parent.name, "A")
ancestors = list(dclass.local_attr_ancestors("__init__"))
self.assertEqual([node.name for node in ancestors], ["B", "A", "object"])
def test_instance_attr_ancestors(self) -> None:
klass2 = self.module["YOUPI"]
it = klass2.instance_attr_ancestors("yo")
anc_klass = next(it)
self.assertIsInstance(anc_klass, nodes.ClassDef)
self.assertEqual(anc_klass.name, "YO")
self.assertRaises(StopIteration, partial(next, it))
klass2 = self.module["YOUPI"]
it = klass2.instance_attr_ancestors("member")
self.assertRaises(StopIteration, partial(next, it))
def test_methods(self) -> None:
expected_methods = {"__init__", "class_method", "method", "static_method"}
klass2 = self.module["YOUPI"]
methods = {m.name for m in klass2.methods()}
self.assertTrue(methods.issuperset(expected_methods))
methods = {m.name for m in klass2.mymethods()}
self.assertSetEqual(expected_methods, methods)
klass2 = self.module2["Specialization"]
methods = {m.name for m in klass2.mymethods()}
self.assertSetEqual(set(), methods)
method_locals = klass2.local_attr("method")
self.assertEqual(len(method_locals), 1)
self.assertEqual(method_locals[0].name, "method")
self.assertRaises(AttributeInferenceError, klass2.local_attr, "nonexistent")
methods = {m.name for m in klass2.methods()}
self.assertTrue(methods.issuperset(expected_methods))
# def test_rhs(self):
# my_dict = self.module['MY_DICT']
# self.assertIsInstance(my_dict.rhs(), nodes.Dict)
# a = self.module['YO']['a']
# value = a.rhs()
# self.assertIsInstance(value, nodes.Const)
# self.assertEqual(value.value, 1)
def test_ancestors(self) -> None:
klass = self.module["YOUPI"]
self.assertEqual(["YO", "object"], [a.name for a in klass.ancestors()])
klass = self.module2["Specialization"]
self.assertEqual(["YOUPI", "YO", "object"], [a.name for a in klass.ancestors()])
def test_type(self) -> None:
klass = self.module["YOUPI"]
self.assertEqual(klass.type, "class")
klass = self.module2["Metaclass"]
self.assertEqual(klass.type, "metaclass")
klass = self.module2["MyException"]
self.assertEqual(klass.type, "exception")
klass = self.module2["MyError"]
self.assertEqual(klass.type, "exception")
# the following class used to be detected as a metaclass
# after the fix which used instance._proxied in .ancestors(),
# when in fact it is a normal class
klass = self.module2["NotMetaclass"]
self.assertEqual(klass.type, "class")
def test_inner_classes(self) -> None:
eee = self.nonregr["Ccc"]["Eee"]
self.assertEqual([n.name for n in eee.ancestors()], ["Ddd", "Aaa", "object"])
def test_classmethod_attributes(self) -> None:
data = """
class WebAppObject(object):
def registered(cls, application):
cls.appli = application
cls.schema = application.schema
cls.config = application.config
return cls
registered = classmethod(registered)
"""
astroid = builder.parse(data, __name__)
cls = astroid["WebAppObject"]
assert_keys = [
"__module__",
"__qualname__",
"appli",
"config",
"registered",
"schema",
]
self.assertEqual(sorted(cls.locals.keys()), assert_keys)
def test_class_getattr(self) -> None:
data = """
class WebAppObject(object):
appli = application
appli += 2
del self.appli
"""
astroid = builder.parse(data, __name__)
cls = astroid["WebAppObject"]
# test del statement not returned by getattr
self.assertEqual(len(cls.getattr("appli")), 2)
def test_instance_getattr(self) -> None:
data = """
class WebAppObject(object):
def __init__(self, application):
self.appli = application
self.appli += 2
del self.appli
"""
astroid = builder.parse(data)
inst = Instance(astroid["WebAppObject"])
# test del statement not returned by getattr
self.assertEqual(len(inst.getattr("appli")), 2)
def test_instance_getattr_with_class_attr(self) -> None:
data = """