mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-14 16:34:46 +00:00
Refactor parts of flake8.main.cli into separate modules
This commit is contained in:
Ian Cordasco
parent
de587a9ccb
commit
53438fca1d
4 changed files with 472 additions and 464 deletions
277
flake8/main/application.py
Normal file
277
flake8/main/application.py
Normal file
|
|
@ -0,0 +1,277 @@
|
||||||
|
"""Module containing the application logic for Flake8."""
|
||||||
|
from __future__ import print_function
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import sys
|
||||||
|
|
||||||
|
import flake8
|
||||||
|
from flake8 import checker
|
||||||
|
from flake8 import style_guide
|
||||||
|
from flake8 import utils
|
||||||
|
from flake8.main import options
|
||||||
|
from flake8.options import aggregator
|
||||||
|
from flake8.options import manager
|
||||||
|
from flake8.plugins import manager as plugin_manager
|
||||||
|
|
||||||
|
LOG = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class Application(object):
|
||||||
|
"""Abstract our application into a class."""
|
||||||
|
|
||||||
|
def __init__(self, program='flake8', version=flake8.__version__):
|
||||||
|
# type: (str, str) -> NoneType
|
||||||
|
"""Initialize our application.
|
||||||
|
|
||||||
|
:param str program:
|
||||||
|
The name of the program/application that we're executing.
|
||||||
|
:param str version:
|
||||||
|
The version of the program/application we're executing.
|
||||||
|
"""
|
||||||
|
#: The name of the program being run
|
||||||
|
self.program = program
|
||||||
|
#: The version of the program being run
|
||||||
|
self.version = version
|
||||||
|
#: The instance of :class:`flake8.options.manager.OptionManager` used
|
||||||
|
#: to parse and handle the options and arguments passed by the user
|
||||||
|
self.option_manager = None
|
||||||
|
temp_option_manager = manager.OptionManager(
|
||||||
|
prog='flake8', version=flake8.__version__
|
||||||
|
)
|
||||||
|
options.register_default_options(temp_option_manager)
|
||||||
|
|
||||||
|
# We haven't found or registered our plugins yet, so let's defer
|
||||||
|
# printing the version until we aggregate options from config files
|
||||||
|
# and the command-line. First, let's clone our arguments on the CLI,
|
||||||
|
# then we'll attempt to remove ``--version`` so that we can avoid
|
||||||
|
# triggering the "version" action in optparse. If it's not there, we
|
||||||
|
# do not need to worry and we can continue. If it is, we successfully
|
||||||
|
# defer printing the version until just a little bit later.
|
||||||
|
# Similarly we have to defer printing the help text until later.
|
||||||
|
args = sys.argv[:]
|
||||||
|
try:
|
||||||
|
args.remove('--version')
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
args.remove('--help')
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
try:
|
||||||
|
args.remove('-h')
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
preliminary_opts, _ = temp_option_manager.parse_args(args)
|
||||||
|
# Set the verbosity of the program
|
||||||
|
flake8.configure_logging(preliminary_opts.verbose,
|
||||||
|
preliminary_opts.output_file)
|
||||||
|
|
||||||
|
#: The instance of :class:`flake8.plugins.manager.Checkers`
|
||||||
|
self.check_plugins = None
|
||||||
|
#: The instance of :class:`flake8.plugins.manager.Listeners`
|
||||||
|
self.listening_plugins = None
|
||||||
|
#: The instance of :class:`flake8.plugins.manager.ReportFormatters`
|
||||||
|
self.formatting_plugins = None
|
||||||
|
#: The user-selected formatter from :attr:`formatting_plugins`
|
||||||
|
self.formatter = None
|
||||||
|
#: The :class:`flake8.plugins.notifier.Notifier` for listening plugins
|
||||||
|
self.listener_trie = None
|
||||||
|
#: The :class:`flake8.style_guide.StyleGuide` built from the user's
|
||||||
|
#: options
|
||||||
|
self.guide = None
|
||||||
|
#: The :class:`flake8.checker.Manager` that will handle running all of
|
||||||
|
#: the checks selected by the user.
|
||||||
|
self.file_checker_manager = None
|
||||||
|
|
||||||
|
#: The user-supplied options parsed into an instance of
|
||||||
|
#: :class:`optparse.Values`
|
||||||
|
self.options = None
|
||||||
|
#: The left over arguments that were not parsed by
|
||||||
|
#: :attr:`option_manager`
|
||||||
|
self.args = None
|
||||||
|
#: The number of errors, warnings, and other messages after running
|
||||||
|
#: flake8 and taking into account ignored errors and lines.
|
||||||
|
self.result_count = 0
|
||||||
|
#: The total number of errors before accounting for ignored errors and
|
||||||
|
#: lines.
|
||||||
|
self.total_result_count = 0
|
||||||
|
|
||||||
|
#: Whether the program is processing a diff or not
|
||||||
|
self.running_against_diff = False
|
||||||
|
#: The parsed diff information
|
||||||
|
self.parsed_diff = {}
|
||||||
|
|
||||||
|
def exit(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Handle finalization and exiting the program.
|
||||||
|
|
||||||
|
This should be the last thing called on the application instance. It
|
||||||
|
will check certain options and exit appropriately.
|
||||||
|
"""
|
||||||
|
if self.options.count:
|
||||||
|
print(self.result_count)
|
||||||
|
|
||||||
|
if not self.options.exit_zero:
|
||||||
|
raise SystemExit(self.result_count > 0)
|
||||||
|
|
||||||
|
def find_plugins(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Find and load the plugins for this application.
|
||||||
|
|
||||||
|
If :attr:`check_plugins`, :attr:`listening_plugins`, or
|
||||||
|
:attr:`formatting_plugins` are ``None`` then this method will update
|
||||||
|
them with the appropriate plugin manager instance. Given the expense
|
||||||
|
of finding plugins (via :mod:`pkg_resources`) we want this to be
|
||||||
|
idempotent and so only update those attributes if they are ``None``.
|
||||||
|
"""
|
||||||
|
if self.check_plugins is None:
|
||||||
|
self.check_plugins = plugin_manager.Checkers()
|
||||||
|
|
||||||
|
if self.listening_plugins is None:
|
||||||
|
self.listening_plugins = plugin_manager.Listeners()
|
||||||
|
|
||||||
|
if self.formatting_plugins is None:
|
||||||
|
self.formatting_plugins = plugin_manager.ReportFormatters()
|
||||||
|
|
||||||
|
self.check_plugins.load_plugins()
|
||||||
|
self.listening_plugins.load_plugins()
|
||||||
|
self.formatting_plugins.load_plugins()
|
||||||
|
|
||||||
|
def register_plugin_options(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Register options provided by plugins to our option manager."""
|
||||||
|
self.check_plugins.register_options(self.option_manager)
|
||||||
|
self.check_plugins.register_plugin_versions(self.option_manager)
|
||||||
|
self.listening_plugins.register_options(self.option_manager)
|
||||||
|
self.formatting_plugins.register_options(self.option_manager)
|
||||||
|
|
||||||
|
def parse_configuration_and_cli(self, argv=None):
|
||||||
|
# type: (Union[NoneType, List[str]]) -> NoneType
|
||||||
|
"""Parse configuration files and the CLI options.
|
||||||
|
|
||||||
|
:param list argv:
|
||||||
|
Command-line arguments passed in directly.
|
||||||
|
"""
|
||||||
|
if self.options is None and self.args is None:
|
||||||
|
self.options, self.args = aggregator.aggregate_options(
|
||||||
|
self.option_manager, argv
|
||||||
|
)
|
||||||
|
|
||||||
|
self.running_against_diff = self.options.diff
|
||||||
|
if self.running_against_diff:
|
||||||
|
self.parsed_diff = utils.parse_unified_diff()
|
||||||
|
|
||||||
|
self.check_plugins.provide_options(self.option_manager, self.options,
|
||||||
|
self.args)
|
||||||
|
self.listening_plugins.provide_options(self.option_manager,
|
||||||
|
self.options,
|
||||||
|
self.args)
|
||||||
|
self.formatting_plugins.provide_options(self.option_manager,
|
||||||
|
self.options,
|
||||||
|
self.args)
|
||||||
|
|
||||||
|
def make_formatter(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Initialize a formatter based on the parsed options."""
|
||||||
|
if self.formatter is None:
|
||||||
|
self.formatter = self.formatting_plugins.get(
|
||||||
|
self.options.format, self.formatting_plugins['default']
|
||||||
|
).execute(self.options)
|
||||||
|
|
||||||
|
def make_notifier(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Initialize our listener Notifier."""
|
||||||
|
if self.listener_trie is None:
|
||||||
|
self.listener_trie = self.listening_plugins.build_notifier()
|
||||||
|
|
||||||
|
def make_guide(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Initialize our StyleGuide."""
|
||||||
|
if self.guide is None:
|
||||||
|
self.guide = style_guide.StyleGuide(
|
||||||
|
self.options, self.listener_trie, self.formatter
|
||||||
|
)
|
||||||
|
|
||||||
|
if self.running_against_diff:
|
||||||
|
self.guide.add_diff_ranges(self.parsed_diff)
|
||||||
|
|
||||||
|
def make_file_checker_manager(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Initialize our FileChecker Manager."""
|
||||||
|
if self.file_checker_manager is None:
|
||||||
|
self.file_checker_manager = checker.Manager(
|
||||||
|
style_guide=self.guide,
|
||||||
|
arguments=self.args,
|
||||||
|
checker_plugins=self.check_plugins,
|
||||||
|
)
|
||||||
|
|
||||||
|
def run_checks(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Run the actual checks with the FileChecker Manager.
|
||||||
|
|
||||||
|
This method encapsulates the logic to make a
|
||||||
|
:class:`~flake8.checker.Manger` instance run the checks it is
|
||||||
|
managing.
|
||||||
|
"""
|
||||||
|
files = None
|
||||||
|
if self.running_against_diff:
|
||||||
|
files = list(sorted(self.parsed_diff.keys()))
|
||||||
|
self.file_checker_manager.start(files)
|
||||||
|
self.file_checker_manager.run()
|
||||||
|
LOG.info('Finished running')
|
||||||
|
self.file_checker_manager.stop()
|
||||||
|
|
||||||
|
def report_errors(self):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Report all the errors found by flake8 3.0.
|
||||||
|
|
||||||
|
This also updates the :attr:`result_count` attribute with the total
|
||||||
|
number of errors, warnings, and other messages found.
|
||||||
|
"""
|
||||||
|
LOG.info('Reporting errors')
|
||||||
|
results = self.file_checker_manager.report()
|
||||||
|
self.total_result_count, self.result_count = results
|
||||||
|
LOG.info('Found a total of %d results and reported %d',
|
||||||
|
self.total_result_count, self.result_count)
|
||||||
|
|
||||||
|
def initialize(self, argv):
|
||||||
|
# type: () -> NoneType
|
||||||
|
"""Initialize the application to be run.
|
||||||
|
|
||||||
|
This finds the plugins, registers their options, and parses the
|
||||||
|
command-line arguments.
|
||||||
|
"""
|
||||||
|
self.option_manager = manager.OptionManager(
|
||||||
|
prog='flake8', version=flake8.__version__
|
||||||
|
)
|
||||||
|
self.find_plugins()
|
||||||
|
options.register_default_options(self.option_manager,
|
||||||
|
self.formatting_plugins.names)
|
||||||
|
self.register_plugin_options()
|
||||||
|
self.parse_configuration_and_cli(argv)
|
||||||
|
self.make_formatter()
|
||||||
|
self.make_notifier()
|
||||||
|
self.make_guide()
|
||||||
|
self.make_file_checker_manager()
|
||||||
|
|
||||||
|
def _run(self, argv):
|
||||||
|
# type: (Union[NoneType, List[str]]) -> NoneType
|
||||||
|
self.initialize(argv)
|
||||||
|
self.run_checks()
|
||||||
|
self.report_errors()
|
||||||
|
|
||||||
|
def run(self, argv=None):
|
||||||
|
# type: (Union[NoneType, List[str]]) -> NoneType
|
||||||
|
"""Run our application.
|
||||||
|
|
||||||
|
This method will also handle KeyboardInterrupt exceptions for the
|
||||||
|
entirety of the flake8 application. If it sees a KeyboardInterrupt it
|
||||||
|
will forcibly clean up the :class:`~flake8.checker.Manager`.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
self._run(argv)
|
||||||
|
except KeyboardInterrupt as exc:
|
||||||
|
LOG.critical('Caught keyboard interrupt from user')
|
||||||
|
LOG.exception(exc)
|
||||||
|
self.file_checker_manager._force_cleanup()
|
||||||
|
|
@ -1,465 +1,5 @@
|
||||||
"""Command-line implementation of flake8."""
|
"""Command-line implementation of flake8."""
|
||||||
from __future__ import print_function
|
from flake8.main import application
|
||||||
|
|
||||||
import logging
|
|
||||||
import sys
|
|
||||||
|
|
||||||
import flake8
|
|
||||||
from flake8 import checker
|
|
||||||
from flake8 import defaults
|
|
||||||
from flake8 import style_guide
|
|
||||||
from flake8 import utils
|
|
||||||
from flake8.main import vcs
|
|
||||||
from flake8.options import aggregator
|
|
||||||
from flake8.options import manager
|
|
||||||
from flake8.plugins import manager as plugin_manager
|
|
||||||
|
|
||||||
LOG = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
def register_default_options(option_manager, formatters=None):
|
|
||||||
"""Register the default options on our OptionManager.
|
|
||||||
|
|
||||||
The default options include:
|
|
||||||
|
|
||||||
- ``-v``/``--verbose``
|
|
||||||
- ``-q``/``--quiet``
|
|
||||||
- ``--count``
|
|
||||||
- ``--diff``
|
|
||||||
- ``--exclude``
|
|
||||||
- ``--filename``
|
|
||||||
- ``--format``
|
|
||||||
- ``--hang-closing``
|
|
||||||
- ``--ignore``
|
|
||||||
- ``--max-line-length``
|
|
||||||
- ``--select``
|
|
||||||
- ``--disable-noqa``
|
|
||||||
- ``--show-source``
|
|
||||||
- ``--statistics``
|
|
||||||
- ``--enable-extensions``
|
|
||||||
- ``--exit-zero``
|
|
||||||
- ``-j``/``--jobs``
|
|
||||||
- ``--output-file``
|
|
||||||
- ``--append-config``
|
|
||||||
- ``--config``
|
|
||||||
- ``--isolated``
|
|
||||||
"""
|
|
||||||
add_option = option_manager.add_option
|
|
||||||
|
|
||||||
# pep8 options
|
|
||||||
add_option(
|
|
||||||
'-v', '--verbose', default=0, action='count',
|
|
||||||
parse_from_config=True,
|
|
||||||
help='Print more information about what is happening in flake8.'
|
|
||||||
' This option is repeatable and will increase verbosity each '
|
|
||||||
'time it is repeated.',
|
|
||||||
)
|
|
||||||
add_option(
|
|
||||||
'-q', '--quiet', default=0, action='count',
|
|
||||||
parse_from_config=True,
|
|
||||||
help='Report only file names, or nothing. This option is repeatable.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--count', action='store_true', parse_from_config=True,
|
|
||||||
help='Print total number of errors and warnings to standard error and'
|
|
||||||
' set the exit code to 1 if total is not empty.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--diff', action='store_true',
|
|
||||||
help='Report changes only within line number ranges in the unified '
|
|
||||||
'diff provided on standard in by the user.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--exclude', metavar='patterns', default=defaults.EXCLUDE,
|
|
||||||
comma_separated_list=True, parse_from_config=True,
|
|
||||||
normalize_paths=True,
|
|
||||||
help='Comma-separated list of files or directories to exclude.'
|
|
||||||
' (Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--filename', metavar='patterns', default='*.py',
|
|
||||||
parse_from_config=True, comma_separated_list=True,
|
|
||||||
help='Only check for filenames matching the patterns in this comma-'
|
|
||||||
'separated list. (Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--stdin-display-name', default='stdin',
|
|
||||||
help='The name used when reporting errors from code passed via stdin.'
|
|
||||||
' This is useful for editors piping the file contents to flake8.'
|
|
||||||
' (Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
# TODO(sigmavirus24): Figure out --first/--repeat
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--format', metavar='format', default='default',
|
|
||||||
parse_from_config=True, choices=(formatters or []),
|
|
||||||
help='Format errors according to the chosen formatter.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--hang-closing', action='store_true', parse_from_config=True,
|
|
||||||
help='Hang closing bracket instead of matching indentation of opening'
|
|
||||||
" bracket's line.",
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--ignore', metavar='errors', default=defaults.IGNORE,
|
|
||||||
parse_from_config=True, comma_separated_list=True,
|
|
||||||
help='Comma-separated list of errors and warnings to ignore (or skip).'
|
|
||||||
' For example, ``--ignore=E4,E51,W234``. (Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--max-line-length', type='int', metavar='n',
|
|
||||||
default=defaults.MAX_LINE_LENGTH, parse_from_config=True,
|
|
||||||
help='Maximum allowed line length for the entirety of this run. '
|
|
||||||
'(Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--select', metavar='errors', default='',
|
|
||||||
parse_from_config=True, comma_separated_list=True,
|
|
||||||
help='Comma-separated list of errors and warnings to enable.'
|
|
||||||
' For example, ``--select=E4,E51,W234``. (Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--disable-noqa', default=False, parse_from_config=True,
|
|
||||||
action='store_true',
|
|
||||||
help='Disable the effect of "# noqa". This will report errors on '
|
|
||||||
'lines with "# noqa" at the end.'
|
|
||||||
)
|
|
||||||
|
|
||||||
# TODO(sigmavirus24): Decide what to do about --show-pep8
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--show-source', action='store_true', parse_from_config=True,
|
|
||||||
help='Show the source generate each error or warning.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--statistics', action='store_true', parse_from_config=True,
|
|
||||||
help='Count errors and warnings.',
|
|
||||||
)
|
|
||||||
|
|
||||||
# Flake8 options
|
|
||||||
add_option(
|
|
||||||
'--enable-extensions', default='', parse_from_config=True,
|
|
||||||
comma_separated_list=True, type='string',
|
|
||||||
help='Enable plugins and extensions that are otherwise disabled '
|
|
||||||
'by default',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--exit-zero', action='store_true',
|
|
||||||
help='Exit with status code "0" even if there are errors.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--install-hook', action='callback', type='string',
|
|
||||||
choices=vcs.choices(), callback=vcs.install,
|
|
||||||
help='Install a hook that is run prior to a commit for the supported '
|
|
||||||
'version control systema.'
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'-j', '--jobs', type='string', default='auto', parse_from_config=True,
|
|
||||||
help='Number of subprocesses to use to run checks in parallel. '
|
|
||||||
'This is ignored on Windows. The default, "auto", will '
|
|
||||||
'auto-detect the number of processors available to use.'
|
|
||||||
' (Default: %default)',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--output-file', default=None, type='string', parse_from_config=True,
|
|
||||||
# callback=callbacks.redirect_stdout,
|
|
||||||
help='Redirect report to a file.',
|
|
||||||
)
|
|
||||||
|
|
||||||
# Config file options
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--append-config', action='append',
|
|
||||||
help='Provide extra config files to parse in addition to the files '
|
|
||||||
'found by Flake8 by default. These files are the last ones read '
|
|
||||||
'and so they take the highest precedence when multiple files '
|
|
||||||
'provide the same option.',
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--config', default=None,
|
|
||||||
help='Path to the config file that will be the authoritative config '
|
|
||||||
'source. This will cause Flake8 to ignore all other '
|
|
||||||
'configuration files.'
|
|
||||||
)
|
|
||||||
|
|
||||||
add_option(
|
|
||||||
'--isolated', default=False, action='store_true',
|
|
||||||
help='Ignore all found configuration files.',
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Application(object):
|
|
||||||
"""Abstract our application into a class."""
|
|
||||||
|
|
||||||
def __init__(self, program='flake8', version=flake8.__version__):
|
|
||||||
# type: (str, str) -> NoneType
|
|
||||||
"""Initialize our application.
|
|
||||||
|
|
||||||
:param str program:
|
|
||||||
The name of the program/application that we're executing.
|
|
||||||
:param str version:
|
|
||||||
The version of the program/application we're executing.
|
|
||||||
"""
|
|
||||||
#: The name of the program being run
|
|
||||||
self.program = program
|
|
||||||
#: The version of the program being run
|
|
||||||
self.version = version
|
|
||||||
#: The instance of :class:`flake8.options.manager.OptionManager` used
|
|
||||||
#: to parse and handle the options and arguments passed by the user
|
|
||||||
self.option_manager = None
|
|
||||||
temp_option_manager = manager.OptionManager(
|
|
||||||
prog='flake8', version=flake8.__version__
|
|
||||||
)
|
|
||||||
register_default_options(temp_option_manager)
|
|
||||||
|
|
||||||
# We haven't found or registered our plugins yet, so let's defer
|
|
||||||
# printing the version until we aggregate options from config files
|
|
||||||
# and the command-line. First, let's clone our arguments on the CLI,
|
|
||||||
# then we'll attempt to remove ``--version`` so that we can avoid
|
|
||||||
# triggering the "version" action in optparse. If it's not there, we
|
|
||||||
# do not need to worry and we can continue. If it is, we successfully
|
|
||||||
# defer printing the version until just a little bit later.
|
|
||||||
# Similarly we have to defer printing the help text until later.
|
|
||||||
args = sys.argv[:]
|
|
||||||
try:
|
|
||||||
args.remove('--version')
|
|
||||||
except ValueError:
|
|
||||||
pass
|
|
||||||
try:
|
|
||||||
args.remove('--help')
|
|
||||||
except ValueError:
|
|
||||||
pass
|
|
||||||
try:
|
|
||||||
args.remove('-h')
|
|
||||||
except ValueError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
preliminary_opts, _ = temp_option_manager.parse_args(args)
|
|
||||||
# Set the verbosity of the program
|
|
||||||
flake8.configure_logging(preliminary_opts.verbose,
|
|
||||||
preliminary_opts.output_file)
|
|
||||||
|
|
||||||
#: The instance of :class:`flake8.plugins.manager.Checkers`
|
|
||||||
self.check_plugins = None
|
|
||||||
#: The instance of :class:`flake8.plugins.manager.Listeners`
|
|
||||||
self.listening_plugins = None
|
|
||||||
#: The instance of :class:`flake8.plugins.manager.ReportFormatters`
|
|
||||||
self.formatting_plugins = None
|
|
||||||
#: The user-selected formatter from :attr:`formatting_plugins`
|
|
||||||
self.formatter = None
|
|
||||||
#: The :class:`flake8.plugins.notifier.Notifier` for listening plugins
|
|
||||||
self.listener_trie = None
|
|
||||||
#: The :class:`flake8.style_guide.StyleGuide` built from the user's
|
|
||||||
#: options
|
|
||||||
self.guide = None
|
|
||||||
#: The :class:`flake8.checker.Manager` that will handle running all of
|
|
||||||
#: the checks selected by the user.
|
|
||||||
self.file_checker_manager = None
|
|
||||||
|
|
||||||
#: The user-supplied options parsed into an instance of
|
|
||||||
#: :class:`optparse.Values`
|
|
||||||
self.options = None
|
|
||||||
#: The left over arguments that were not parsed by
|
|
||||||
#: :attr:`option_manager`
|
|
||||||
self.args = None
|
|
||||||
#: The number of errors, warnings, and other messages after running
|
|
||||||
#: flake8 and taking into account ignored errors and lines.
|
|
||||||
self.result_count = 0
|
|
||||||
#: The total number of errors before accounting for ignored errors and
|
|
||||||
#: lines.
|
|
||||||
self.total_result_count = 0
|
|
||||||
|
|
||||||
#: Whether the program is processing a diff or not
|
|
||||||
self.running_against_diff = False
|
|
||||||
#: The parsed diff information
|
|
||||||
self.parsed_diff = {}
|
|
||||||
|
|
||||||
def exit(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Handle finalization and exiting the program.
|
|
||||||
|
|
||||||
This should be the last thing called on the application instance. It
|
|
||||||
will check certain options and exit appropriately.
|
|
||||||
"""
|
|
||||||
if self.options.count:
|
|
||||||
print(self.result_count)
|
|
||||||
|
|
||||||
if not self.options.exit_zero:
|
|
||||||
raise SystemExit(self.result_count > 0)
|
|
||||||
|
|
||||||
def find_plugins(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Find and load the plugins for this application.
|
|
||||||
|
|
||||||
If :attr:`check_plugins`, :attr:`listening_plugins`, or
|
|
||||||
:attr:`formatting_plugins` are ``None`` then this method will update
|
|
||||||
them with the appropriate plugin manager instance. Given the expense
|
|
||||||
of finding plugins (via :mod:`pkg_resources`) we want this to be
|
|
||||||
idempotent and so only update those attributes if they are ``None``.
|
|
||||||
"""
|
|
||||||
if self.check_plugins is None:
|
|
||||||
self.check_plugins = plugin_manager.Checkers()
|
|
||||||
|
|
||||||
if self.listening_plugins is None:
|
|
||||||
self.listening_plugins = plugin_manager.Listeners()
|
|
||||||
|
|
||||||
if self.formatting_plugins is None:
|
|
||||||
self.formatting_plugins = plugin_manager.ReportFormatters()
|
|
||||||
|
|
||||||
def register_plugin_options(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Register options provided by plugins to our option manager."""
|
|
||||||
self.check_plugins.register_options(self.option_manager)
|
|
||||||
self.check_plugins.register_plugin_versions(self.option_manager)
|
|
||||||
self.listening_plugins.register_options(self.option_manager)
|
|
||||||
self.formatting_plugins.register_options(self.option_manager)
|
|
||||||
|
|
||||||
def parse_configuration_and_cli(self, argv=None):
|
|
||||||
# type: (Union[NoneType, List[str]]) -> NoneType
|
|
||||||
"""Parse configuration files and the CLI options.
|
|
||||||
|
|
||||||
:param list argv:
|
|
||||||
Command-line arguments passed in directly.
|
|
||||||
"""
|
|
||||||
if self.options is None and self.args is None:
|
|
||||||
self.options, self.args = aggregator.aggregate_options(
|
|
||||||
self.option_manager, argv
|
|
||||||
)
|
|
||||||
|
|
||||||
self.running_against_diff = self.options.diff
|
|
||||||
if self.running_against_diff:
|
|
||||||
self.parsed_diff = utils.parse_unified_diff()
|
|
||||||
|
|
||||||
self.check_plugins.provide_options(self.option_manager, self.options,
|
|
||||||
self.args)
|
|
||||||
self.listening_plugins.provide_options(self.option_manager,
|
|
||||||
self.options,
|
|
||||||
self.args)
|
|
||||||
self.formatting_plugins.provide_options(self.option_manager,
|
|
||||||
self.options,
|
|
||||||
self.args)
|
|
||||||
|
|
||||||
def make_formatter(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Initialize a formatter based on the parsed options."""
|
|
||||||
if self.formatter is None:
|
|
||||||
self.formatter = self.formatting_plugins.get(
|
|
||||||
self.options.format, self.formatting_plugins['default']
|
|
||||||
).execute(self.options)
|
|
||||||
|
|
||||||
def make_notifier(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Initialize our listener Notifier."""
|
|
||||||
if self.listener_trie is None:
|
|
||||||
self.listener_trie = self.listening_plugins.build_notifier()
|
|
||||||
|
|
||||||
def make_guide(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Initialize our StyleGuide."""
|
|
||||||
if self.guide is None:
|
|
||||||
self.guide = style_guide.StyleGuide(
|
|
||||||
self.options, self.listener_trie, self.formatter
|
|
||||||
)
|
|
||||||
|
|
||||||
if self.running_against_diff:
|
|
||||||
self.guide.add_diff_ranges(self.parsed_diff)
|
|
||||||
|
|
||||||
def make_file_checker_manager(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Initialize our FileChecker Manager."""
|
|
||||||
if self.file_checker_manager is None:
|
|
||||||
self.file_checker_manager = checker.Manager(
|
|
||||||
style_guide=self.guide,
|
|
||||||
arguments=self.args,
|
|
||||||
checker_plugins=self.check_plugins,
|
|
||||||
)
|
|
||||||
|
|
||||||
def run_checks(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Run the actual checks with the FileChecker Manager.
|
|
||||||
|
|
||||||
This method encapsulates the logic to make a
|
|
||||||
:class:`~flake8.checker.Manger` instance run the checks it is
|
|
||||||
managing.
|
|
||||||
"""
|
|
||||||
files = None
|
|
||||||
if self.running_against_diff:
|
|
||||||
files = list(sorted(self.parsed_diff.keys()))
|
|
||||||
self.file_checker_manager.start(files)
|
|
||||||
self.file_checker_manager.run()
|
|
||||||
LOG.info('Finished running')
|
|
||||||
self.file_checker_manager.stop()
|
|
||||||
|
|
||||||
def report_errors(self):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Report all the errors found by flake8 3.0.
|
|
||||||
|
|
||||||
This also updates the :attr:`result_count` attribute with the total
|
|
||||||
number of errors, warnings, and other messages found.
|
|
||||||
"""
|
|
||||||
LOG.info('Reporting errors')
|
|
||||||
results = self.file_checker_manager.report()
|
|
||||||
self.total_result_count, self.result_count = results
|
|
||||||
LOG.info('Found a total of %d results and reported %d',
|
|
||||||
self.total_result_count, self.result_count)
|
|
||||||
|
|
||||||
def initialize(self, argv):
|
|
||||||
# type: () -> NoneType
|
|
||||||
"""Initialize the application to be run.
|
|
||||||
|
|
||||||
This finds the plugins, registers their options, and parses the
|
|
||||||
command-line arguments.
|
|
||||||
"""
|
|
||||||
self.option_manager = manager.OptionManager(
|
|
||||||
prog='flake8', version=flake8.__version__
|
|
||||||
)
|
|
||||||
self.find_plugins()
|
|
||||||
register_default_options(self.option_manager,
|
|
||||||
self.formatting_plugins.names)
|
|
||||||
self.register_plugin_options()
|
|
||||||
self.parse_configuration_and_cli(argv)
|
|
||||||
self.make_formatter()
|
|
||||||
self.make_notifier()
|
|
||||||
self.make_guide()
|
|
||||||
self.make_file_checker_manager()
|
|
||||||
|
|
||||||
def _run(self, argv):
|
|
||||||
# type: (Union[NoneType, List[str]]) -> NoneType
|
|
||||||
self.initialize(argv)
|
|
||||||
self.run_checks()
|
|
||||||
self.report_errors()
|
|
||||||
|
|
||||||
def run(self, argv=None):
|
|
||||||
# type: (Union[NoneType, List[str]]) -> NoneType
|
|
||||||
"""Run our application.
|
|
||||||
|
|
||||||
This method will also handle KeyboardInterrupt exceptions for the
|
|
||||||
entirety of the flake8 application. If it sees a KeyboardInterrupt it
|
|
||||||
will forcibly clean up the :class:`~flake8.checker.Manager`.
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
self._run(argv)
|
|
||||||
except KeyboardInterrupt as exc:
|
|
||||||
LOG.critical('Caught keyboard interrupt from user')
|
|
||||||
LOG.exception(exc)
|
|
||||||
self.file_checker_manager._force_cleanup()
|
|
||||||
|
|
||||||
|
|
||||||
def main(argv=None):
|
def main(argv=None):
|
||||||
|
|
@ -472,6 +12,6 @@ def main(argv=None):
|
||||||
:param list argv:
|
:param list argv:
|
||||||
The arguments to be passed to the application for parsing.
|
The arguments to be passed to the application for parsing.
|
||||||
"""
|
"""
|
||||||
app = Application()
|
app = application.Application()
|
||||||
app.run(argv)
|
app.run(argv)
|
||||||
app.exit()
|
app.exit()
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,6 @@ import tempfile
|
||||||
|
|
||||||
from flake8 import defaults
|
from flake8 import defaults
|
||||||
from flake8 import exceptions
|
from flake8 import exceptions
|
||||||
from flake8.main import cli
|
|
||||||
|
|
||||||
__all__ = ('hook', 'install')
|
__all__ = ('hook', 'install')
|
||||||
|
|
||||||
|
|
@ -36,7 +35,9 @@ def hook(lazy=False, strict=False):
|
||||||
:rtype:
|
:rtype:
|
||||||
int
|
int
|
||||||
"""
|
"""
|
||||||
app = cli.Application()
|
# NOTE(sigmavirus24): Delay import of application until we need it.
|
||||||
|
from flake8.main import application
|
||||||
|
app = application.Application()
|
||||||
with make_temporary_directory() as tempdir:
|
with make_temporary_directory() as tempdir:
|
||||||
filepaths = list(copy_indexed_files_to(tempdir, lazy))
|
filepaths = list(copy_indexed_files_to(tempdir, lazy))
|
||||||
app.initialize(filepaths)
|
app.initialize(filepaths)
|
||||||
|
|
|
||||||
190
flake8/main/options.py
Normal file
190
flake8/main/options.py
Normal file
|
|
@ -0,0 +1,190 @@
|
||||||
|
from flake8 import defaults
|
||||||
|
from flake8.main import vcs
|
||||||
|
|
||||||
|
|
||||||
|
def register_default_options(option_manager, formatters=None):
|
||||||
|
"""Register the default options on our OptionManager.
|
||||||
|
|
||||||
|
The default options include:
|
||||||
|
|
||||||
|
- ``-v``/``--verbose``
|
||||||
|
- ``-q``/``--quiet``
|
||||||
|
- ``--count``
|
||||||
|
- ``--diff``
|
||||||
|
- ``--exclude``
|
||||||
|
- ``--filename``
|
||||||
|
- ``--format``
|
||||||
|
- ``--hang-closing``
|
||||||
|
- ``--ignore``
|
||||||
|
- ``--max-line-length``
|
||||||
|
- ``--select``
|
||||||
|
- ``--disable-noqa``
|
||||||
|
- ``--show-source``
|
||||||
|
- ``--statistics``
|
||||||
|
- ``--enable-extensions``
|
||||||
|
- ``--exit-zero``
|
||||||
|
- ``-j``/``--jobs``
|
||||||
|
- ``--output-file``
|
||||||
|
- ``--append-config``
|
||||||
|
- ``--config``
|
||||||
|
- ``--isolated``
|
||||||
|
"""
|
||||||
|
add_option = option_manager.add_option
|
||||||
|
|
||||||
|
# pep8 options
|
||||||
|
add_option(
|
||||||
|
'-v', '--verbose', default=0, action='count',
|
||||||
|
parse_from_config=True,
|
||||||
|
help='Print more information about what is happening in flake8.'
|
||||||
|
' This option is repeatable and will increase verbosity each '
|
||||||
|
'time it is repeated.',
|
||||||
|
)
|
||||||
|
add_option(
|
||||||
|
'-q', '--quiet', default=0, action='count',
|
||||||
|
parse_from_config=True,
|
||||||
|
help='Report only file names, or nothing. This option is repeatable.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--count', action='store_true', parse_from_config=True,
|
||||||
|
help='Print total number of errors and warnings to standard error and'
|
||||||
|
' set the exit code to 1 if total is not empty.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--diff', action='store_true',
|
||||||
|
help='Report changes only within line number ranges in the unified '
|
||||||
|
'diff provided on standard in by the user.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--exclude', metavar='patterns', default=defaults.EXCLUDE,
|
||||||
|
comma_separated_list=True, parse_from_config=True,
|
||||||
|
normalize_paths=True,
|
||||||
|
help='Comma-separated list of files or directories to exclude.'
|
||||||
|
' (Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--filename', metavar='patterns', default='*.py',
|
||||||
|
parse_from_config=True, comma_separated_list=True,
|
||||||
|
help='Only check for filenames matching the patterns in this comma-'
|
||||||
|
'separated list. (Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--stdin-display-name', default='stdin',
|
||||||
|
help='The name used when reporting errors from code passed via stdin.'
|
||||||
|
' This is useful for editors piping the file contents to flake8.'
|
||||||
|
' (Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
# TODO(sigmavirus24): Figure out --first/--repeat
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--format', metavar='format', default='default',
|
||||||
|
parse_from_config=True, choices=(formatters or ['default']),
|
||||||
|
help='Format errors according to the chosen formatter.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--hang-closing', action='store_true', parse_from_config=True,
|
||||||
|
help='Hang closing bracket instead of matching indentation of opening'
|
||||||
|
" bracket's line.",
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--ignore', metavar='errors', default=defaults.IGNORE,
|
||||||
|
parse_from_config=True, comma_separated_list=True,
|
||||||
|
help='Comma-separated list of errors and warnings to ignore (or skip).'
|
||||||
|
' For example, ``--ignore=E4,E51,W234``. (Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--max-line-length', type='int', metavar='n',
|
||||||
|
default=defaults.MAX_LINE_LENGTH, parse_from_config=True,
|
||||||
|
help='Maximum allowed line length for the entirety of this run. '
|
||||||
|
'(Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--select', metavar='errors', default='',
|
||||||
|
parse_from_config=True, comma_separated_list=True,
|
||||||
|
help='Comma-separated list of errors and warnings to enable.'
|
||||||
|
' For example, ``--select=E4,E51,W234``. (Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--disable-noqa', default=False, parse_from_config=True,
|
||||||
|
action='store_true',
|
||||||
|
help='Disable the effect of "# noqa". This will report errors on '
|
||||||
|
'lines with "# noqa" at the end.'
|
||||||
|
)
|
||||||
|
|
||||||
|
# TODO(sigmavirus24): Decide what to do about --show-pep8
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--show-source', action='store_true', parse_from_config=True,
|
||||||
|
help='Show the source generate each error or warning.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--statistics', action='store_true', parse_from_config=True,
|
||||||
|
help='Count errors and warnings.',
|
||||||
|
)
|
||||||
|
|
||||||
|
# Flake8 options
|
||||||
|
add_option(
|
||||||
|
'--enable-extensions', default='', parse_from_config=True,
|
||||||
|
comma_separated_list=True, type='string',
|
||||||
|
help='Enable plugins and extensions that are otherwise disabled '
|
||||||
|
'by default',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--exit-zero', action='store_true',
|
||||||
|
help='Exit with status code "0" even if there are errors.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--install-hook', action='callback', type='choice',
|
||||||
|
choices=vcs.choices(), callback=vcs.install,
|
||||||
|
help='Install a hook that is run prior to a commit for the supported '
|
||||||
|
'version control systema.'
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'-j', '--jobs', type='string', default='auto', parse_from_config=True,
|
||||||
|
help='Number of subprocesses to use to run checks in parallel. '
|
||||||
|
'This is ignored on Windows. The default, "auto", will '
|
||||||
|
'auto-detect the number of processors available to use.'
|
||||||
|
' (Default: %default)',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--output-file', default=None, type='string', parse_from_config=True,
|
||||||
|
# callback=callbacks.redirect_stdout,
|
||||||
|
help='Redirect report to a file.',
|
||||||
|
)
|
||||||
|
|
||||||
|
# Config file options
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--append-config', action='append',
|
||||||
|
help='Provide extra config files to parse in addition to the files '
|
||||||
|
'found by Flake8 by default. These files are the last ones read '
|
||||||
|
'and so they take the highest precedence when multiple files '
|
||||||
|
'provide the same option.',
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--config', default=None,
|
||||||
|
help='Path to the config file that will be the authoritative config '
|
||||||
|
'source. This will cause Flake8 to ignore all other '
|
||||||
|
'configuration files.'
|
||||||
|
)
|
||||||
|
|
||||||
|
add_option(
|
||||||
|
'--isolated', default=False, action='store_true',
|
||||||
|
help='Ignore all found configuration files.',
|
||||||
|
)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue