-
Notifications
You must be signed in to change notification settings - Fork 109
/
bugbear.py
2499 lines (2167 loc) · 87.9 KB
/
bugbear.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
from __future__ import annotations
import ast
import builtins
import itertools
import logging
import math
import re
import sys
import warnings
from collections import Counter, defaultdict, namedtuple
from contextlib import suppress
from functools import lru_cache, partial
from keyword import iskeyword
from typing import Dict, Iterable, Iterator, List, Sequence, Set, Union
import attr
import pycodestyle # type: ignore[import-untyped]
__version__ = "24.12.12"
LOG = logging.getLogger("flake8.bugbear")
CONTEXTFUL_NODES = (
ast.Module,
ast.ClassDef,
ast.AsyncFunctionDef,
ast.FunctionDef,
ast.Lambda,
ast.ListComp,
ast.SetComp,
ast.DictComp,
ast.GeneratorExp,
)
FUNCTION_NODES = (ast.AsyncFunctionDef, ast.FunctionDef, ast.Lambda)
B908_pytest_functions = {"raises", "warns"}
B908_unittest_methods = {
"assertRaises",
"assertRaisesRegex",
"assertRaisesRegexp",
"assertWarns",
"assertWarnsRegex",
}
B902_default_decorators = {"classmethod"}
Context = namedtuple("Context", ["node", "stack"])
@attr.s(unsafe_hash=False)
class BugBearChecker:
name = "flake8-bugbear"
version = __version__
tree = attr.ib(default=None)
filename = attr.ib(default="(none)")
lines = attr.ib(default=None)
max_line_length = attr.ib(default=79)
visitor = attr.ib(init=False, factory=lambda: BugBearVisitor)
options = attr.ib(default=None)
def run(self):
if not self.tree or not self.lines:
self.load_file()
if self.options and hasattr(self.options, "extend_immutable_calls"):
b008_b039_extend_immutable_calls = set(self.options.extend_immutable_calls)
else:
b008_b039_extend_immutable_calls = set()
b902_classmethod_decorators: set[str] = B902_default_decorators
if self.options and hasattr(self.options, "classmethod_decorators"):
b902_classmethod_decorators = set(self.options.classmethod_decorators)
visitor = self.visitor(
filename=self.filename,
lines=self.lines,
b008_b039_extend_immutable_calls=b008_b039_extend_immutable_calls,
b902_classmethod_decorators=b902_classmethod_decorators,
)
visitor.visit(self.tree)
for e in itertools.chain(visitor.errors, self.gen_line_based_checks()):
if self.should_warn(e.message[:4]):
yield self.adapt_error(e)
def gen_line_based_checks(self):
"""gen_line_based_checks() -> (error, error, error, ...)
The following simple checks are based on the raw lines, not the AST.
"""
noqa_type_ignore_regex = re.compile(
r"#\s*(noqa|type:\s*ignore|pragma:)[^#\r\n]*$"
)
for lineno, line in enumerate(self.lines, start=1):
# Special case: ignore long shebang (following pycodestyle).
if lineno == 1 and line.startswith("#!"):
continue
# At first, removing noqa and type: ignore trailing comments"
no_comment_line = noqa_type_ignore_regex.sub("", line)
if no_comment_line != line:
no_comment_line = noqa_type_ignore_regex.sub("", no_comment_line)
length = len(no_comment_line) - 1
if length > 1.1 * self.max_line_length and no_comment_line.strip():
# Special case long URLS and paths to follow pycodestyle.
# Would use the `pycodestyle.maximum_line_length` directly but
# need to supply it arguments that are not available so chose
# to replicate instead.
chunks = no_comment_line.split()
is_line_comment_url_path = len(chunks) == 2 and chunks[0] == "#"
just_long_url_path = len(chunks) == 1
num_leading_whitespaces = len(no_comment_line) - len(chunks[-1])
too_many_leading_white_spaces = (
num_leading_whitespaces >= self.max_line_length - 7
)
skip = is_line_comment_url_path or just_long_url_path
if skip and not too_many_leading_white_spaces:
continue
yield B950(lineno, length, vars=(length, self.max_line_length))
@classmethod
def adapt_error(cls, e):
"""Adapts the extended error namedtuple to be compatible with Flake8."""
return e._replace(message=e.message.format(*e.vars))[:4]
def load_file(self) -> None:
"""Loads the file in a way that auto-detects source encoding and deals
with broken terminal encodings for stdin.
Stolen from flake8_import_order because it's good.
"""
if self.filename in ("stdin", "-", None):
self.filename = "stdin"
self.lines = pycodestyle.stdin_get_value().splitlines(True)
else:
self.lines = pycodestyle.readlines(self.filename)
if not self.tree:
self.tree = ast.parse("".join(self.lines))
@staticmethod
def add_options(optmanager) -> None:
"""Informs flake8 to ignore B9xx by default."""
optmanager.extend_default_ignore(disabled_by_default)
optmanager.add_option(
"--extend-immutable-calls",
comma_separated_list=True,
parse_from_config=True,
default=[],
help="Skip B008 test for additional immutable calls.",
)
# you cannot register the same option in two different plugins, so we
# only register --classmethod-decorators if pep8-naming is not installed
if "pep8ext_naming" not in sys.modules.keys():
optmanager.add_option(
"--classmethod-decorators",
comma_separated_list=True,
parse_from_config=True,
default=B902_default_decorators,
help=(
"List of method decorators that should be treated as classmethods"
" by B902"
),
)
@lru_cache # noqa: B019
def should_warn(self, code) -> bool:
"""Returns `True` if Bugbear should emit a particular warning.
flake8 overrides default ignores when the user specifies
`ignore = ` in configuration. This is problematic because it means
specifying anything in `ignore = ` implicitly enables all optional
warnings. This function is a workaround for this behavior.
As documented in the README, the user is expected to explicitly select
the warnings.
NOTE: This method is deprecated and will be removed in a future release. It is
recommended to use `extend-ignore` and `extend-select` in your flake8
configuration to avoid implicitly altering selected and ignored codes.
"""
if code[:2] != "B9":
# Normal warnings are safe for emission.
return True
if self.options is None:
# Without options configured, Bugbear will emit B9 but flake8 will ignore
LOG.info(
"Options not provided to Bugbear, optional warning %s selected.", code
)
return True
for i in range(2, len(code) + 1):
if self.options.select and code[:i] in self.options.select:
return True
# flake8 >=4.0: Also check for codes in extend_select
if (
hasattr(self.options, "extend_select")
and self.options.extend_select
and code[:i] in self.options.extend_select
):
return True
LOG.info(
"Optional warning %s not present in selected warnings: %r. Not "
"firing it at all.",
code,
self.options.select,
)
return False
def _is_identifier(arg) -> bool:
# Return True if arg is a valid identifier, per
# https://docs.python.org/2/reference/lexical_analysis.html#identifiers
if not isinstance(arg, ast.Constant) or not isinstance(arg.value, str):
return False
return re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", arg.value) is not None
def _flatten_excepthandler(node: ast.expr | None) -> Iterator[ast.expr | None]:
if not isinstance(node, ast.Tuple):
yield node
return
expr_list = node.elts.copy()
while len(expr_list):
expr = expr_list.pop(0)
if isinstance(expr, ast.Starred) and isinstance(
expr.value, (ast.List, ast.Tuple)
):
expr_list.extend(expr.value.elts)
continue
yield expr
def _check_redundant_excepthandlers(names: Sequence[str], node, in_trystar):
# See if any of the given exception names could be removed, e.g. from:
# (MyError, MyError) # duplicate names
# (MyError, BaseException) # everything derives from the Base
# (Exception, TypeError) # builtins where one subclasses another
# (IOError, OSError) # IOError is an alias of OSError since Python3.3
# but note that other cases are impractical to handle from the AST.
# We expect this is mostly useful for users who do not have the
# builtin exception hierarchy memorised, and include a 'shadowed'
# subtype without realising that it's redundant.
good = sorted(set(names), key=names.index)
if "BaseException" in good:
good = ["BaseException"]
# Remove redundant exceptions that the automatic system either handles
# poorly (usually aliases) or can't be checked (e.g. it's not an
# built-in exception).
for primary, equivalents in B014_REDUNDANT_EXCEPTIONS.items():
if primary in good:
good = [g for g in good if g not in equivalents]
for name, other in itertools.permutations(tuple(good), 2):
if _typesafe_issubclass(
getattr(builtins, name, type), getattr(builtins, other, ())
):
if name in good:
good.remove(name)
if good != names:
desc = good[0] if len(good) == 1 else "({})".format(", ".join(good))
as_ = " as " + node.name if node.name is not None else ""
return B014(
node.lineno,
node.col_offset,
vars=(", ".join(names), as_, desc, in_trystar),
)
return None
def _to_name_str(node):
# Turn Name and Attribute nodes to strings, e.g "ValueError" or
# "pkg.mod.error", handling any depth of attribute accesses.
# Return None for unrecognized nodes.
if isinstance(node, ast.Name):
return node.id
if isinstance(node, ast.Call):
return _to_name_str(node.func)
elif isinstance(node, ast.Attribute):
inner = _to_name_str(node.value)
if inner is None:
return None
return f"{inner}.{node.attr}"
else:
return None
def names_from_assignments(assign_target):
if isinstance(assign_target, ast.Name):
yield assign_target.id
elif isinstance(assign_target, ast.Starred):
yield from names_from_assignments(assign_target.value)
elif isinstance(assign_target, (ast.List, ast.Tuple)):
for child in assign_target.elts:
yield from names_from_assignments(child)
def children_in_scope(node):
yield node
if not isinstance(node, FUNCTION_NODES):
for child in ast.iter_child_nodes(node):
yield from children_in_scope(child)
def walk_list(nodes):
for node in nodes:
yield from ast.walk(node)
def _typesafe_issubclass(cls, class_or_tuple):
try:
return issubclass(cls, class_or_tuple)
except TypeError:
# User code specifies a type that is not a type in our current run. Might be
# their error, might be a difference in our environments. We don't know so we
# ignore this
return False
class ExceptBaseExceptionVisitor(ast.NodeVisitor):
def __init__(self, except_node: ast.ExceptHandler) -> None:
super().__init__()
self.root = except_node
self._re_raised = False
def re_raised(self) -> bool:
self.visit(self.root)
return self._re_raised
def visit_Raise(self, node: ast.Raise):
"""If we find a corresponding `raise` or `raise e` where e was from
`except BaseException as e:` then we mark re_raised as True and can
stop scanning."""
if node.exc is None or (
isinstance(node.exc, ast.Name) and node.exc.id == self.root.name
):
self._re_raised = True
return
return super().generic_visit(node)
def visit_ExceptHandler(self, node: ast.ExceptHandler):
if node is not self.root:
return # entered a nested except - stop searching
return super().generic_visit(node)
@attr.define
class B040CaughtException:
name: str
has_note: bool
class B041UnhandledKeyType:
"""
A dictionary key of a type that we do not check for duplicates.
"""
@attr.define(frozen=True)
class B041VariableKeyType:
name: str
@attr.s
class BugBearVisitor(ast.NodeVisitor):
filename = attr.ib()
lines = attr.ib()
b008_b039_extend_immutable_calls: set[str] = attr.ib(factory=set)
b902_classmethod_decorators: set[str] = attr.ib(factory=set)
node_window: list[ast.AST] = attr.ib(factory=list)
errors: list[error] = attr.ib(factory=list)
contexts: list[Context] = attr.ib(factory=list)
b040_caught_exception: B040CaughtException | None = attr.ib(default=None)
NODE_WINDOW_SIZE = 4
_b023_seen: set[error] = attr.ib(factory=set, init=False)
_b005_imports: set[str] = attr.ib(factory=set, init=False)
# set to "*" when inside a try/except*, for correctly printing errors
in_trystar: str = attr.ib(default="")
if False:
# Useful for tracing what the hell is going on.
def __getattr__(self, name: str):
print(name)
return self.__getattribute__(name)
@property
def node_stack(self):
if len(self.contexts) == 0:
return []
context, stack = self.contexts[-1]
return stack
def in_class_init(self) -> bool:
return (
len(self.contexts) >= 2
and isinstance(self.contexts[-2].node, ast.ClassDef)
and isinstance(self.contexts[-1].node, ast.FunctionDef)
and self.contexts[-1].node.name == "__init__"
)
def visit_Return(self, node: ast.Return) -> None:
if self.in_class_init():
if node.value is not None:
self.errors.append(B037(node.lineno, node.col_offset))
self.generic_visit(node)
def visit_Yield(self, node: ast.Yield) -> None:
if self.in_class_init():
self.errors.append(B037(node.lineno, node.col_offset))
self.generic_visit(node)
def visit_YieldFrom(self, node: ast.YieldFrom) -> None:
if self.in_class_init():
self.errors.append(B037(node.lineno, node.col_offset))
self.generic_visit(node)
def visit(self, node) -> None:
is_contextful = isinstance(node, CONTEXTFUL_NODES)
if is_contextful:
context = Context(node, [])
self.contexts.append(context)
self.node_stack.append(node)
self.node_window.append(node)
self.node_window = self.node_window[-self.NODE_WINDOW_SIZE :]
super().visit(node)
self.node_stack.pop()
if is_contextful:
self.contexts.pop()
self.check_for_b018(node)
def visit_ExceptHandler(self, node: ast.ExceptHandler) -> None:
if node.type is None:
self.errors.append(B001(node.lineno, node.col_offset))
self.generic_visit(node)
return
old_b040_caught_exception = self.b040_caught_exception
if node.name is None:
self.b040_caught_exception = None
else:
self.b040_caught_exception = B040CaughtException(node.name, False)
names = self.check_for_b013_b014_b029_b030(node)
if (
"BaseException" in names
and not ExceptBaseExceptionVisitor(node).re_raised()
):
self.errors.append(B036(node.lineno, node.col_offset))
self.generic_visit(node)
if (
self.b040_caught_exception is not None
and self.b040_caught_exception.has_note
):
self.errors.append(B040(node.lineno, node.col_offset))
self.b040_caught_exception = old_b040_caught_exception
def visit_UAdd(self, node) -> None:
trailing_nodes = list(map(type, self.node_window[-4:]))
if trailing_nodes == [ast.UnaryOp, ast.UAdd, ast.UnaryOp, ast.UAdd]:
originator = self.node_window[-4]
self.errors.append(B002(originator.lineno, originator.col_offset))
self.generic_visit(node)
def visit_Call(self, node) -> None:
is_b040_add_note = False
if isinstance(node.func, ast.Attribute):
self.check_for_b005(node)
is_b040_add_note = self.check_for_b040_add_note(node.func)
else:
with suppress(AttributeError, IndexError):
if (
node.func.id in ("getattr", "hasattr")
and node.args[1].value == "__call__"
):
self.errors.append(B004(node.lineno, node.col_offset))
if (
node.func.id == "getattr"
and len(node.args) == 2
and _is_identifier(node.args[1])
and not iskeyword(node.args[1].value)
):
self.errors.append(B009(node.lineno, node.col_offset))
elif (
not any(isinstance(n, ast.Lambda) for n in self.node_stack)
and node.func.id == "setattr"
and len(node.args) == 3
and _is_identifier(node.args[1])
and not iskeyword(node.args[1].value)
):
self.errors.append(B010(node.lineno, node.col_offset))
self.check_for_b026(node)
self.check_for_b028(node)
self.check_for_b034(node)
self.check_for_b039(node)
self.check_for_b905(node)
self.check_for_b910(node)
self.check_for_b911(node)
# no need for copying, if used in nested calls it will be set to None
current_b040_caught_exception = self.b040_caught_exception
if not is_b040_add_note:
self.check_for_b040_usage(node.args)
self.check_for_b040_usage(node.keywords)
self.generic_visit(node)
if is_b040_add_note:
# Avoid nested calls within the parameter list using the variable itself.
# e.g. `e.add_note(str(e))`
self.b040_caught_exception = current_b040_caught_exception
def visit_Module(self, node) -> None:
self.generic_visit(node)
def visit_Assign(self, node: ast.Assign) -> None:
self.check_for_b040_usage(node.value)
if len(node.targets) == 1:
t = node.targets[0]
if isinstance(t, ast.Attribute) and isinstance(t.value, ast.Name):
if (t.value.id, t.attr) == ("os", "environ"):
self.errors.append(B003(node.lineno, node.col_offset))
self.generic_visit(node)
def visit_For(self, node) -> None:
self.check_for_b007(node)
self.check_for_b020(node)
self.check_for_b023(node)
self.check_for_b031(node)
self.check_for_b909(node)
self.generic_visit(node)
def visit_AsyncFor(self, node) -> None:
self.check_for_b023(node)
self.generic_visit(node)
def visit_While(self, node) -> None:
self.check_for_b023(node)
self.generic_visit(node)
def visit_ListComp(self, node) -> None:
self.check_for_b023(node)
self.generic_visit(node)
def visit_SetComp(self, node) -> None:
self.check_for_b023(node)
self.generic_visit(node)
def visit_DictComp(self, node) -> None:
self.check_for_b023(node)
self.check_for_b035(node)
self.generic_visit(node)
def visit_GeneratorExp(self, node) -> None:
self.check_for_b023(node)
self.generic_visit(node)
def visit_Assert(self, node) -> None:
self.check_for_b011(node)
self.generic_visit(node)
def visit_AsyncFunctionDef(self, node) -> None:
self.check_for_b902(node)
self.check_for_b006_and_b008(node)
self.generic_visit(node)
def visit_FunctionDef(self, node) -> None:
self.check_for_b901(node)
self.check_for_b902(node)
self.check_for_b006_and_b008(node)
self.check_for_b019(node)
self.check_for_b021(node)
self.check_for_b906(node)
self.generic_visit(node)
def visit_ClassDef(self, node: ast.ClassDef) -> None:
self.check_for_b903(node)
self.check_for_b021(node)
self.check_for_b024_and_b027(node)
self.generic_visit(node)
def visit_Try(self, node) -> None:
self.check_for_b012(node)
self.check_for_b025(node)
self.generic_visit(node)
def visit_TryStar(self, node) -> None:
outer_trystar = self.in_trystar
self.in_trystar = "*"
self.visit_Try(node)
self.in_trystar = outer_trystar
def visit_Compare(self, node) -> None:
self.check_for_b015(node)
self.generic_visit(node)
def visit_Raise(self, node: ast.Raise) -> None:
if node.exc is None:
self.b040_caught_exception = None
else:
self.check_for_b040_usage(node.exc)
self.check_for_b040_usage(node.cause)
self.check_for_b016(node)
self.check_for_b904(node)
self.generic_visit(node)
def visit_With(self, node) -> None:
self.check_for_b017(node)
self.check_for_b022(node)
self.check_for_b908(node)
self.generic_visit(node)
def visit_JoinedStr(self, node) -> None:
self.check_for_b907(node)
self.generic_visit(node)
def visit_AnnAssign(self, node) -> None:
self.check_for_b032(node)
self.check_for_b040_usage(node.value)
self.generic_visit(node)
def visit_Import(self, node) -> None:
self.check_for_b005(node)
self.generic_visit(node)
def visit_ImportFrom(self, node) -> None:
self.visit_Import(node)
def visit_Set(self, node) -> None:
self.check_for_b033(node)
self.generic_visit(node)
def visit_Dict(self, node) -> None:
self.check_for_b041(node)
self.generic_visit(node)
def check_for_b041(self, node) -> None:
# Complain if there are duplicate key-value pairs in a dictionary literal.
def convert_to_value(item):
if isinstance(item, ast.Constant):
return item.value
elif isinstance(item, ast.Tuple):
return tuple(convert_to_value(i) for i in item.elts)
elif isinstance(item, ast.Name):
return B041VariableKeyType(item.id)
else:
return B041UnhandledKeyType()
keys = [convert_to_value(key) for key in node.keys]
key_counts = Counter(keys)
duplicate_keys = [key for key, count in key_counts.items() if count > 1]
for key in duplicate_keys:
key_indices = [i for i, i_key in enumerate(keys) if i_key == key]
seen = set()
for index in key_indices:
value = convert_to_value(node.values[index])
if value in seen:
key_node = node.keys[index]
self.errors.append(B041(key_node.lineno, key_node.col_offset))
seen.add(value)
def check_for_b005(self, node) -> None:
if isinstance(node, ast.Import):
for name in node.names:
self._b005_imports.add(name.asname or name.name)
elif isinstance(node, ast.ImportFrom):
for name in node.names:
self._b005_imports.add(f"{node.module}.{name.name or name.asname}")
elif isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute):
if node.func.attr not in B005_METHODS:
return # method name doesn't match
if (
isinstance(node.func.value, ast.Name)
and node.func.value.id in self._b005_imports
):
return # method is being run on an imported module
if (
len(node.args) != 1
or not isinstance(node.args[0], ast.Constant)
or not isinstance(node.args[0].value, str)
):
return # used arguments don't match the builtin strip
value = node.args[0].value
if len(value) == 1:
return # stripping just one character
if len(value) == len(set(value)):
return # no characters appear more than once
self.errors.append(B005(node.lineno, node.col_offset))
def check_for_b006_and_b008(self, node) -> None:
visitor = FunctionDefDefaultsVisitor(
B006, B008, self.b008_b039_extend_immutable_calls
)
visitor.visit(node.args.defaults + node.args.kw_defaults)
self.errors.extend(visitor.errors)
def check_for_b039(self, node: ast.Call) -> None:
if not (
(isinstance(node.func, ast.Name) and node.func.id == "ContextVar")
or (
isinstance(node.func, ast.Attribute)
and node.func.attr == "ContextVar"
and isinstance(node.func.value, ast.Name)
and node.func.value.id == "contextvars"
)
):
return
# ContextVar only takes one kw currently, but better safe than sorry
for kw in node.keywords:
if kw.arg == "default":
break
else:
return
visitor = FunctionDefDefaultsVisitor(
B039, B039, self.b008_b039_extend_immutable_calls
)
visitor.visit(kw.value)
self.errors.extend(visitor.errors)
def check_for_b007(self, node) -> None:
targets = NameFinder()
targets.visit(node.target)
ctrl_names = set(filter(lambda s: not s.startswith("_"), targets.names))
body = NameFinder()
for expr in node.body:
body.visit(expr)
used_names = set(body.names)
for name in sorted(ctrl_names - used_names):
n = targets.names[name][0]
self.errors.append(B007(n.lineno, n.col_offset, vars=(name,)))
def check_for_b011(self, node) -> None:
if isinstance(node.test, ast.Constant) and node.test.value is False:
self.errors.append(B011(node.lineno, node.col_offset))
def check_for_b012(self, node) -> None:
def _loop(node, bad_node_types) -> None:
if isinstance(node, (ast.AsyncFunctionDef, ast.FunctionDef)):
return
if isinstance(node, (ast.While, ast.For)):
bad_node_types = (ast.Return,)
elif isinstance(node, bad_node_types):
self.errors.append(
B012(node.lineno, node.col_offset, vars=(self.in_trystar,))
)
for child in ast.iter_child_nodes(node):
_loop(child, bad_node_types)
for child in node.finalbody:
_loop(child, (ast.Return, ast.Continue, ast.Break))
def check_for_b013_b014_b029_b030(self, node: ast.ExceptHandler) -> list[str]:
handlers: Iterable[ast.expr | None] = _flatten_excepthandler(node.type)
names: list[str] = []
bad_handlers: list[object] = []
ignored_handlers: list[ast.Name | ast.Attribute | ast.Call | ast.Starred] = []
for handler in handlers:
if isinstance(handler, (ast.Name, ast.Attribute)):
name = _to_name_str(handler)
if name is None:
ignored_handlers.append(handler)
else:
names.append(name)
elif isinstance(handler, (ast.Call, ast.Starred)):
ignored_handlers.append(handler)
else:
bad_handlers.append(handler)
if bad_handlers:
self.errors.append(B030(node.lineno, node.col_offset))
if len(names) == 0 and not bad_handlers and not ignored_handlers:
self.errors.append(
B029(node.lineno, node.col_offset, vars=(self.in_trystar,))
)
elif (
len(names) == 1
and not bad_handlers
and not ignored_handlers
and isinstance(node.type, ast.Tuple)
):
self.errors.append(
B013(
node.lineno,
node.col_offset,
vars=(
*names,
self.in_trystar,
),
)
)
else:
maybe_error = _check_redundant_excepthandlers(names, node, self.in_trystar)
if maybe_error is not None:
self.errors.append(maybe_error)
return names
def check_for_b015(self, node) -> None:
if isinstance(self.node_stack[-2], ast.Expr):
self.errors.append(B015(node.lineno, node.col_offset))
def check_for_b016(self, node) -> None:
if isinstance(node.exc, ast.JoinedStr) or (
isinstance(node.exc, ast.Constant)
and (
isinstance(node.exc.value, (int, float, complex, str, bool))
or node.exc.value is None
)
):
self.errors.append(B016(node.lineno, node.col_offset))
def check_for_b017(self, node) -> None:
"""Checks for use of the evil syntax 'with assertRaises(Exception):'
or 'with pytest.raises(Exception)'.
This form of assertRaises will catch everything that subclasses
Exception, which happens to be the vast majority of Python internal
errors, including the ones raised when a non-existing method/function
is called, or a function is called with an invalid dictionary key
lookup.
"""
item = node.items[0]
item_context = item.context_expr
if (
hasattr(item_context, "func")
and (
(
isinstance(item_context.func, ast.Attribute)
and (
item_context.func.attr == "assertRaises"
or (
item_context.func.attr == "raises"
and isinstance(item_context.func.value, ast.Name)
and item_context.func.value.id == "pytest"
and "match"
not in (kwd.arg for kwd in item_context.keywords)
)
)
)
or (
isinstance(item_context.func, ast.Name)
and item_context.func.id == "raises"
and isinstance(item_context.func.ctx, ast.Load)
and "pytest.raises" in self._b005_imports
and "match" not in (kwd.arg for kwd in item_context.keywords)
)
)
and len(item_context.args) == 1
and isinstance(item_context.args[0], ast.Name)
and item_context.args[0].id in {"Exception", "BaseException"}
and not item.optional_vars
):
self.errors.append(B017(node.lineno, node.col_offset))
def check_for_b019(self, node) -> None:
if (
len(node.decorator_list) == 0
or len(self.contexts) < 2
or not isinstance(self.contexts[-2].node, ast.ClassDef)
):
return
# Preserve decorator order so we can get the lineno from the decorator node
# rather than the function node (this location definition changes in Python 3.8)
resolved_decorators = (
".".join(compose_call_path(decorator)) for decorator in node.decorator_list
)
for idx, decorator in enumerate(resolved_decorators):
if decorator in {"classmethod", "staticmethod"}:
return
if decorator in B019_CACHES:
self.errors.append(
B019(
node.decorator_list[idx].lineno,
node.decorator_list[idx].col_offset,
)
)
return
def check_for_b020(self, node) -> None:
targets = NameFinder()
targets.visit(node.target)
ctrl_names = set(targets.names)
iterset = B020NameFinder()
iterset.visit(node.iter)
iterset_names = set(iterset.names)
for name in sorted(ctrl_names):
if name in iterset_names:
n = targets.names[name][0]
self.errors.append(B020(n.lineno, n.col_offset, vars=(name,)))
def check_for_b023(self, loop_node) -> None: # noqa: C901
"""Check that functions (including lambdas) do not use loop variables.
https://docs.python-guide.org/writing/gotchas/#late-binding-closures from
functions - usually but not always lambdas - defined inside a loop are a
classic source of bugs.
For each use of a variable inside a function defined inside a loop, we
emit a warning if that variable is reassigned on each loop iteration
(outside the function). This includes but is not limited to explicit
loop variables like the `x` in `for x in range(3):`.
"""
# Because most loops don't contain functions, it's most efficient to
# implement this "backwards": first we find all the candidate variable
# uses, and then if there are any we check for assignment of those names
# inside the loop body.
safe_functions = []
suspicious_variables = []
for node in ast.walk(loop_node):
# check if function is immediately consumed to avoid false alarm
if isinstance(node, ast.Call):
# check for filter&reduce
if (
isinstance(node.func, ast.Name)
and node.func.id in ("filter", "reduce", "map")
) or (
isinstance(node.func, ast.Attribute)
and node.func.attr == "reduce"
and isinstance(node.func.value, ast.Name)
and node.func.value.id == "functools"
):
for arg in node.args:
if isinstance(arg, FUNCTION_NODES):
safe_functions.append(arg)
# check for key=
for keyword in node.keywords:
if keyword.arg == "key" and isinstance(
keyword.value, FUNCTION_NODES
):
safe_functions.append(keyword.value)
# mark `return lambda: x` as safe
# does not (currently) check inner lambdas in a returned expression
# e.g. `return (lambda: x, )
if isinstance(node, ast.Return):
if isinstance(node.value, FUNCTION_NODES):
safe_functions.append(node.value)
# find unsafe functions
if isinstance(node, FUNCTION_NODES) and node not in safe_functions:
argnames = {
arg.arg for arg in ast.walk(node.args) if isinstance(arg, ast.arg)
}
if isinstance(node, ast.Lambda):
body_nodes = ast.walk(node.body)
else:
body_nodes = itertools.chain.from_iterable(map(ast.walk, node.body))
errors = []
for name in body_nodes:
if isinstance(name, ast.Name) and name.id not in argnames:
if isinstance(name.ctx, ast.Load):
errors.append(
B023(name.lineno, name.col_offset, vars=(name.id,))
)
elif isinstance(name.ctx, ast.Store):
argnames.add(name.id)
for err in errors:
if err.vars[0] not in argnames and err not in self._b023_seen:
self._b023_seen.add(err) # dedupe across nested loops
suspicious_variables.append(err)
if suspicious_variables: