選項及其說明的完整列表?

選項及其說明?

--version?

Go back to index

Flake8 的版本以及安裝的所有插件的版本。

命令行用法:

flake8 --version

這個 不能 在配置文件中指定。

-h, --help?

Go back to index

說明如何使用 Flake8 以及它的選擇。

命令行用法:

flake8 --help
flake8 -h

這個 不能 在配置文件中指定。

-v, --verbose?

Go back to index

增加 Flake8 的輸出。每次指定它時,它將打印越來越多的信息。

命令行示例:

flake8 -vv

這個 不能 在配置文件中指定。

-q, --quiet?

Go back to index

減少 Flake8 的輸出。每次指定它時,它將打印越來越少的信息。

命令行示例:

flake8 -q

這個 can 在配置文件中指定。

配置文件用法示例:

quiet = 1
--count?

Go back to index

打印錯誤總數。

命令行示例:

flake8 --count dir/

這個 can 在配置文件中指定。

配置文件用法示例:

count = True
--diff?

Go back to index

使用標準中提供的統一diff僅檢查修改的文件并報告diff中包含的錯誤。

命令行示例:

git diff -u | flake8 --diff

這個 不能 在配置文件中指定。

--exclude=<patterns>?

Go back to index

提供要從檢查中排除的glob模式的逗號分隔列表。

默認為: .svn,CVS,.bzr,.hg,.git,__pycache__,.tox,.eggs,*.egg

示例模式:

  • *.pyc will match any file that ends with .pyc

  • __pycache__ 將匹配任何具有 __pycache__ 在里面

  • lib/python 將看起來擴展使用 os.path.abspath() 尋找匹配的路徑

命令行示例:

flake8 --exclude=*.pyc dir/

這個 can 在配置文件中指定。

配置文件用法示例:

exclude =
    .tox,
    __pycache__
--extend-exclude=<patterns>?

Go back to index

3.8.0 新版功能.

提供一個以逗號分隔的glob模式列表,以添加到排除的模式列表中。類似于 --exclude 此處適用于該值。

不同于 --exclude 選項是,此選項可用于有選擇地添加單個模式,而無需完全覆蓋默認列表。

命令行示例:

flake8 --extend-exclude=legacy/,vendor/ dir/

這個 can 在配置文件中指定。

配置文件用法示例:

extend-exclude =
    legacy/,
    vendor/
extend-exclude = legacy/,vendor/
--filename=<patterns>?

Go back to index

提供一個逗號分隔的glob模式列表以供檢查。

默認為: *.py

示例模式:

  • *.py will match any file that ends with .py

  • __pycache__ 將匹配任何具有 __pycache__ 在里面

  • lib/python 將看起來擴展使用 os.path.abspath() 尋找匹配的路徑

命令行示例:

flake8 --filename=*.py dir/

這個 can 在配置文件中指定。

配置文件用法示例:

filename =
    example.py,
    another-example*.py
--stdin-display-name=<display_name>?

Go back to index

提供用于報告stdin上代碼的警告和錯誤的名稱。

而不是將錯誤報告為:

stdin:82:73 E501 line too long

您可以指定這個選項,讓它報告您想要的任何值,而不是stdin。

默認為: stdin

命令行示例:

cat file.py | flake8 --stdin-display-name=file.py -

這個 不能 在配置文件中指定。

--format=<format>?

Go back to index

選擇用于向用戶顯示錯誤的格式化程序。

默認為: default

默認情況下,有兩個可用的格式化程序:

  • 缺省

  • pylint

可以安裝其他格式化程序。請參閱他們的文檔以獲取用于選擇它們的名稱。此外,用戶可以指定自己的格式字符串??捎米兞堪ǎ?/p>

  • code

  • col

  • path

  • text

默認格式化程序的格式字符串為:

'%(path)s:%(row)d:%(col)d: %(code)s %(text)s'

命令行示例:

flake8 --format=pylint dir/
flake8 --format='%(path)s::%(row)d,%(col)d::%(code)s::%(text)s' dir/

這個 can 在配置文件中指定。

配置文件用法示例:

format=pylint
format=%(path)s::%(row)d,%(col)d::%(code)s::%(text)s
--hang-closing?

Go back to index

切換pycodestyle是否應強制匹配左括號行的縮進。當您指定此選項時,它會傾向于掛起右括號而不是匹配縮進。

命令行示例:

flake8 --hang-closing dir/

這個 can 在配置文件中指定。

配置文件用法示例:

hang_closing = True
hang-closing = True
--ignore=<errors>?

Go back to index

指定要忽略的代碼列表。列表應以逗號分隔,不需要精確指定錯誤代碼。因為 Flake8 3.0,這個 can 與…結合 --select . 見 --select 更多信息。

例如,如果您只想忽略 W234 ,則可以指定它。但是如果你想忽略所有以 W23 您只需指定 W23 無視他們。這也適用于 W2W (例如)。

