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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
|
"""py.test plugin to test with flake8."""
import os
import re
from flake8.main import application
from flake8.options import config
import py
import pytest
__version__ = '0.6'
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")
parser.addini(
"flake8-max-line-length",
help="maximum line length")
parser.addini(
"flake8-max-complexity",
help="McCabe complexity threshold")
parser.addini(
"flake8-show-source", type="bool",
help="show the source generate each error or warning")
parser.addini(
"flake8-statistics", type="bool",
help="count errors and warnings")
parser.addini(
"flake8-extensions", type="args", default=[".py"],
help="a list of file extensions, for example: .py .pyx")
def pytest_configure(config):
"""Start a new session."""
if config.option.flake8:
config._flake8ignore = Ignorer(config.getini("flake8-ignore"))
config._flake8maxlen = config.getini("flake8-max-line-length")
config._flake8maxcomplexity = config.getini("flake8-max-complexity")
config._flake8showshource = config.getini("flake8-show-source")
config._flake8statistics = config.getini("flake8-statistics")
config._flake8exts = config.getini("flake8-extensions")
config.addinivalue_line('markers', "flake8: Tests which run flake8.")
if hasattr(config, 'cache'):
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 in config._flake8exts:
flake8ignore = config._flake8ignore(path)
if flake8ignore is not None:
if hasattr(Flake8Item, "from_parent"):
item = Flake8Item.from_parent(parent, fspath=path)
item.flake8ignore = flake8ignore
item.maxlength = config._flake8maxlen
item.maxcomplexity = config._flake8maxcomplexity
item.showshource = config._flake8showshource
item.statistics = config._flake8statistics
return item
else:
return Flake8Item(
path,
parent,
flake8ignore=flake8ignore,
maxlength=config._flake8maxlen,
maxcomplexity=config._flake8maxcomplexity,
showshource=config._flake8showshource,
statistics=config._flake8statistics)
def pytest_unconfigure(config):
"""Flush cache at end of run."""
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, fspath, parent, flake8ignore=None, maxlength=None,
maxcomplexity=None, showshource=None, statistics=None):
super(Flake8Item, self).__init__(fspath, parent)
self._nodeid += "::FLAKE8"
self.add_marker("flake8")
self.flake8ignore = flake8ignore
self.maxlength = maxlength
self.maxcomplexity = maxcomplexity
self.showshource = showshource
self.statistics = statistics
def setup(self):
if hasattr(self.config, "_flake8mtimes"):
flake8mtimes = self.config._flake8mtimes
else:
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,
self.maxlength,
self.maxcomplexity,
self.showshource,
self.statistics)
if found_errors:
raise Flake8Error(out, err)
# update mtime only if test passed
# otherwise failures would not be re-run next time
if hasattr(self.config, "_flake8mtimes"):
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(r"[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 = [] # noqa: E741
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, maxlength, maxcomplexity,
showshource, statistics):
"""Run flake8 over a single file, and return the number of failures."""
args = []
if maxlength:
args += ['--max-line-length', maxlength]
if maxcomplexity:
args += ['--max-complexity', maxcomplexity]
if showshource:
args += ['--show-source']
if statistics:
args += ['--statistics']
app = application.Application()
if not hasattr(app, 'parse_preliminary_options_and_args'): # flake8 >= 3.8
prelim_opts, remaining_args = app.parse_preliminary_options(args)
config_finder = config.ConfigFileFinder(
app.program,
prelim_opts.append_config,
config_file=prelim_opts.config,
ignore_config_files=prelim_opts.isolated,
)
app.find_plugins(config_finder)
app.register_plugin_options()
app.parse_configuration_and_cli(config_finder, remaining_args)
else:
app.parse_preliminary_options_and_args(args)
app.make_config_finder()
app.find_plugins()
app.register_plugin_options()
app.parse_configuration_and_cli(args)
if flake8ignore:
app.options.ignore = flake8ignore
app.make_formatter() # fix this
if hasattr(app, 'make_notifier'):
# removed in flake8 3.7+
app.make_notifier()
app.make_guide()
app.make_file_checker_manager()
app.run_checks([str(path)])
app.formatter.start()
app.report_errors()
app.formatter.stop()
return app.result_count
|