cubicweb/pylintext.py
author Laura Médioni <laura.medioni@logilab.fr>
Tue, 19 Jan 2016 11:43:52 +0100
changeset 11217 1f686f55ef3d
parent 11057 0b59724cb3f2
child 11218 3fea2f3b25c1
permissions -rw-r--r--
[pylint] upgrade pylintext plugin
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
     1
"""Pylint plugin for cubicweb"""
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
     2
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
     3
from astroid import MANAGER, InferenceError, nodes, scoped_nodes, ClassDef, FunctionDef
9311
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
     4
from astroid.builder import AstroidBuilder
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
     5
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
     6
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
     7
def turn_function_to_class(node):
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
     8
    """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
     9
    node.__class__ = ClassDef
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    10
    node.bases = ()
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    11
    # 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
    12
    # function' by pylint
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    13
    for rnode in node.nodes_of_class(nodes.Return):
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    14
        rnode.parent.body.remove(rnode)
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    15
    # that seems to be enough :)
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    16
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    17
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    18
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
    19
    # 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
    20
    # 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
    21
    for assnodes in module.locals.values():
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    22
        for node in assnodes:
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
    23
            if isinstance(node, FunctionDef) and node.decorators:
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    24
                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
    25
                    try:
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    26
                        for infered in decorator.infer():
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    27
                            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
    28
                                turn_function_to_class(node)
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    29
                                break
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    30
                        else:
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    31
                            continue
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    32
                        break
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    33
                    except InferenceError:
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    34
                        continue
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    35
    # 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
    36
    # magic in there
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    37
    if module.name == 'yams.buildobjs':
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    38
        from yams import BASE_TYPES
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    39
        for etype in BASE_TYPES:
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    40
            module.locals[etype] = [scoped_nodes.Class(etype, None)]
8061
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    41
    # add data() to uiprops module
8198
ce9c6ae03c2d [pylint] correctly detect uiprops module when it's not in a package
David Douard <david.douard@logilab.fr>
parents: 8061
diff changeset
    42
    if module.name.split('.')[-1] == 'uiprops':
9311
8833ead6f3e4 update pylint extension to astroid API
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 8696
diff changeset
    43
        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
    44
def data(string):
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    45
  return u''
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    46
''')
88ca47ceb9f2 [pylint] enhance plugin: define 'data' function in uiprops module
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7941
diff changeset
    47
        module.locals['data'] = fake.locals['data']
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    48
11217
1f686f55ef3d [pylint] upgrade pylintext plugin
Laura Médioni <laura.medioni@logilab.fr>
parents: 11057
diff changeset
    49
7941
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    50
def register(linter):
018b5deca73e pylint extension
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
diff changeset
    51
    """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
    52
    MANAGER.register_transform(nodes.Module, cubicweb_transform)