flake8
4.0.0
Frequently Asked Questions
Glossary of Terms Used in Flake8 Documentation
Using Flake8
Flake8 man page
Writing Plugins for Flake8
Exploring Flake8’s Internals
Release Notes and History
flake8
Docs
»
Index
Edit on GitHub
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
Symbols
--append-config=<config>
flake8 command line option
--benchmark
flake8 command line option
--bug-report
flake8 command line option
--builtins=<builtins>
flake8 command line option
--config=<config>
flake8 command line option
--count
flake8 command line option
--diff
flake8 command line option
--disable-noqa
flake8 command line option
--doctests
flake8 command line option
--enable-extensions=<errors>
flake8 command line option
--exclude-from-doctest=<paths>
flake8 command line option
--exclude=<patterns>
flake8 command line option
--exit-zero
flake8 command line option
--extend-exclude=<patterns>
flake8 command line option
--extend-ignore=<errors>
flake8 command line option
--extend-select=<errors>
flake8 command line option
--filename=<patterns>
flake8 command line option
--format=<format>
flake8 command line option
--hang-closing
flake8 command line option
--ignore=<errors>
flake8 command line option
--include-in-doctest=<paths>
flake8 command line option
--indent-size=<n>
flake8 command line option
--isolated
flake8 command line option
--jobs=<n>
flake8 command line option
--max-complexity=<n>
flake8 command line option
--max-doc-length=<n>
flake8 command line option
--max-line-length=<n>
flake8 command line option
--output-file=<path>
flake8 command line option
--per-file-ignores=<filename:errors>[ <filename:errors>]
flake8 command line option
--select=<errors>
flake8 command line option
--show-source
flake8 command line option
--statistics
flake8 command line option
--stdin-display-name=<display_name>
flake8 command line option
--tee
flake8 command line option
--version
flake8 command line option
-h, --help
flake8 command line option
-q, --quiet
flake8 command line option
-v, --verbose
flake8 command line option
_
__init__() (flake8.options.config.ConfigFileFinder method)
(flake8.options.config.ConfigParser method)
(flake8.options.manager.Option method)
(flake8.options.manager.OptionManager method)
(flake8.plugins.manager.Plugin method)
(flake8.plugins.manager.PluginManager method)
__weakref__ (flake8.options.config.ConfigFileFinder attribute)
(flake8.options.config.ConfigParser attribute)
(flake8.options.manager.OptionManager attribute)
A
add_option() (flake8.options.manager.OptionManager method)
after_init() (flake8.formatting.base.BaseFormatter method)
(flake8.formatting.default.Default method)
aggregate_options() (in module flake8.options.aggregator)
Application (class in flake8.main.application)
args (flake8.main.application.Application attribute)
ast_plugins (flake8.plugins.manager.Checkers attribute)
B
BaseFormatter (class in flake8.formatting.base)
beginning() (flake8.formatting.base.BaseFormatter method)
blank_before (flake8.processor.FileProcessor attribute)
blank_lines (flake8.processor.FileProcessor attribute)
build_ast() (flake8.processor.FileProcessor method)
build_logical_line() (flake8.processor.FileProcessor method)
build_logical_line_tokens() (flake8.processor.FileProcessor method)
C
catastrophic_failure (flake8.main.application.Application attribute)
check
check_files() (flake8.api.legacy.StyleGuide method)
check_physical_eol() (flake8.checker.FileChecker method)
check_plugins (flake8.main.application.Application attribute)
checker_state (flake8.processor.FileProcessor attribute)
Checkers (class in flake8.plugins.manager)
checks_expecting() (flake8.plugins.manager.Checkers method)
class
cli_config() (flake8.options.config.ConfigFileFinder method)
config_finder (flake8.options.config.ConfigParser attribute)
config_options (flake8.options.config.ConfigParser attribute)
ConfigFileFinder (class in flake8.options.config)
ConfigParser (class in flake8.options.config)
count_parentheses() (in module flake8.processor)
D
Default (class in flake8.formatting.default)
delete_first_token() (flake8.processor.FileProcessor method)
disable() (flake8.plugins.manager.Plugin method)
E
enable() (flake8.plugins.manager.Plugin method)
end_time (flake8.main.application.Application attribute)
error
error class
error code
excluded() (flake8.api.legacy.StyleGuide method)
execute() (flake8.plugins.manager.Plugin method)
exit() (flake8.main.application.Application method)
expand_indent() (in module flake8.processor)
extend_default_ignore() (flake8.options.manager.OptionManager method)
extend_default_select() (flake8.options.manager.OptionManager method)
F
file_checker_manager (flake8.main.application.Application attribute)
file_tokens (flake8.processor.FileProcessor attribute)
FileChecker (class in flake8.checker)
filename (flake8.formatting.base.BaseFormatter attribute)
filenames_from() (in module flake8.utils)
FileProcessor (class in flake8.processor)
find_plugins() (flake8.main.application.Application method)
finished() (flake8.formatting.base.BaseFormatter method)
flake8 command line option
--append-config=<config>
--benchmark
--bug-report
--builtins=<builtins>
--config=<config>
--count
--diff
--disable-noqa
--doctests
--enable-extensions=<errors>
--exclude-from-doctest=<paths>
--exclude=<patterns>
--exit-zero
--extend-exclude=<patterns>
--extend-ignore=<errors>
--extend-select=<errors>
--filename=<patterns>
--format=<format>
--hang-closing
--ignore=<errors>
--include-in-doctest=<paths>
--indent-size=<n>
--isolated
--jobs=<n>
--max-complexity=<n>
--max-doc-length=<n>
--max-line-length=<n>
--output-file=<path>
--per-file-ignores=<filename:errors>[ <filename:errors>]
--select=<errors>
--show-source
--statistics
--stdin-display-name=<display_name>
--tee
--version
-h, --help
-q, --quiet
-v, --verbose
flake8.api.legacy (module)
fnmatch() (in module flake8.utils)
format() (flake8.formatting.base.BaseFormatter method)
formatter
(flake8.main.application.Application attribute)
formatter_for() (flake8.main.application.Application method)
formatting_plugins (flake8.main.application.Application attribute)
G
generate_epilog() (flake8.options.manager.OptionManager method)
generate_possible_local_files() (flake8.options.config.ConfigFileFinder method)
generate_tokens() (flake8.processor.FileProcessor method)
generate_versions() (flake8.options.manager.OptionManager method)
get() (flake8.plugins.manager.PluginTypeManager method)
get_statistics() (flake8.api.legacy.Report method)
get_style_guide() (in module flake8.api.legacy)
GETBOOL_ACTIONS (flake8.options.config.ConfigParser attribute)
group() (flake8.options.manager.OptionManager method)
(flake8.plugins.manager.Plugin method)
guide (flake8.main.application.Application attribute)
H
handle() (flake8.formatting.base.BaseFormatter method)
handle_newline() (flake8.checker.FileChecker method)
hang_closing (flake8.processor.FileProcessor attribute)
I
indent_char (flake8.processor.FileProcessor attribute)
indent_level (flake8.processor.FileProcessor attribute)
indent_size (flake8.processor.FileProcessor attribute)
indent_size_str (flake8.processor.FileProcessor attribute)
init_report() (flake8.api.legacy.StyleGuide method)
initialize() (flake8.main.application.Application method)
input_file() (flake8.api.legacy.StyleGuide method)
inside_multiline() (flake8.processor.FileProcessor method)
is_configured_by() (flake8.options.config.ConfigParser method)
is_eol_token() (in module flake8.processor)
is_in_a_group() (flake8.plugins.manager.Plugin method)
is_multiline_string() (in module flake8.processor)
is_path_excluded() (flake8.checker.Manager method)
is_using_stdin() (in module flake8.utils)
is_windows() (in module flake8.utils)
K
keyword_arguments_for() (flake8.processor.FileProcessor method)
L
line_number (flake8.processor.FileProcessor attribute)
load_plugin() (flake8.plugins.manager.Plugin method)
load_plugins() (flake8.plugins.manager.PluginTypeManager method)
local_config_files() (flake8.options.config.ConfigFileFinder method)
local_configs() (flake8.options.config.ConfigFileFinder method)
local_configs_with_files() (flake8.options.config.ConfigFileFinder method)
log_token() (in module flake8.processor)
logical_line (flake8.processor.FileProcessor attribute)
logical_line_plugins (flake8.plugins.manager.Checkers attribute)
M
main() (in module flake8.main.cli)
make_checkers() (flake8.checker.Manager method)
make_file_checker_manager() (flake8.main.application.Application method)
make_formatter() (flake8.main.application.Application method)
make_guide() (flake8.main.application.Application method)
Manager (class in flake8.checker)
map() (flake8.plugins.manager.PluginManager method)
max_doc_length (flake8.processor.FileProcessor attribute)
max_line_length (flake8.processor.FileProcessor attribute)
mccabe
monkey_patch() (in module flake8_polyfill.stdin)
multiline (flake8.processor.FileProcessor attribute)
mutate_string() (in module flake8.processor)
N
names (flake8.plugins.manager.PluginTypeManager attribute)
newline (flake8.formatting.base.BaseFormatter attribute)
next_line() (flake8.processor.FileProcessor method)
next_logical_line() (flake8.processor.FileProcessor method)
noqa (flake8.processor.FileProcessor attribute)
noqa_line_for() (flake8.processor.FileProcessor method)
normalize() (flake8.options.manager.Option method)
normalize_path() (in module flake8.utils)
normalize_paths() (in module flake8.utils)
O
off_by_default (flake8.plugins.manager.Plugin attribute)
Option (class in flake8.options.manager)
option_manager (flake8.main.application.Application attribute)
(flake8.options.config.ConfigParser attribute)
OptionManager (class in flake8.options.manager)
options (flake8.api.legacy.StyleGuide attribute)
(flake8.formatting.base.BaseFormatter attribute)
(flake8.main.application.Application attribute)
output_fd (flake8.formatting.base.BaseFormatter attribute)
P
parameter_names (flake8.plugins.manager.Plugin attribute)
parameters (flake8.plugins.manager.Plugin attribute)
parameters_for() (in module flake8.utils)
parse() (flake8.options.config.ConfigParser method)
parse_args() (flake8.options.manager.OptionManager method)
parse_cli_config() (flake8.options.config.ConfigParser method)
parse_comma_separated_list() (in module flake8.utils)
parse_configuration_and_cli() (flake8.main.application.Application method)
parse_known_args() (flake8.options.manager.OptionManager method)
parse_local_config() (flake8.options.config.ConfigParser method)
parse_preliminary_options() (flake8.main.application.Application method)
parse_unified_diff() (in module flake8.utils)
parsed_diff (flake8.main.application.Application attribute)
paths (flake8.api.legacy.StyleGuide attribute)
physical_line_plugins (flake8.plugins.manager.Checkers attribute)
plugin
Plugin (class in flake8.plugins.manager)
plugin (flake8.plugins.manager.Plugin attribute)
plugin_name (flake8.plugins.manager.Plugin attribute)
PluginManager (class in flake8.plugins.manager)
plugins (flake8.plugins.manager.PluginTypeManager attribute)
PluginTypeManager (class in flake8.plugins.manager)
prelim_arg_parser (flake8.main.application.Application attribute)
previous_indent_level (flake8.processor.FileProcessor attribute)
previous_logical (flake8.processor.FileProcessor attribute)
previous_unindented_logical_line (flake8.processor.FileProcessor attribute)
process_tokens() (flake8.checker.FileChecker method)
program (flake8.main.application.Application attribute)
program_name (flake8.options.config.ConfigParser attribute)
provide_options() (flake8.plugins.manager.Plugin method)
(flake8.plugins.manager.PluginTypeManager method)
pycodestyle
pyflakes
Pylint (class in flake8.formatting.default)
Python Enhancement Proposals
PEP 257
PEP 8
R
read_lines() (flake8.processor.FileProcessor method)
read_lines_from_filename() (flake8.processor.FileProcessor method)
read_lines_from_stdin() (flake8.processor.FileProcessor method)
register() (in module flake8_polyfill.options)
register_default_options() (in module flake8.main.options)
register_options() (flake8.plugins.manager.Checkers method)
(flake8.plugins.manager.Plugin method)
(flake8.plugins.manager.PluginTypeManager method)
register_plugin() (flake8.options.manager.OptionManager method)
register_plugin_options() (flake8.main.application.Application method)
register_plugin_versions() (flake8.plugins.manager.PluginTypeManager method)
remove_from_default_ignore() (flake8.options.manager.OptionManager method)
Report (class in flake8.api.legacy)
report() (flake8.checker.FileChecker method)
(flake8.checker.Manager method)
(flake8.main.application.Application method)
report_benchmarks() (flake8.main.application.Application method)
report_errors() (flake8.main.application.Application method)
report_statistics() (flake8.main.application.Application method)
ReportFormatters (class in flake8.plugins.manager)
reset_blank_before() (flake8.processor.FileProcessor method)
result_count (flake8.main.application.Application attribute)
run() (flake8.checker.Manager method)
(flake8.main.application.Application method)
run_ast_checks() (flake8.checker.FileChecker method)
run_check() (flake8.checker.FileChecker method)
run_checks() (flake8.checker.FileChecker method)
(flake8.main.application.Application method)
run_logical_checks() (flake8.checker.FileChecker method)
run_parallel() (flake8.checker.Manager method)
run_physical_checks() (flake8.checker.FileChecker method)
run_serial() (flake8.checker.Manager method)
running_against_diff (flake8.main.application.Application attribute)
S
should_ignore_file() (flake8.processor.FileProcessor method)
show_benchmarks() (flake8.formatting.base.BaseFormatter method)
show_source() (flake8.formatting.base.BaseFormatter method)
show_statistics() (flake8.formatting.base.BaseFormatter method)
split_line() (flake8.processor.FileProcessor method)
start() (flake8.checker.Manager method)
(flake8.formatting.base.BaseFormatter method)
start_time (flake8.main.application.Application attribute)
statistics (flake8.processor.FileProcessor attribute)
stdin_get_value() (in module flake8.utils)
stop() (flake8.checker.Manager method)
(flake8.formatting.base.BaseFormatter method)
strip_utf_bom() (flake8.processor.FileProcessor method)
StyleGuide (class in flake8.api.legacy)
T
to_argparse() (flake8.options.manager.Option method)
to_dictionary() (flake8.plugins.manager.Checkers method)
(flake8.plugins.manager.Plugin method)
token_is_newline() (in module flake8.processor)
tokens (flake8.processor.FileProcessor attribute)
total_errors (flake8.api.legacy.Report attribute)
total_lines (flake8.processor.FileProcessor attribute)
total_result_count (flake8.main.application.Application attribute)
U
update_checker_state_for() (flake8.processor.FileProcessor method)
update_state() (flake8.processor.FileProcessor method)
update_version_string() (flake8.options.manager.OptionManager method)
V
verbose (flake8.processor.FileProcessor attribute)
version (flake8.main.application.Application attribute)
(flake8.plugins.manager.Plugin attribute)
versions() (flake8.plugins.manager.PluginManager method)
violation
visited_new_blank_line() (flake8.processor.FileProcessor method)
W
warning
write() (flake8.formatting.base.BaseFormatter method)
Read the Docs
v: 4.0.0
Versions
master
latest
stable
4.0.0
3.9.2
3.9.1
3.9.0
3.8.4
3.8.3
3.8.2
3.8.1
3.8.0
3.7.9
3.7.8
3.7.7
3.7.6
3.7.5
3.7.4
3.7.3
3.7.2
3.7.1
3.7.0
3.6.0
3.5.0
3.4.1
3.3.0
3.2.1
3.2.0
3.1.1
3.0.4
3.0.3
3.0.2
3.0.1
3.0.0
3.0.0b1
2.6.2
2.6.0
2.5.5
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.