Pythonの静的解析ツールFalke8を使ってみよう

Flake8について

pycodestyle について

pycodestyle は flake8 をはじめ、様々な静的解析ツールでも利用されているため、単独でインストールして使用することは少ないはずです。

pyflakesについて

code: bash

$ pip install pyflakes

Pyflakes が Pylintよりも高速な理由は、Pyflakesが各ファイルのシンタックスツリーを個別に調べているだけだからです。結果として、Pyflakesはチェックできる項目がより限定されています。

code: bash

$ pyflakes mandelbrot.py

$

これだけでは、使い勝手がよくないように思われるかもしれませんが、このツールが開発された背景を考えれば納得がいきます。開発当初、pyflakes の開発者は「インターンが一人もいない、長年の経験を積んだ開発者ばかり」という環境で仕事をしていました。同僚達のードの品質は「非常に高い」ため、彼のツールは小さな問題をキャッチするだけでよかったわけです。

Pyflakesはスタイルチェックを行いませんが、PEP8に対するスタイルチェックとPyflakesを組み合わせたFlake8というツールもあります。Flake8 はスタイルチェックに加えて、プロジェクトごとの強力な設定機能も追加されています。

設計思想のひとつに「偽陽性を出さない」があり、そのための並々ならぬ努力をしているため、「エラーのないコード」を作成するための、必携ツールとなります。

pyflakees は flake8 をはじめ、様々な静的解析ツールでも利用されているため、単独でインストールして使用することは少ないはずです。

Flake8のプラグイン

Flake8が素晴らしいのは、非常に多くのプラグインが存在するからです。例えば名前に "flake8 "という文字列が含まれるパッケージが223は存在しています。（この資料作成時）

ほんとうに多数あるなかから、次のプラグインを紹介します。といっても、たくあんありすぎるためその存在だけになります。

flake8 を使ってみる

インストールは pip コマンドで行います。必要に応じて　 pyflake8 と pycodestyle および mccabe も合わせてインストールされます。

code: bash

$ pip install flake8

簡単な使用方法は、　flake8 につづけて ファイルパスかディレクトリパスを与えるだけです。引数を省略するとカレントディレクトリのすべてのファイルがチェックされます。

code: bash

$ flake8 mandelbrot.py

mandelbrot.py:3:1: E302 expected 2 blank lines, found 1

mandelbrot.py:11:1: E302 expected 2 blank lines, found 1

mandelbrot.py:19:52: E202 whitespace before ')'

code: bash

% flake8 --help

positional arguments:

filename

optional arguments:

-h, --help show this help message and exit

-v, --verbose Print more information about what is happening in

flake8. This option is repeatable and will increase

verbosity each time it is repeated.

--output-file OUTPUT_FILE

Redirect report to a file.

--append-config APPEND_CONFIG

Provide extra config files to parse in addition to the

files found by Flake8 by default. These files are the

last ones read and so they take the highest precedence

when multiple files provide the same option.

--config CONFIG Path to the config file that will be the authoritative

config source. This will cause Flake8 to ignore all

other configuration files.

--isolated Ignore all configuration files.

--version show program's version number and exit

-q, --quiet Report only file names, or nothing. This option is

repeatable.

--count Print total number of errors and warnings to standard

error and set the exit code to 1 if total is not

empty.

--diff Report changes only within line number ranges in the

unified diff provided on standard in by the user.

--exclude patterns Comma-separated list of files or directories to

exclude. (Default: ['.svn', 'CVS', '.bzr', '.hg',

'.git', '__pycache__', '.tox', '.eggs', '*.egg'])

--extend-exclude patterns

Comma-separated list of files or directories to add to

the list of excluded ones.

--filename patterns Only check for filenames matching the patterns in this

--stdin-display-name STDIN_DISPLAY_NAME

The name used when reporting errors from code passed

via stdin. This is useful for editors piping the file

contents to flake8. (Default: stdin)

--format format Format errors according to the chosen formatter.

--hang-closing Hang closing bracket instead of matching indentation

of opening bracket's line.

--ignore errors Comma-separated list of errors and warnings to ignore

(Default: ['E123', 'E24', 'W503', 'E226', 'E121',

'E126', 'E704', 'W504'])

--extend-ignore errors

Comma-separated list of errors and warnings to add to

--per-file-ignores PER_FILE_IGNORES

A pairing of filenames and violation codes that

defines which violations to ignore in a particular

file. The filenames can be specified in a manner

options.

--max-line-length n Maximum allowed line length for the entirety of this

run. (Default: 79)

--max-doc-length n Maximum allowed doc line length for the entirety of

this run. (Default: None)

--indent-size n Number of spaces used for indentation (Default: 4)

--select errors Comma-separated list of errors and warnings to enable.

'F', 'W', 'C90'])

--extend-select errors

Comma-separated list of errors and warnings to add to

