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
|
from pylint.checkers.base import BasicChecker, astroid
from pylint_plugin_utils import augment_visit
# grumble grumble python3 grumble
try:
BASESTRING = basestring
except NameError:
BASESTRING = str
def allow_attribute_comments(chain, node):
"""
This augmentation is to allow comments on class attributes, for example:
class SomeClass(object):
some_attribute = 5
''' This is a docstring for the above attribute '''
"""
# TODO: find the relevant citation for why this is the correct way to comment attributes
if isinstance(node.previous_sibling(), astroid.Assign) and \
isinstance(node.parent, (astroid.Class, astroid.Module)) and \
isinstance(node.value, astroid.Const) and \
isinstance(node.value.value, BASESTRING):
return
chain()
def apply_augmentations(linter):
if hasattr(BasicChecker, 'visit_expr'):
expr_meth = getattr(BasicChecker, 'visit_expr')
else:
expr_meth = getattr(BasicChecker, 'visit_discard')
augment_visit(linter, expr_meth, allow_attribute_comments)
|
