forked from tholo/pytest-flake8
/
pytest_flake8.py
133 lines (105 loc) · 4.15 KB
/
pytest_flake8.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
"""py.test plugin to test with flake8."""
import re
import py
import pytest
import os
from flake8.engine import get_style_guide
__version__ = '0.1'
HISTKEY = "flake8/mtimes"
def pytest_addoption(parser):
"""Hook up additional options."""
group = parser.getgroup("general")
group.addoption(
'--flake8', action='store_true',
help="perform some flake8 sanity checks on .py files")
parser.addini(
"flake8-ignore", type="linelist",
help="each line specifies a glob pattern and whitespace "
"separated FLAKE8 errors or warnings which will be ignored, "
"example: *.py W293")
def pytest_sessionstart(session):
"""Start a new session."""
config = session.config
if config.option.flake8:
config._flake8ignore = Ignorer(config.getini("flake8-ignore"))
config._flake8mtimes = config.cache.get(HISTKEY, {})
def pytest_collect_file(path, parent):
"""Filter files down to which ones should be checked."""
config = parent.config
if config.option.flake8 and path.ext == '.py':
flake8ignore = config._flake8ignore(path)
if flake8ignore is not None:
return Flake8Item(path, parent, flake8ignore)
def pytest_sessionfinish(session):
"""Flush cache at end of run."""
config = session.config
if hasattr(config, "_flake8mtimes"):
config.cache.set(HISTKEY, config._flake8mtimes)
class Flake8Error(Exception):
""" indicates an error during flake8 checks. """
class Flake8Item(pytest.Item, pytest.File):
def __init__(self, path, parent, flake8ignore):
super(Flake8Item, self).__init__(path, parent)
self.add_marker("flake8")
self.flake8ignore = flake8ignore
def setup(self):
flake8mtimes = self.config._flake8mtimes
self._flake8mtime = self.fspath.mtime()
old = flake8mtimes.get(str(self.fspath), (0, []))
if old == (self._flake8mtime, self.flake8ignore):
pytest.skip("file(s) previously passed FLAKE8 checks")
def runtest(self):
call = py.io.StdCapture.call
found_errors, out, err = call(
check_file, self.fspath, self.flake8ignore)
if found_errors:
raise Flake8Error(out, err)
# update mtime only if test passed
# otherwise failures would not be re-run next time
self.config._flake8mtimes[str(self.fspath)] = (self._flake8mtime,
self.flake8ignore)
def repr_failure(self, excinfo):
if excinfo.errisinstance(Flake8Error):
return excinfo.value.args[0]
return super(Flake8Item, self).repr_failure(excinfo)
def reportinfo(self):
if self.flake8ignore:
ignores = "(ignoring %s)" % " ".join(self.flake8ignore)
else:
ignores = ""
return (self.fspath, -1, "FLAKE8-check%s" % ignores)
class Ignorer:
def __init__(self, ignorelines, coderex=re.compile("[EW]\d\d\d")):
self.ignores = ignores = []
for line in ignorelines:
i = line.find("#")
if i != -1:
line = line[:i]
try:
glob, ign = line.split(None, 1)
except ValueError:
glob, ign = None, line
if glob and coderex.match(glob):
glob, ign = None, line
ign = ign.split()
if "ALL" in ign:
ign = None
if glob and "/" != os.sep and "/" in glob:
glob = glob.replace("/", os.sep)
ignores.append((glob, ign))
def __call__(self, path):
l = []
for (glob, ignlist) in self.ignores:
if not glob or path.fnmatch(glob):
if ignlist is None:
return None
l.extend(ignlist)
return l
def check_file(path, flake8ignore):
"""Run flake8 over a single file, and return the number of failures."""
flake8_style = get_style_guide(parse_argv=False)
options = flake8_style.options
if options.install_hook:
from flake8.hooks import install_hook
install_hook()
return flake8_style.input_file(str(path), expected=flake8ignore)