mirror of
https://github.com/PyCQA/flake8.git
synced 2026-03-30 10:46:54 +00:00
18d6e6264c
If we restrict the user's ability to specify a format string, we break existing workflows.
26 lines
827 B
ReStructuredText
26 lines
827 B
ReStructuredText
Command Line Interface
|
|
======================
|
|
|
|
The command line interface of Flake8 is modeled as an application via
|
|
:class:`~flake8.main.cli.Application`. When a user runs ``flake8`` at their
|
|
command line, :func:`~flake8.main.cli.main` is run which handles
|
|
management of the application.
|
|
|
|
User input is parsed *twice* to accomodate logging and verbosity options
|
|
passed by the user as early as possible so as much logging can be produced as
|
|
possible.
|
|
|
|
The default flake8 options are registered by
|
|
:func:`~flake8.main.options.register_default_options`. Trying to register
|
|
these options in plugins will result in errors.
|
|
|
|
|
|
API Documentation
|
|
-----------------
|
|
|
|
.. autofunction:: flake8.main.cli.main
|
|
|
|
.. autoclass:: flake8.main.application.Application
|
|
:members:
|
|
|
|
.. autofunction:: flake8.main.options.register_default_options
|