--disable-noqa Disable the effect of "# noqa". This will report

errors on lines with "# noqa" at the end.

--show-source Show the source generate each error or warning.

--no-show-source Negate --show-source

--statistics Count errors and warnings.

--enable-extensions ENABLE_EXTENSIONS

Enable plugins and extensions that are otherwise

disabled by default

--exit-zero Exit with status code "0" even if there are errors.

-j JOBS, --jobs JOBS Number of subprocesses to use to run checks in

parallel. This is ignored on Windows. The default,

"auto", will auto-detect the number of processors

available to use. (Default: auto)

--tee Write to stdout and output-file.

--benchmark Print benchmark information about this run of Flake8

--bug-report Print information necessary when preparing a bug

report

mccabe:

--max-complexity MAX_COMPLEXITY

McCabe complexity threshold

pyflakes:

--builtins BUILTINS define more built-ins, comma separated

--doctests also check syntax of the doctests

--include-in-doctest INCLUDE_IN_DOCTEST

Run doctests only on these files

--exclude-from-doctest EXCLUDE_FROM_DOCTEST

Skip these files when running doctests

Installed plugins: mccabe: 0.6.1, pycodestyle:2.8.0, pyflakes: 2.4.0

デフォルトの出力フォーマットは次の通りです。

ファイル名；行数：カラム数：エラーコード：メッセージ

ほとんどのメッセージは説明不要ですが、エラーコードは次のように対応しています。

書くエラー

設定ファイル

code: setup.cfg

exclude = .git,*migrations*

max-line-length = 119

ソースコード中でエラー無視

code: mondelbrot_noqa.py

import numpy as np

def mandelbrot(z: complex, max_iter: int):

c = z

for n in range(max_iter):

if abs(z) > 2:

return n

z = z*z + c

return max_iter

def mandelbrot_set(xmin: float, xmax: float,

ymin: float, ymax: float,

width: int, height: int,

max_iter: int):

horizon = np.linspace(xmin, xmax, width)

vertical = np.linspace(ymin, ymax, height)

return (horizon, vertical,

[mandelbrot(complex(r, i), max_iter)

for r in horizon for i in vertical] ) # noqa: E202

ソースコード全体でエラー無視

flake8 のプラグイン

code: bash

$ pip install flake8-variables-names

もう一度、flake8 を実行してみると、メッセージが増えています。

code: bash

% flake8 mandelbrot.py

mandelbrot.py:3:1: E302 expected 2 blank lines, found 1

mandelbrot.py:3:16: VNE001 single letter variable names like 'z' are not allowed

mandelbrot.py:4:5: VNE001 single letter variable names like 'c' are not allowed

mandelbrot.py:5:9: VNE001 single letter variable names like 'n' are not allowed

mandelbrot.py:8:9: VNE001 single letter variable names like 'z' are not allowed

mandelbrot.py:11:1: E302 expected 2 blank lines, found 1

mandelbrot.py:19:52: E202 whitespace before ')'

wemake-python-styleguide

Flake8は柔軟で使いやすく高速にPython スクリプトをチェックしてくれます。ただ、あまりにも豊富なプラグインがあるためどれをインストールすればよいのか迷うこともあります。なにより複数のプラグインをインストールすることは面倒なことです。

そうした場合は、wemake-python-styleguide を使ってみることをおすすめします。このパッケージは実のところ、Flake8のプラグインで、複数のプラグインを依存パッケージとして一度にインストールすることができるので便利です。

次のコマンドで、flake8 を含めて必要なパッケージをインストールができます。

code: bash

$ pip install wemake-python-styleguide

code: bash

% flake8 --help | sed -ne '/^Installed plugins/,$p'

Installed plugins: flake8-bandit: 2.1.2, flake8-broken-line: 0.3.0,

flake8-bugbear: 21.9.2, flake8-comprehensions: 3.7.0, flake8-darglint: 1.8.1,

flake8-debugger: 4.0.0, flake8-docstrings: 1.6.0, pydocstyle: 6.1.1,

flake8-eradicate: 1.2.0, flake8-string-format: 0.3.0, flake8-variables-names:

0.0.4, flake8_commas: 2.1.0, flake8_isort: 4.1.1, flake8_quotes: 3.3.1,

mccabe: 0.6.1, naming: 0.11.1, pycodestyle: 2.7.0, pyflakes: 2.3.1, rst-

docstrings: 0.2.3, wemake_python_styleguide: 0.15.3

この資料作成時点では、wemake-python-styleguide のバージョンは 0.15.3 で、これをインストールすると Flake-3.9.2 がインストールされます。依存関係はコード上の問題ではないので、つぎのようにして　Flake8 を最新にすることができます。

code: bash

$ pip install -U --no-dependencies flake8

wemake-python-styleguide(以下、WPSと略します)は、flake8 のプラグインであるため、実行方法は flake8 と同じです。