默認為: E121,E123,E126,E226,E24,E704,W503,W504

命令行示例:

flake8 --ignore=E121,E123 dir/
flake8 --ignore=E24,E704 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

ignore =
    E121,
    E123
ignore = E121,E123
--extend-ignore=<errors>?

Go back to index

3.6.0 新版功能.

指定要添加到忽略的代碼列表中的代碼列表。類似于 --ignore 此處適用于該值。

不同于 --ignore 選項是,此選項可用于有選擇地添加單個代碼,而不完全覆蓋默認列表。

命令行示例:

flake8 --extend-ignore=E4,E51,W234 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

extend-ignore =
    E4,
    E51,
    W234
extend-ignore = E4,E51,W234
--per-file-ignores=<filename:errors>[ <filename:errors>]?

Go back to index

3.7.0 新版功能.

指定文件映射的列表以及在整個文件中應忽略的代碼。這樣,項目就可以有一個默認的沖突列表,這些沖突列表應該被忽略,并且對于那些未被設置為符合項目規則的文件,也可以有特定于文件的沖突列表。

此選項支持類似于 --exclude 這樣glob模式在這里也會起作用。

這兩者都可以結合使用 --ignore--extend-ignore 實現風格選擇的充分靈活性。

命令行用法:

flake8 --per-file-ignores='project/__init__.py:F401 setup.py:E121'
flake8 --per-file-ignores='project/*/__init__.py:F401 setup.py:E121'

這個 can 在配置文件中指定。

