GitHub Actionsでlinterとformatterが自動で実行されるようにするため、学習を兼ねて、GitHubリポジトリの環境を以下手順で改修していく。
1. パッケージ管理をPipenvからPoetryに切り替える
2. linterとformatterを導入する（この記事）
3. GitHub Actionsでlinterとformatterを実行する 前提：
・Mac OS 10.15
・Python 3.7
・対象とするリポジトリは yrarchi / household_accounts
2. linterとformatterを導入する
linterとしてFlake8、formatterとしてBlackをインストールしていく。
① Blackのインストール
Black: Installation を参照しつつ、PipenvからPoetryに切り替える でPoetryを使うように切り替えたため、Poetryでインストールする。$poetry add --dev black
Using version ^22.3.0 for black
Updating dependencies
Resolving dependencies... (14.8s)
Writing lock file
Package operations: 7 installs, 0 updates, 0 removals
• Installing click (8.1.3)
• Installing mypy-extensions (0.4.3)
• Installing pathspec (0.9.0)
• Installing platformdirs (2.5.2)
• Installing tomli (2.0.1)
• Installing typed-ast (1.5.3)
• Installing black (22.3.0)[tool.poetry.dev-dependencies] … black = "^22.3.0"
② Blackの動きを確認する
①でインストールしたので、どのように実行されるか試してみる。Black: The basics / Usage / Writeback and reporting
By default Black reformats the files given and/or found in place. Sometimes you need Black to just tell you what it would do without actually rewriting the Python files. There’s two variations to this mode that are independently enabled by their respective flags. Both variations can be enabled at once.Blackは通常フォーマットしてしまうけど、チェックのみかける方法として2つの方法が記載されていたので、これを試してみる。
・1つ目の方法： –check
Passing --check will make Black exit with:
・ code 0 if nothing would change;
・ code 1 if some files would be reformatted; or
・ code 123 if there was an internal error
実際に実行してみる。
$poetry run black household_accounts/calc.py --check
would reformat household_accounts/calc.py
Oh no! 💥 💔 💥
1 file would be reformatted.
$echo $?
1・2つ目の方法：–diff
Passing --diff will make Black print out diffs that indicate what changes Black would’ve made. They are printed to stdout so capturing them is simple.
実際に実行してみる。
$poetry run black household_accounts/calc.py --diff
--- household_accounts/calc.py 2021-05-09 08:22:51.153728 +0000
+++ household_accounts/calc.py 2022-05-04 02:00:42.554375 +0000
@@ -1,27 +1,34 @@
import re
import config
-def calc_price_tax_in(price_list, discount_list, reduced_tax_rate_flg_list, tax_excluded_flg):
+
+def calc_price_tax_in(
+ price_list, discount_list, reduced_tax_rate_flg_list, tax_excluded_flg
+):
（中略）
All done! ✨ 🍰 ✨
1 file would be reformatted.③ Flake8のインストール
Flake8: Quickstart / Installation を参照しつつ、PipenvからPoetryに切り替える でPoetryを使うように切り替えたため、Poetryでインストールする。$poetry add --dev flake8
Using version ^4.0.1 for flake8
Updating dependencies
Resolving dependencies... (0.5s)
Writing lock file
Package operations: 4 installs, 0 updates, 0 removals
• Installing mccabe (0.6.1)
• Installing pycodestyle (2.8.0)
• Installing pyflakes (2.4.0)
• Installing flake8 (4.0.1)④ Flake8の動きを確認する
実際にFlake8を動かしてみる。$poetry run flake8 household_accounts/calc.py
household_accounts/calc.py:12:80: E501 line too long (87 > 79 characters)
household_accounts/calc.py:25:80: E501 line too long (80 > 79 characters)
household_accounts/calc.py:32:80: E501 line too long (86 > 79 characters)また、[flake8]max-line-length = 88extend-ignore = E203
$poetry run flake8 . と特定のファイルでなく全体に対してFlake8を走らせたところ、時間がかかり.venvの中にも指摘が大量に出た。そのため、Flake8: Options and their Descriptions / –exclude を参照してFlake8の対象外とするファイルの設定を追加した。
以上で、Flake8とBlackが使えるようになった。次にこれらを自動で実行するようにGitHub Actionsを設定していく。→ GitHub Actionsでlinterとformatterを実行する[flake8]max-line-length = 88extend-ignore = E203exclude = .venv/# これを追加