cubicweb/pylintext.py
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 20 Jan 2016 08:26:30 +0100
changeset 11219 0796b6191cea
parent 11218 3fea2f3b25c1
child 11220 ffef75b7a26e
permissions -rw-r--r--
[pylint] more work on the pylint support * uniformize usage of ClassDef and simplify related import * don't insert in the ast a python function but an astroid representation of that function * ignore __pkginfo__ file * drop attr-rgx, variable-rgx and argument-rgx, put the name in good-names instead * drop additional-builtins * add cell_call to the list of methods for which we don't want 'abstract-method'
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     1
"""Pylint plugin to analyse cubicweb cubes
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     2
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     3
Done:
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     4
* turn functions decorated by @objectify_predicate into classes
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     5
* add yams base types to yams.buildobjs module
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     6
* add data() function to uiprops module's namespace
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     7
* avoid 'abstract method not implemented' for `cell_call`, `entity_call`, `render_body`
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
     8
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
     9
TODO:
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    10
* avoid invalid class name for predicates and predicates
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    11
* W:188, 0: Method '__lt__' is abstract in class 'Entity' but is not overridden (abstract-method)
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    12
* generate entity attributes from the schema?
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    13
"""
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    14
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    15
from astroid import MANAGER, InferenceError, nodes, ClassDef, FunctionDef
9311
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    16
from astroid.builder import AstroidBuilder
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    17
11218
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    18
from pylint.checkers.utils import unimplemented_abstract_methods, class_is_abstract
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    19
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
    20
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    21
def turn_function_to_class(node):
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    22
    """turn a Function node into a Class node (in-place)"""
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
    23
    node.__class__ = ClassDef
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    24
    node.bases = ()
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    25
    # mark class as a new style class
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    26
    node._newstyle = True
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    27
    # remove return nodes so that we don't get warned about 'return outside
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    28
    # function' by pylint
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    29
    for rnode in node.nodes_of_class(nodes.Return):
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    30
        rnode.parent.body.remove(rnode)
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    31
    # add __init__ method to avoid no-init
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    32
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    33
    # that seems to be enough :)
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    34
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    35
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    36
def cubicweb_transform(module):
8190
2a3c1b787688 [vreg] move base registry implementation to logilab.common. Closes #1916014
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8061
diff changeset
    37
    # handle objectify_predicate decorator (and its former name until bw compat
2a3c1b787688 [vreg] move base registry implementation to logilab.common. Closes #1916014
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8061
diff changeset
    38
    # is kept). Only look at module level functions, should be enough.
10663
54b8a1f249fb [py3k] dict.itervalues → dict.values
Rémi Cardona <remi.cardona@logilab.fr>
parents: 9311
diff changeset
    39
    for assnodes in module.locals.values():
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    40
        for node in assnodes:
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
    41
            if isinstance(node, FunctionDef) and node.decorators:
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    42
                for decorator in node.decorators.nodes:
9311
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    43
                    try:
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    44
                        for infered in decorator.infer():
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    45
                            if infered.name in ('objectify_predicate', 'objectify_selector'):
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    46
                                turn_function_to_class(node)
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    47
                                break
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    48
                        else:
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    49
                            continue
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    50
                        break
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    51
                    except InferenceError:
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    52
                        continue
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    53
    # add yams base types into 'yams.buildobjs', astng doesn't grasp globals()
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    54
    # magic in there
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    55
    if module.name == 'yams.buildobjs':
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    56
        from yams import BASE_TYPES
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    57
        for etype in BASE_TYPES:
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    58
            module.locals[etype] = [ClassDef(etype, None)]
8061
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    59
    # add data() to uiprops module
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    60
    elif module.name.split('.')[-1] == 'uiprops':
9311
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    61
        fake = AstroidBuilder(MANAGER).string_build('''
8061
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    62
def data(string):
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    63
  return u''
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    64
''')
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    65
        module.locals['data'] = fake.locals['data']
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    66
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
    67
11218
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    68
def cubicweb_abstractmethods_transform(classdef):
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    69
    if class_is_abstract(classdef):
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    70
        return
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    71
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    72
    def is_abstract(method):
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    73
        return method.is_abstract(pass_is_abstract=False)
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    74
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    75
    methods = sorted(
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    76
        unimplemented_abstract_methods(classdef, is_abstract).items(),
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    77
        key=lambda item: item[0],
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    78
    )
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    79
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    80
    dummy_method = AstroidBuilder(MANAGER).string_build('''
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    81
def dummy_method(self):
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    82
   """"""
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    83
''')
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    84
11218
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    85
    for name, method in methods:
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    86
        owner = method.parent.frame()
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    87
        if owner is classdef:
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    88
            continue
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    89
        if name not in classdef.locals:
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    90
            if name in ('cell_call', 'entity_call', 'render_body'):
11218
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    91
                classdef.set_local(name, dummy_method)
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    92
3fea2f3b25c1 [pylint] remove abstract-method warning
Laura Médioni <laura.medioni@logilab.fr>
parents: 11217
diff changeset
    93
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    94
def register(linter):
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    95
    """called when loaded by pylint --load-plugins, nothing to do here"""
9311
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    96
    MANAGER.register_transform(nodes.Module, cubicweb_transform)
11219
0796b6191cea [pylint] more work on the pylint support
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 11218
diff changeset
    97
    MANAGER.register_transform(ClassDef, cubicweb_abstractmethods_transform)