per-file-ignores =
    project/__init__.py:F401
    setup.py:E121
    other_project/*:W9
--max-line-length=<n>?

Go back to index

設置任何行(除某些例外)的最大長度。

例外情況包括完全是URL的字符串或注釋行。例如:

# https://some-super-long-domain-name.com/with/some/very/long/path

url = (
    'http://...'
)

默認為: 79

命令行示例:

flake8 --max-line-length 99 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

max-line-length = 79
--max-doc-length=<n>?

Go back to index

設置注釋或docstring行的最大長度。

默認情況下,文檔行長度沒有限制。

命令行示例:

flake8 --max-doc-length 99 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

max-doc-length = 79
--select=<errors>?

Go back to index

指定所需的錯誤代碼列表 Flake8 報告。類似于 --ignore . 您可以指定錯誤代碼的一部分以該字符串開頭。例如,您可以使用 E , E4 , E43E431 .

默認為: E,F,W,C90

命令行示例:

flake8 --select=E431,E5,W,F dir/
flake8 --select=E,W dir/

這也可以與 --ignore

flake8 --select=E --ignore=E432 dir/

這將報告所有以 E ,但忽略 E432 明確地。這比 Flake8 以前是2.x和1.x。

這個 can 在配置文件中指定。

配置文件用法示例:

select =
    E431,
    W,
    F
--disable-noqa?

Go back to index

報告所有錯誤,即使它與 # NOQA 評論。 # NOQA 可用于使特定行上的消息靜音。有時,用戶希望看到哪些錯誤在不編輯文件的情況下被消除。此選項允許您查看報告的所有警告、錯誤等。

命令行示例:

flake8 --disable-noqa dir/

這個 can 在配置文件中指定。

配置文件用法示例:

disable_noqa = True
disable-noqa = True
--show-source?

Go back to index

打印生成有問題的錯誤/警告的源代碼。

命令行示例:

flake8 --show-source dir/

這個 can 在配置文件中指定。

配置文件用法示例:

show_source = True
show-source = True
--statistics?

Go back to index

計算每個錯誤/警告代碼的出現次數并打印報告。

命令行示例:

flake8 --statistics

這個 can 在配置文件中指定。

配置文件用法示例:

statistics = True
--enable-extensions=<errors>?

Go back to index

默認情況下啟用關閉擴展。

插件到 Flake8 可以選擇在默認情況下將自己注冊為關閉。這些插件有效地將自己添加到默認的忽略列表中。

命令行示例:

flake8 --enable-extensions=H111 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

enable-extensions =
    H111,
    G123
enable_extensions =
    H111,
    G123
--exit-zero?

Go back to index

Flake8 即使存在錯誤,也要使用退出狀態代碼0。

默認情況下 Flake8 如果有錯誤,將以非零整數退出。

命令行示例:

flake8 --exit-zero dir/

這個 不能 在配置文件中指定。

--install-hook=VERSION_CONTROL_SYSTEM?

Go back to index

為在提交之前或期間執行的版本控制系統安裝一個鉤子。

可用選項包括:

  • git

  • mercurial

命令行用法:

flake8 --install-hook=git
flake8 --install-hook=mercurial

這個 不能 在配置文件中指定。

--jobs=<n>?

Go back to index

指定所需的子進程數 Flake8 將用于并行運行檢查。

注解

此選項在Windows上被忽略,因為 multiprocessing 不支持所有支持的Python版本的Windows。

默認為: auto

默認行為將使用計算機上CPU的數量,如 multiprocessing.cpu_count() .

命令行示例:

flake8 --jobs=8 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

jobs = 8
--output-file=<path>?

Go back to index

將所有輸出重定向到指定的文件。

命令行示例:

flake8 --output-file=output.txt dir/
flake8 -vv --output-file=output.txt dir/
--tee?

Go back to index

如果輸出文件已配置,還將輸出打印到stdout。

命令行示例:

flake8 --tee --output-file=output.txt dir/

這個 can 在配置文件中指定。

配置文件用法示例:

output-file = output.txt
tee = True
--append-config=<config>?

Go back to index

3.6.0 新版功能.

提供額外的配置文件以便在之后進行分析,并在 Flake8 它自己發現的。由于這些文件是最后讀入配置解析器的文件,因此如果它提供在另一個配置文件中指定的選項,則具有最高的優先級。

命令行示例:

flake8 --append-config=my-extra-config.ini dir/

這個 不能 在配置文件中指定。

--config=<config>?

Go back to index

提供配置文件的路徑,該文件將是唯一讀取和使用的配置文件。這將導致 Flake8 忽略所有存在的配置文件。

命令行示例:

flake8 --config=my-only-config.ini dir/

這個 不能 在配置文件中指定。

--isolated?

Go back to index

忽略任何配置文件并使用 Flake8 好像沒有找到配置文件。

命令行示例:

flake8 --isolated dir/

這個 不能 在配置文件中指定。

--builtins=<builtins>?

Go back to index

提供內置函數、對象、名稱等的自定義列表。

這允許您讓pyflakes知道它可能無法立即識別的內置項,因此它不會報告使用未定義名稱的警告。

這是由默認的PyFlakes插件注冊的。

命令行示例:

flake8 --builtins=_,_LE,_LW dir/

這個 can 在配置文件中指定。

配置文件用法示例:

builtins =
    _,
    _LE,
    _LW
--doctests?

Go back to index

對docstring中的doctest啟用PyFlakes語法檢查。

這是由默認的PyFlakes插件注冊的。

命令行示例:

flake8 --doctests dir/

這個 can 在配置文件中指定。

配置文件用法示例:

doctests = True
--include-in-doctest=<paths>?

Go back to index

指定PyFlakes檢查哪些文件的doctest語法。

這是由默認的PyFlakes插件注冊的。

命令行示例:

flake8 --include-in-doctest=dir/subdir/file.py,dir/other/file.py dir/

這個 can 在配置文件中指定。

配置文件用法示例:

include-in-doctest =
    dir/subdir/file.py,
    dir/other/file.py
include_in_doctest =
    dir/subdir/file.py,
    dir/other/file.py
--exclude-from-doctest=<paths>?

Go back to index

指定PyFlakes不檢查哪些文件的doctest語法。

這是由默認的PyFlakes插件注冊的。

命令行示例:

flake8 --exclude-from-doctest=dir/subdir/file.py,dir/other/file.py dir/

這個 can 在配置文件中指定。

配置文件用法示例:

exclude-from-doctest =
    dir/subdir/file.py,
    dir/other/file.py
exclude_from_doctest =
    dir/subdir/file.py,
    dir/other/file.py
--benchmark?

Go back to index

收集并打印此運行的基準 Flake8 . 這將合計以下總數:

  • 令牌

  • 物理線

  • 邏輯線

  • 文件夾

以及經過的秒數。

命令行用法:

flake8 --benchmark dir/

這個 不能 在配置文件中指定。

--bug-report?

Go back to index

為Flake8生成完整錯誤報告所需的信息。這將很好地打印一個JSON blob,該blob應該被復制并粘貼到Flake8的bug報告中。

命令行用法:

flake8 --bug-report

輸出應大致如下所示:

{
  "dependencies": [
    {
      "dependency": "setuptools",
      "version": "25.1.1"
    }
  ],
  "platform": {
    "python_implementation": "CPython",
    "python_version": "2.7.12",
    "system": "Darwin"
  },
  "plugins": [
    {
      "plugin": "mccabe",
      "version": "0.5.1"
    },
    {
      "plugin": "pycodestyle",
      "version": "2.0.0"
    },
    {
      "plugin": "pyflakes",
      "version": "1.2.3"
    }
  ],
  "version": "3.1.0.dev0"
}

這個 不能 在配置文件中指定。

--max-complexity=<n>?

Go back to index

為代碼塊設置允許的最大McCabe復雜度值。

此選項由 mccabe 依賴關系 Flake8 插件。

命令行用法:

flake8 --max-complexity 15 dir/

這個 can 在配置文件中指定。

配置文件用法示例:

max-complexity = 15