概要
以前のブログポストではPythonの静的コード解析であるflake8を使ってコードのスタイルを統一して、潜在的なバグも減らす方法について調べてみました。
今回のブログポストではpre-commitを使ってソースコードをGitにコミットする時、設定したflake8を自動で実行する方法について調べてみます。
- pre-commit: https://pre-commit.com/
pre-commitのインストール
pre-commitを使ってflake8を自動で実行するためには、pre-commitをインストールする必要があります。次のコマンドを使ってpre-commitをインストールします。
pip install pre-commit
インストールを完了したら、忘れないようにrequirements.txtにも保存しておきます。
pip freeze > requirements.txt
これでpre-commitをインストールする方法についてみて見ました。
pre-commitの設定
pre-commitを使ってflake8を自動で実行するためには、pre-commitの設定ファイルを作成する必要があります。次のコマンドを使ってpre-commitの設定ファイルを生成します。
pre-commit sample-config > .pre-commit-config.yaml
生成された.pre-commit-config.yamlファイルを開いてみると次のようです。
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
pre-commitが提供するサンプル内容を確認することができます。
flake8の設定
次はpre-commitの設定ファイルにflake8を設定する方法について見てみます。pre-commitの設定ファイルである.pre-commit-config.yamlは基本的下記のような構造を持ってます。
repos:
- repo: repo-url
rev: version
hooks:
- id: hook-id
- repo: pre-commitが提供する昨日のRepository URL
- rev: 使う機能のバージョン
- id: pre-commitが提供する機能
pre-commitは基本的提供する機能があります。次のリンクをみてどの機能が提供されてるか確認できます。
私たちはこの中でflake8を使う予定です。.pre-commit-config.yamlファイルを開いて次のように修正します。
repos:
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.4
hooks:
- id: flake8
pre-commitが提供するrepoのURLとバージョン、flake8のhookを設定しました。この部分はflake8の公式ドキュメントでも確認できます。
- flake8 hooks: https://flake8.pycqa.org/en/latest/user/using-hooks.html
このように設定したファイルを実際GitのCommit hookに登録するため、次のコマンドを実行します。
pre-commit install
これでpre-commitを使ってflake8を使う準備ができました。
pre-commitの実行
そしたら私たちが設定したpre-commitがうまく動作するか確認しましょう。次のコマンドを実行して私たちが設定した.pre-commit-config.yamlファイルを基準でpre-commitを実行します。
pre-commit run --all-files
コマンドを実行すると次のような結果を確認することができます。
flake8...................................................................Passed
これで私たちが設定したpre-commitがうまく動作することが確認できます。ここだで私たちが設定した内容をGitにコミットします。
git add .
git commit -m 'Add pre-commit for flake8'
git push origin main
完了
これでpre-commitを使ってGitにコミットする時、flake8を実行する方法について調べてみました。注意する店は、新しくRepositoryをCloneした場合、忘れなくpre-commit installを実行してpre-commitの設定内容をGit hooksに登録する必要があります。
git clone repository_url
# virtualenv venv
# source venv/bin/activate
pip install -r requirement.txt
pre-commit install
今から自動化されたflake8でもっと生産性を高くして開発をしてみて下さい。
私のブログが役に立ちましたか？下にコメントを残してください。それは私にとって大きな大きな力になります！
アプリ広報
Dekuが開発したアプリを使ってみてください。Dekuが開発したアプリはFlutterで開発されています。興味がある方はアプリをダウンロードしてアプリを使ってくれると本当に助かります。
