mirror of
https://github.com/PyCQA/flake8.git
synced 2026-03-30 18:56:53 +00:00
7fd24c2983
In short, pep8's option processing would bomb out if there were neither args provided or config files present (setup.cfg, tox.ini, .pep8, ...). --install-hook should work regardless of whether a config file is present or not, so we use a callback to add an argument to the parser's internal argument list and skip the check altogether. Links for context are in the comments in this diff.
149 lines
5.4 KiB
Python
149 lines
5.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
import re
|
|
import platform
|
|
|
|
import pep8
|
|
|
|
from flake8 import __version__
|
|
from flake8.reporter import multiprocessing, BaseQReport, QueueReport
|
|
from flake8.util import OrderedSet, is_windows, is_using_stdin
|
|
|
|
_flake8_noqa = re.compile(r'flake8[:=]\s*noqa', re.I).search
|
|
|
|
EXTRA_EXCLUDE = '.tox'
|
|
|
|
|
|
def _register_extensions():
|
|
"""Register all the extensions."""
|
|
extensions = OrderedSet()
|
|
extensions.add(('pep8', pep8.__version__))
|
|
parser_hooks = []
|
|
options_hooks = []
|
|
try:
|
|
from pkg_resources import iter_entry_points
|
|
except ImportError:
|
|
pass
|
|
else:
|
|
for entry in iter_entry_points('flake8.extension'):
|
|
checker = entry.load()
|
|
pep8.register_check(checker, codes=[entry.name])
|
|
extensions.add((checker.name, checker.version))
|
|
if hasattr(checker, 'add_options'):
|
|
parser_hooks.append(checker.add_options)
|
|
if hasattr(checker, 'parse_options'):
|
|
options_hooks.append(checker.parse_options)
|
|
return extensions, parser_hooks, options_hooks
|
|
|
|
|
|
def _install_hook_cb(option, option_str, value, parser):
|
|
# For now, there's no way to affect a change in how pep8 processes
|
|
# options. If no args are provided and there's no config file present,
|
|
# it will error out because no input was provided. To get around this,
|
|
# when we're using --install-hook, we'll say that there were arguments so
|
|
# we can actually attempt to install the hook.
|
|
# See: https://gitlab.com/pycqa/flake8/issues/2 and
|
|
# https://github.com/jcrocholl/pep8/blob/4c5bf00cb613be617c7f48d3b2b82a1c7b895ac1/pep8.py#L1912
|
|
# for more context.
|
|
parser.values.install_hook = True
|
|
parser.rargs.append('.')
|
|
|
|
|
|
def get_parser():
|
|
"""This returns an instance of optparse.OptionParser with all the
|
|
extensions registered and options set. This wraps ``pep8.get_parser``.
|
|
"""
|
|
(extensions, parser_hooks, options_hooks) = _register_extensions()
|
|
details = ', '.join(['%s: %s' % ext for ext in extensions])
|
|
python_version = get_python_version()
|
|
parser = pep8.get_parser('flake8', '%s (%s) %s' % (
|
|
__version__, details, python_version
|
|
))
|
|
for opt in ('--repeat', '--testsuite', '--doctest'):
|
|
try:
|
|
parser.remove_option(opt)
|
|
except ValueError:
|
|
pass
|
|
|
|
if multiprocessing:
|
|
try:
|
|
auto = multiprocessing.cpu_count() or 1
|
|
except NotImplementedError:
|
|
auto = 1
|
|
parser.config_options.append('jobs')
|
|
parser.add_option('-j', '--jobs', type='string', default='auto',
|
|
help="number of jobs to run simultaneously, "
|
|
"or 'auto'. This is ignored on Windows.")
|
|
|
|
parser.add_option('--exit-zero', action='store_true',
|
|
help="exit with code 0 even if there are errors")
|
|
for parser_hook in parser_hooks:
|
|
parser_hook(parser)
|
|
# See comment above regarding why this has to be a callback.
|
|
parser.add_option('--install-hook', default=False, dest='install_hook',
|
|
help='Install the appropriate hook for this '
|
|
'repository.', action='callback', callback=_install_hook_cb)
|
|
return parser, options_hooks
|
|
|
|
|
|
class StyleGuide(pep8.StyleGuide):
|
|
|
|
def input_file(self, filename, lines=None, expected=None, line_offset=0):
|
|
"""Run all checks on a Python source file."""
|
|
if self.options.verbose:
|
|
print('checking %s' % filename)
|
|
fchecker = self.checker_class(
|
|
filename, lines=lines, options=self.options)
|
|
# Any "# flake8: noqa" line?
|
|
if any(_flake8_noqa(line) for line in fchecker.lines):
|
|
return 0
|
|
return fchecker.check_all(expected=expected, line_offset=line_offset)
|
|
|
|
|
|
def get_style_guide(**kwargs):
|
|
"""Parse the options and configure the checker. This returns a sub-class
|
|
of ``pep8.StyleGuide``."""
|
|
kwargs['parser'], options_hooks = get_parser()
|
|
styleguide = StyleGuide(**kwargs)
|
|
options = styleguide.options
|
|
|
|
if options.exclude and not isinstance(options.exclude, list):
|
|
options.exclude = pep8.normalize_paths(options.exclude)
|
|
elif not options.exclude:
|
|
options.exclude = []
|
|
|
|
# Add pattersn in EXTRA_EXCLUDE to the list of excluded patterns
|
|
options.exclude.extend(pep8.normalize_paths(EXTRA_EXCLUDE))
|
|
|
|
for options_hook in options_hooks:
|
|
options_hook(options)
|
|
|
|
if options.diff:
|
|
options.jobs = None
|
|
|
|
force_disable_jobs = is_windows() or is_using_stdin(styleguide.paths)
|
|
|
|
if multiprocessing and options.jobs and not force_disable_jobs:
|
|
if options.jobs.isdigit():
|
|
n_jobs = int(options.jobs)
|
|
else:
|
|
try:
|
|
n_jobs = multiprocessing.cpu_count()
|
|
except NotImplementedError:
|
|
n_jobs = 1
|
|
if n_jobs > 1:
|
|
options.jobs = n_jobs
|
|
reporter = BaseQReport if options.quiet else QueueReport
|
|
report = styleguide.init_report(reporter)
|
|
report.input_file = styleguide.input_file
|
|
styleguide.runner = report.task_queue.put
|
|
|
|
return styleguide
|
|
|
|
|
|
def get_python_version():
|
|
# The implementation isn't all that important.
|
|
try:
|
|
impl = platform.python_implementation() + " "
|
|
except AttributeError: # Python 2.5
|
|
impl = ''
|
|
return '%s%s on %s' % (impl, platform.python_version(), platform.system())
|