File: redbaron_pylint_plugin.py

package info (click to toggle)
python-redbaron 0.9.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 772 kB
  • sloc: python: 6,650; makefile: 145; sh: 28
file content (75 lines) | stat: -rw-r--r-- 1,933 bytes parent folder | download
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
#!/usr/bin/python
# -*- coding:Utf-8 -*-

""" pylint helper plugin for validating RedBaron

Handles special cases like RedBaron's magic use of imports to create
missing nodes.
Taken in part from https://bitbucket.org/pfctdayelise/pylint-pytest/downloads
"""

from astroid import MANAGER
from astroid import nodes
from astroid.builder import AstroidBuilder

PYTEST_STUB = """
class marker(object):
    def __getattr__(self, name):
        return name

mark = marker()
"""

PLACEHOLDER_CLASS_STUB = """
class {name}(object):
    def __init__(self, *args, **kwargs):
        pass
"""

NODE_PLACEHOLDER_CLASS_STUB = """
class {name}(object):
    def __init__(self, node, *args, **kwargs):
        pass
"""


def pytest_transform(module):
    """ Let pylint know the pytest module """
    pytest = ('pytest', 'py.test')
    if module.name not in pytest:
        return

    astroid_mgr = AstroidBuilder(MANAGER)

    fake = astroid_mgr.string_build(PYTEST_STUB)
    for complex_stub in ('mark',):
        module.locals[complex_stub] = fake.locals[complex_stub]

    for stub in ('skip', 'xfail', 'fixture', 'test', 'raises'):
        text = PLACEHOLDER_CLASS_STUB.format(name=stub)
        fake = astroid_mgr.string_build(text)
        module.locals[stub] = fake.locals[stub]


def redbaron_transform(module):
    """ Let pylint know the redbaron module """
    if module.name != 'redbaron':
        return

    astroid_mgr = AstroidBuilder(MANAGER)

    fake = astroid_mgr.string_build(PYTEST_STUB)
    for stub in ('NameNode', 'PassNode'):
        text = NODE_PLACEHOLDER_CLASS_STUB.format(name=stub)
        fake = astroid_mgr.string_build(text)
        module.locals[stub] = fake.locals[stub]


def register(_):
    """ Registers this plugin to pylint

    pylint calls this function when loading
    """
    MANAGER.register_transform(nodes.Module, pytest_transform)
    MANAGER.register_transform(nodes.Module, redbaron_transform)