blob: cbb1fefd3129dca7fd3fe29904b5d1cdf2235596 (
plain)
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
|
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 accommodate logging and verbosity options
passed by the user as early as possible.
This is 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
|
