FLAKE8(1)

💅 FLAKE8(1) — the general commands manual, but make it fashion

okay bestie, sit down, hydrate, because we're about to talk about flake8 — the command in section 1 of the general commands manual — and she is that girl. ✨

🌸 NAME 🌸

flake8 — a code checker that runs on pycodestyle and pyflakes, and she will absolutely tell you about your line that's 80 characters long. no cap.

🎀 SYNOPSIS 🎀

flake8 [options] input ...

like. that's it. that's the whole summoning ritual. 💫

🦋 DESCRIPTION 🦋

so flake8 is a command-line utility for enforcing style consistency across Python projects, and honestly? she's the friend who tells you your outfit is cute but also that your tag is sticking out. 💖

by default she includes:

• lint checks from the PyFlakes project 🔍
• PEP-0008-inspired style checks from the PyCodeStyle project 🎀
• McCabe complexity checking from the McCabe project 🧠

and if third-party extensions are found and installed, she'll run those too. she's inclusive like that. periodt. 👑

✨ OPTIONS ✨

so many options. it's giving menu at a boba shop. let's go one by one, we're not skipping a single one because we don't do that here. 🧋

• --version — shows the program's version number and then dips. exit stage left. 💨
• -h, --help — shows this help message and exits. the "what do i do" button. iconic. 🫶
• -v, --verbose — prints more information about what's happening inside flake8. and bestie, this one is repeatable — every time you repeat it, the verbosity goes up another notch. stack 'em like bracelets. 📿
• -q, --quiet — reports only file names, or nothing at all. also repeatable. the "i don't want the details, just tell me if it's bad" energy. 🤫
• --count — prints the total number of errors and warnings to standard error, and sets the exit code to 1 if that total isn't empty. receipts. 🧾
• --diff — reports changes only within line number ranges in the unified diff that the user provides on standard in. so you pipe her a diff and she only yells about the lines in it. 💅
• --exclude=patterns — a comma-separated list of files or directories to exclude. (Default: .svn,CVS,.bzr,.hg,.git,__pycache__,.tox,.eggs,*.egg) — yes she's excluding all the version control noise, she said not today. 🙈
• --filename=patterns — only checks filenames that match the patterns in this comma-separated list. (Default: *.py) 🐍
• --stdin-display-name=STDIN_DISPLAY_NAME — the name used when reporting errors from code passed via stdin. super useful for editors that pipe file contents into flake8. (Default: stdin) 🎬
• --format=format — formats errors according to the chosen formatter. glow-up for your error messages. ✨
• --hang-closing — hangs the closing bracket instead of matching the indentation of the opening bracket's line. let her dangle. 🎐
• --ignore=errors — a comma-separated list of errors and warnings to ignore (or skip). for example, --ignore=E4,E51,W234. (Default: E121,E123,E126,E226,E24,E704,W503,W504) — the block list. 🚫
• --max-line-length=n — the maximum allowed line length for the entirety of this run. (Default: 79) — yes, 79. the classic. 📏
• --select=errors — a comma-separated list of errors and warnings to enable. for example, --select=E4,E51,W234. (Default: E,F,W,C90) — the allow list. the VIP section. 🎟️
• --disable-noqa — disables the effect of "# noqa". this means errors will be reported on lines that have "# noqa" at the end. no hiding. she sees you. 👀
• --show-source — shows the source that generated each error or warning. context, bestie. we love context. 📖
• --statistics — counts errors and warnings. numbers go brrr. 📊
• --enable-extensions=ENABLE_EXTENSIONS — enables plugins and extensions that are otherwise disabled by default. waking the sleepers. 🌙
• --exit-zero — exits with status code "0" even if there are errors. she's being nice about it. 😌
• --install-hook=INSTALL_HOOK — installs a hook that runs prior to a commit, for the supported version control system. pre-commit gatekeeping, but make it helpful. 🪝
• -j JOBS, --jobs=JOBS — the number of subprocesses to use to run checks in parallel. this is ignored on Windows. the default, "auto", auto-detects the number of processors available to use. (Default: auto) — parallel girlies rise. ⚡
• --output-file=OUTPUT_FILE — redirects the report to a file. 🗂️
• --tee — writes to stdout and output-file. both. why not both. 🍵
• --append-config=APPEND_CONFIG — provides extra config files to parse in addition to the files Flake8 finds by default. these files are the last ones read, so they take the highest precedence when multiple files provide the same option. last word wins, periodt. 🏆
• --config=CONFIG — the path to the config file that will be the authoritative config source. this will cause Flake8 to ignore all other configuration files. one true config. 👑
• --isolated — ignores all found configuration files. no influence. clean slate. 🧼
• --benchmark — prints benchmark information about this run of Flake8. how fast was she? very. ⏱️
• --max-complexity=MAX_COMPLEXITY — the McCabe complexity threshold. 🧠
• --bug-report — prints the information necessary when preparing a bug report. for when you gotta snitch on her (lovingly). 🐛
• --builtins=BUILTINS — defines more built-ins, comma separated. 🔧
• --doctests — checks the syntax of the doctests. 📝
• --include-in-doctest=INCLUDE_IN_DOCTEST — runs doctests only on these files. 🎯
• --exclude-from-doctest=EXCLUDE_FROM_DOCTEST — skips these files when running doctests. 🚪

🧚 CONFIGURATION 🧚

okay so the project options get read from the [flake8] section of the tox.ini file, or the setup.cfg file, located in any parent folder of the path(s) being processed. she's checking upstairs, she's checking the whole building. 🏢

the allowed options are:

• exclude
• filename
• select
• ignore
• max-line-length
• hang-closing
• count
• format
• quiet
• showpep8
• show-source
• statistics
• verbose
• max-complexity
• builtins

💀 lowkey reminder: options are options, they're not suggestions you can vibe your way out of. if you --disable-noqa, she's reporting everything and you asked for it. 🙈

and that's the whole page, bestie. this one's from November 2016, and it lives under the FLAKE8(1) name in the general commands manual. slay, stay linted, and may your lines always be ≤ 79. 💖✨🎀🦋🌸💅🫶👑🌈⭐🍓🧚💜