forked from PyCQA/flake8-bugbear
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bugbear.py
834 lines (720 loc) · 29 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
import ast
import builtins
import itertools
import logging
import re
import sys
from collections import namedtuple
from contextlib import suppress
from functools import lru_cache, partial
from keyword import iskeyword
import attr
import pycodestyle
__version__ = "21.9.2"
LOG = logging.getLogger("flake8.bugbear")
@attr.s(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, default=attr.Factory(lambda: BugBearVisitor))
options = attr.ib(default=None)
def run(self):
if not self.tree or not self.lines:
self.load_file()
visitor = self.visitor(filename=self.filename, lines=self.lines)
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.
"""
for lineno, line in enumerate(self.lines, start=1):
length = len(line) - 1
if length > 1.1 * self.max_line_length:
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):
"""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):
"""Informs flake8 to ignore B9xx by default."""
optmanager.extend_default_ignore(disabled_by_default)
@lru_cache()
def should_warn(self, code):
"""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.
"""
if code[:2] != "B9":
# Normal warnings are safe for emission.
return True
if self.options is None:
LOG.info(
"Options not provided to Bugbear, optional warning %s selected.", code
)
return True
for i in range(2, len(code) + 1):
if code[:i] in self.options.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):
# Return True if arg is a valid identifier, per
# https://docs.python.org/2/reference/lexical_analysis.html#identifiers
if not isinstance(arg, ast.Str):
return False
return re.match(r"^[A-Za-z_][A-Za-z0-9_]*$", arg.s) is not 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.
if isinstance(node, ast.Name):
return node.id
if isinstance(node, ast.Call):
return _to_name_str(node.func)
try:
return _to_name_str(node.value) + "." + node.attr
except AttributeError:
return _to_name_str(node.value)
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
@attr.s
class BugBearVisitor(ast.NodeVisitor):
filename = attr.ib()
lines = attr.ib()
node_stack = attr.ib(default=attr.Factory(list))
node_window = attr.ib(default=attr.Factory(list))
errors = attr.ib(default=attr.Factory(list))
futures = attr.ib(default=attr.Factory(set))
NODE_WINDOW_SIZE = 4
if False:
# Useful for tracing what the hell is going on.
def __getattr__(self, name):
print(name)
return self.__getattribute__(name)
def visit(self, node):
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()
def visit_ExceptHandler(self, node):
if node.type is None:
self.errors.append(
B001(node.lineno, node.col_offset, vars=("bare `except:`",))
)
elif isinstance(node.type, ast.Tuple):
names = [_to_name_str(e) for e in node.type.elts]
as_ = " as " + node.name if node.name is not None else ""
if len(names) == 0:
vs = ("`except (){}:`".format(as_),)
self.errors.append(B001(node.lineno, node.col_offset, vars=vs))
elif len(names) == 1:
self.errors.append(B013(node.lineno, node.col_offset, vars=names))
else:
# 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 hande 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"]
# Find and remove aliases exceptions and only leave the primary alone
primaries = filter(
lambda primary: primary in good, B014.exception_aliases.keys()
)
for primary in primaries:
aliases = B014.exception_aliases[primary]
good = list(filter(lambda e: e not in aliases, good))
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))
self.errors.append(
B014(
node.lineno,
node.col_offset,
vars=(", ".join(names), as_, desc),
)
)
self.generic_visit(node)
def visit_UAdd(self, node):
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):
if isinstance(node.func, ast.Attribute):
self.check_for_b005(node)
else:
with suppress(AttributeError, IndexError):
if (
node.func.id in ("getattr", "hasattr")
and node.args[1].s == "__call__" # noqa: W503
):
self.errors.append(B004(node.lineno, node.col_offset))
if (
node.func.id == "getattr"
and len(node.args) == 2 # noqa: W503
and _is_identifier(node.args[1]) # noqa: W503
and not iskeyword(node.args[1].s) # noqa: W503
):
self.errors.append(B009(node.lineno, node.col_offset))
elif (
node.func.id == "setattr"
and len(node.args) == 3 # noqa: W503
and _is_identifier(node.args[1]) # noqa: W503
and not iskeyword(node.args[1].s) # noqa: W503
):
self.errors.append(B010(node.lineno, node.col_offset))
self.generic_visit(node)
def visit_Assign(self, node):
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):
self.check_for_b007(node)
self.generic_visit(node)
def visit_Assert(self, node):
self.check_for_b011(node)
self.generic_visit(node)
def visit_AsyncFunctionDef(self, node):
self.check_for_b902(node)
self.check_for_b006(node)
self.generic_visit(node)
def visit_FunctionDef(self, node):
self.check_for_b901(node)
self.check_for_b902(node)
self.check_for_b006(node)
self.check_for_b018(node)
self.generic_visit(node)
def visit_ClassDef(self, node):
self.check_for_b903(node)
self.check_for_b018(node)
self.generic_visit(node)
def visit_Try(self, node):
self.check_for_b012(node)
self.generic_visit(node)
def visit_Compare(self, node):
self.check_for_b015(node)
self.generic_visit(node)
def visit_Raise(self, node):
self.check_for_b016(node)
self.check_for_b904(node)
self.generic_visit(node)
def visit_With(self, node):
self.check_for_b017(node)
self.generic_visit(node)
def compose_call_path(self, node):
if isinstance(node, ast.Attribute):
yield from self.compose_call_path(node.value)
yield node.attr
elif isinstance(node, ast.Name):
yield node.id
def check_for_b005(self, node):
if node.func.attr not in B005.methods:
return # method name doesn't match
if len(node.args) != 1 or not isinstance(node.args[0], ast.Str):
return # used arguments don't match the builtin strip
call_path = ".".join(self.compose_call_path(node.func.value))
if call_path in B005.valid_paths:
return # path is exempt
s = node.args[0].s
if len(s) == 1:
return # stripping just one character
if len(s) == len(set(s)):
return # no characters appear more than once
self.errors.append(B005(node.lineno, node.col_offset))
def check_for_b006(self, node):
for default in node.args.defaults + node.args.kw_defaults:
if isinstance(
default, (*B006.mutable_literals, *B006.mutable_comprehensions)
):
self.errors.append(B006(default.lineno, default.col_offset))
elif isinstance(default, ast.Call):
call_path = ".".join(self.compose_call_path(default.func))
if call_path in B006.mutable_calls:
self.errors.append(B006(default.lineno, default.col_offset))
elif call_path not in B008.immutable_calls:
# Check if function call is actually a float infinity/NaN literal
if call_path == "float" and len(default.args) == 1:
float_arg = default.args[0]
if sys.version_info < (3, 8, 0):
# NOTE: pre-3.8, string literals are represented with ast.Str
if isinstance(float_arg, ast.Str):
str_val = float_arg.s
else:
str_val = ""
else:
# NOTE: post-3.8, string literals are represented with ast.Constant
if isinstance(float_arg, ast.Constant):
str_val = float_arg.value
if not isinstance(str_val, str):
str_val = ""
else:
str_val = ""
# NOTE: regex derived from documentation at:
# https://docs.python.org/3/library/functions.html#float
inf_nan_regex = r"^[+-]?(inf|infinity|nan)$"
re_result = re.search(inf_nan_regex, str_val.lower())
is_float_literal = re_result is not None
else:
is_float_literal = False
if not is_float_literal:
self.errors.append(B008(default.lineno, default.col_offset))
def check_for_b007(self, node):
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):
if isinstance(node.test, ast.NameConstant) and node.test.value is False:
self.errors.append(B011(node.lineno, node.col_offset))
def check_for_b012(self, node):
def _loop(node, bad_node_types):
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))
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_b015(self, node):
if isinstance(self.node_stack[-2], ast.Expr):
self.errors.append(B015(node.lineno, node.col_offset))
def check_for_b016(self, node):
if isinstance(node.exc, (ast.NameConstant, ast.Num, ast.Str)):
self.errors.append(B016(node.lineno, node.col_offset))
def check_for_b017(self, node):
"""Checks for use of the evil syntax 'with assertRaises(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 hasattr(item_context.func, "attr") # noqa W503
and item_context.func.attr == "assertRaises" # noqa W503
and len(item_context.args) == 1 # noqa W503
and isinstance(item_context.args[0], ast.Name) # noqa W503
and item_context.args[0].id == "Exception" # noqa W503
and not item.optional_vars # noqa W503
):
self.errors.append(B017(node.lineno, node.col_offset))
def check_for_b904(self, node):
"""Checks `raise` without `from` inside an `except` clause.
In these cases, you should use explicit exception chaining from the
earlier error, or suppress it with `raise ... from None`. See
https://docs.python.org/3/tutorial/errors.html#exception-chaining
"""
if (
node.cause is None
and node.exc is not None
and not (isinstance(node.exc, ast.Name) and node.exc.id.islower())
and any(isinstance(n, ast.ExceptHandler) for n in self.node_stack)
):
self.errors.append(B904(node.lineno, node.col_offset))
def walk_function_body(self, node):
def _loop(parent, node):
if isinstance(node, (ast.AsyncFunctionDef, ast.FunctionDef)):
return
yield parent, node
for child in ast.iter_child_nodes(node):
yield from _loop(node, child)
for child in node.body:
yield from _loop(node, child)
def check_for_b901(self, node):
if node.name == "__await__":
return
has_yield = False
return_node = None
for parent, x in self.walk_function_body(node):
# Only consider yield when it is part of an Expr statement.
if isinstance(parent, ast.Expr) and isinstance(
x, (ast.Yield, ast.YieldFrom)
):
has_yield = True
if isinstance(x, ast.Return) and x.value is not None:
return_node = x
if has_yield and return_node is not None:
self.errors.append(B901(return_node.lineno, return_node.col_offset))
break
def check_for_b902(self, node):
if not isinstance(self.node_stack[-2], ast.ClassDef):
return
decorators = NameFinder()
decorators.visit(node.decorator_list)
if "staticmethod" in decorators.names:
# TODO: maybe warn if the first argument is surprisingly `self` or
# `cls`?
return
bases = {b.id for b in self.node_stack[-2].bases if isinstance(b, ast.Name)}
if "type" in bases:
if (
"classmethod" in decorators.names
or node.name in B902.implicit_classmethods # noqa: W503
):
expected_first_args = B902.metacls
kind = "metaclass class"
else:
expected_first_args = B902.cls
kind = "metaclass instance"
else:
if (
"classmethod" in decorators.names
or node.name in B902.implicit_classmethods # noqa: W503
):
expected_first_args = B902.cls
kind = "class"
else:
expected_first_args = B902.self
kind = "instance"
args = getattr(node.args, "posonlyargs", []) + node.args.args
vararg = node.args.vararg
kwarg = node.args.kwarg
kwonlyargs = node.args.kwonlyargs
if args:
actual_first_arg = args[0].arg
lineno = args[0].lineno
col = args[0].col_offset
elif vararg:
actual_first_arg = "*" + vararg.arg
lineno = vararg.lineno
col = vararg.col_offset
elif kwarg:
actual_first_arg = "**" + kwarg.arg
lineno = kwarg.lineno
col = kwarg.col_offset
elif kwonlyargs:
actual_first_arg = "*, " + kwonlyargs[0].arg
lineno = kwonlyargs[0].lineno
col = kwonlyargs[0].col_offset
else:
actual_first_arg = "(none)"
lineno = node.lineno
col = node.col_offset
if actual_first_arg not in expected_first_args:
if not actual_first_arg.startswith(("(", "*")):
actual_first_arg = repr(actual_first_arg)
self.errors.append(
B902(lineno, col, vars=(actual_first_arg, kind, expected_first_args[0]))
)
def check_for_b903(self, node):
body = node.body
if (
body
and isinstance(body[0], ast.Expr) # noqa: W503
and isinstance(body[0].value, ast.Str) # noqa: W503
):
# Ignore the docstring
body = body[1:]
if (
len(body) != 1
or not isinstance(body[0], ast.FunctionDef) # noqa: W503
or body[0].name != "__init__" # noqa: W503
):
# only classes with *just* an __init__ method are interesting
return
# all the __init__ function does is a series of assignments to attributes
for stmt in body[0].body:
if not isinstance(stmt, ast.Assign):
return
targets = stmt.targets
if len(targets) > 1 or not isinstance(targets[0], ast.Attribute):
return
if not isinstance(stmt.value, ast.Name):
return
self.errors.append(B903(node.lineno, node.col_offset))
def check_for_b018(self, node):
for subnode in node.body[1:]:
if isinstance(subnode, ast.Expr) and isinstance(
subnode.value,
(
ast.Str,
ast.Num,
ast.Bytes,
ast.NameConstant,
ast.JoinedStr,
ast.List,
ast.Set,
ast.Dict,
),
):
self.errors.append(B018(subnode.lineno, subnode.col_offset))
@attr.s
class NameFinder(ast.NodeVisitor):
"""Finds a name within a tree of nodes.
After `.visit(node)` is called, `found` is a dict with all name nodes inside,
key is name string, value is the node (useful for location purposes).
"""
names = attr.ib(default=attr.Factory(dict))
def visit_Name(self, node):
self.names.setdefault(node.id, []).append(node)
def visit(self, node):
"""Like super-visit but supports iteration over lists."""
if not isinstance(node, list):
return super().visit(node)
for elem in node:
super().visit(elem)
return node
error = namedtuple("error", "lineno col message type vars")
Error = partial(partial, error, type=BugBearChecker, vars=())
B001 = Error(
message=(
"B001 Do not use {}, it also catches unexpected "
"events like memory errors, interrupts, system exit, and so on. "
"Prefer `except Exception:`. If you're sure what you're doing, "
"be explicit and write `except BaseException:`."
)
)
B002 = Error(
message=(
"B002 Python does not support the unary prefix increment. Writing "
"++n is equivalent to +(+(n)), which equals n. You meant n += 1."
)
)
B003 = Error(
message=(
"B003 Assigning to `os.environ` doesn't clear the environment. "
"Subprocesses are going to see outdated variables, in disagreement "
"with the current process. Use `os.environ.clear()` or the `env=` "
"argument to Popen."
)
)
B004 = Error(
message=(
"B004 Using `hasattr(x, '__call__')` to test if `x` is callable "
"is unreliable. If `x` implements custom `__getattr__` or its "
"`__call__` is itself not callable, you might get misleading "
"results. Use `callable(x)` for consistent results."
)
)
B005 = Error(
message=(
"B005 Using .strip() with multi-character strings is misleading "
"the reader. It looks like stripping a substring. Move your "
"character set to a constant if this is deliberate. Use "
".replace() or regular expressions to remove string fragments."
)
)
B005.methods = {"lstrip", "rstrip", "strip"}
B005.valid_paths = {}
B006 = Error(
message=(
"B006 Do not use mutable data structures for argument defaults. They "
"are created during function definition time. All calls to the function "
"reuse this one instance of that data structure, persisting changes "
"between them."
)
)
B006.mutable_literals = (ast.Dict, ast.List, ast.Set)
B006.mutable_comprehensions = (ast.ListComp, ast.DictComp, ast.SetComp)
B006.mutable_calls = {
"Counter",
"OrderedDict",
"collections.Counter",
"collections.OrderedDict",
"collections.defaultdict",
"collections.deque",
"defaultdict",
"deque",
"dict",
"list",
"set",
}
B007 = Error(
message=(
"B007 Loop control variable {!r} not used within the loop body. "
"If this is intended, start the name with an underscore."
)
)
B008 = Error(
message=(
"B008 Do not perform function calls in argument defaults. The call is "
"performed only once at function definition time. All calls to your "
"function will reuse the result of that definition-time function call. If "
"this is intended, assign the function call to a module-level variable and "
"use that variable as a default value."
)
)
B008.immutable_calls = {
"tuple",
"frozenset",
"types.MappingProxyType",
"MappingProxyType",
"re.compile",
"operator.attrgetter",
"operator.itemgetter",
"operator.methodcaller",
"attrgetter",
"itemgetter",
"methodcaller",
}
B009 = Error(
message=(
"B009 Do not call getattr with a constant attribute value, "
"it is not any safer than normal property access."
)
)
B010 = Error(
message=(
"B010 Do not call setattr with a constant attribute value, "
"it is not any safer than normal property access."
)
)
B011 = Error(
message=(
"B011 Do not call assert False since python -O removes these calls. "
"Instead callers should raise AssertionError()."
)
)
B012 = Error(
message=(
"B012 return/continue/break inside finally blocks cause exceptions "
"to be silenced. Exceptions should be silenced in except blocks. Control "
"statements can be moved outside the finally block."
)
)
B013 = Error(
message=(
"B013 A length-one tuple literal is redundant. "
"Write `except {0}:` instead of `except ({0},):`."
)
)
B014 = Error(
message=(
"B014 Redundant exception types in `except ({0}){1}:`. "
"Write `except {2}{1}:`, which catches exactly the same exceptions."
)
)
B014.exception_aliases = {
"OSError": {
"IOError",
"EnvironmentError",
"WindowsError",
"mmap.error",
"socket.error",
"select.error",
}
}
B015 = Error(
message=(
"B015 Pointless comparison. This comparison does nothing but waste "
"CPU instructions. Either prepend `assert` or remove it."
)
)
B016 = Error(
message=(
"B016 Cannot raise a literal. Did you intend to return it or raise "
"an Exception?"
)
)
B017 = Error(
message=(
"B017 assertRaises(Exception): should be considered evil. "
"It can lead to your test passing even if the code being tested is "
"never executed due to a typo. Either assert for a more specific "
"exception (builtin or custom), use assertRaisesRegex, or use the "
"context manager form of assertRaises."
)
)
B018 = Error(
message=(
"B018 Found useless expression. Either assign it to a variable or remove it."
)
)
# Warnings disabled by default.
B901 = Error(
message=(
"B901 Using `yield` together with `return x`. Use native "
"`async def` coroutines or put a `# noqa` comment on this "
"line if this was intentional."
)
)
B902 = Error(
message=(
"B902 Invalid first argument {} used for {} method. Use the "
"canonical first argument name in methods, i.e. {}."
)
)
B902.implicit_classmethods = {"__new__", "__init_subclass__", "__class_getitem__"}
B902.self = ["self"] # it's a list because the first is preferred
B902.cls = ["cls", "klass"] # ditto.
B902.metacls = ["metacls", "metaclass", "typ", "mcs"] # ditto.
B903 = Error(
message=(
"B903 Data class should either be immutable or use __slots__ to "
"save memory. Use collections.namedtuple to generate an immutable "
"class, or enumerate the attributes in a __slot__ declaration in "
"the class to leave attributes mutable."
)
)
B904 = Error(
message=(
"B904 Within an `except` clause, raise exceptions with `raise ... from err` or"
" `raise ... from None` to distinguish them from errors in exception handling. "
" See https://docs.python.org/3/tutorial/errors.html#exception-chaining for"
" details."
)
)
B950 = Error(message="B950 line too long ({} > {} characters)")
disabled_by_default = ["B901", "B902", "B903", "B904", "B950"]