Python×GitHooks: 開発効率を劇的に向上

Python開発におけるGit Hooksの活用術を解説。コード品質向上、自動テスト、コミットメッセージの標準化で、チーム開発を劇的に効率化します。

Git Hooksとは
PythonでGit Hooksを記述するメリット
Git Hooksの種類
1. クライアントサイド Hooks
2. サーバーサイド Hooks
Pythonを使ったGit Hooksの実装例
1. pre-commit Hook: コードの静的解析
2. commit-msg Hook: コミットメッセージの標準化
まとめ

Git Hooksとは

Git Hooksは、Gitのイベント（コミット、プッシュなど）が発生した際に、自動的に実行されるスクリプトです。これを利用することで、開発ワークフローを自動化し、品質を向上させることができます。

PythonでGit Hooksを記述するメリット

可読性の高さ: Pythonは読みやすい構文を持つため、スクリプトの理解やメンテナンスが容易です。
豊富なライブラリ: Pythonには、様々な処理を簡単に行える豊富なライブラリが存在します。
クロスプラットフォーム: Pythonは様々なOSで動作するため、環境に依存しないスクリプトを作成できます。

Git Hooksの種類

クライアントサイド Hooks

pre-commit: コミットメッセージを入力する前に実行されます。コードの静的解析やスタイルのチェックなどに利用します。
prepare-commit-msg: コミットメッセージエディタを起動する前に実行されます。コミットメッセージのテンプレートを生成するなどに利用します。
commit-msg: コミットメッセージが有効かどうかをチェックします。
post-commit: コミットが完了した後に実行されます。通知の送信などに利用します。
pre-rebase: rebaseを行う前に実行されます。
post-rebase: rebaseが完了した後に実行されます。
post-checkout: checkoutが完了した後に実行されます。
post-merge: mergeが完了した後に実行されます。
pre-push: pushを行う前に実行されます。

サーバーサイド Hooks

pre-receive: pushされた内容がリポジトリに書き込まれる前に実行されます。
update: pushされたブランチごとに実行されます。
post-receive: pushされた内容がリポジトリに書き込まれた後に実行されます。
post-update: post-receiveの後に実行されます。

Pythonを使ったGit Hooksの実装例

pre-commit Hook: コードの静的解析

pre-commit Hookを使って、コミット前にコードの静的解析を行う例です。ここでは、flake8を使ってコードのスタイルをチェックします。

#!/usr/bin/env python
import subprocess
import sys

def main():
    try:
        subprocess.check_call(['flake8'])
        sys.exit(0)
    except subprocess.CalledProcessError:
        sys.exit(1)

if __name__ == '__main__':
    main()

このスクリプトを.git/hooks/pre-commitに保存し、実行権限を与えます。

chmod +x .git/hooks/pre-commit

commit-msg Hook: コミットメッセージの標準化

commit-msg Hookを使って、コミットメッセージのフォーマットをチェックする例です。ここでは、コミットメッセージが指定された形式（例：feat: 新機能の実装）に従っているかを確認します。

#!/usr/bin/env python
import sys
import re

def main():
    commit_msg_file = sys.argv[1]
    with open(commit_msg_file, 'r') as f:
        commit_msg = f.read().strip()

    pattern = r'^(feat|fix|docs|style|refactor|perf|test|chore)(\([\w\-]+\))?: .+$'
    if not re.match(pattern, commit_msg):
        print("コミットメッセージのフォーマットが正しくありません。")
        sys.exit(1)
    sys.exit(0)

if __name__ == '__main__':
    main()

このスクリプトを.git/hooks/commit-msgに保存し、実行権限を与えます。