Posted inDevelopment

Makefileの使用ガイド：ITプロジェクトのワークフローを最適化する

Development tutorial - IT technology blog
Development tutorial - IT technology blog

問題の紹介

ソフトウェア開発をしていると、毎日同じような作業を繰り返していると感じることはありませんか？ソースコードのコンパイル、テストの実行、一時ファイルのクリーンアップ、アプリケーションのデプロイなど。新人開発者であろうとベテランであろうと、これらの作業を手動で行うのは時間がかかり、エラーを起こしやすいものです。長大なコマンドを打ち間違えたり、デプロイ時に重要なステップを忘れてしまったりした経験はきっとあるでしょう？

まさに、ここでMakefileがその価値を発揮します。これは単なるツールではありません。Makefileは、複雑なコマンドシーケンスをシンプルなキーワードだけで定義し、実行するのに役立ちます。想像してみてください。何十ものgcc、python test.py、docker buildといったコマンドを覚える代わりに、make build、make test、make deployと入力するだけで済むのです。開発者の生活ははるかに楽になるでしょう！

核心概念：Makefileとは何か、どのように機能するのか？

簡単に言えば、Makefileはmakeツールが読み込んで実行する「ルール」（rules）を含むファイルです。各ルールは主に3つの部分から構成されます。

  1. ターゲット (Target)：これは作成したいもの、または実行したいアクションです。例：all、clean、test、build。ターゲットは出力ファイルの名前、または抽象的なアクション（phony targetとも呼ばれる）である場合があります。
  2. 前提条件 (Prerequisites)：現在のターゲットが実行される前に必要とされる、または更新される必要がある他のファイルやターゲットのリストです。
  3. レシピ (Recipe)：これは、ターゲットを作成したりアクションを実行したりするためにmakeが実行するシェルコマンドです。非常に重要なことですが、レシピの各行はタブ文字で始まる必要があります。スペースではありません。これはMakefile初心者が最もよく犯す間違いです！

ルールの基本的な構造は次のようになります。

target: prerequisites
	recipe_line_1
	recipe_line_2
	...

では、非常にシンプルな例を見てみましょう。hello.cファイルがあり、それを実行可能なプログラムにコンパイルしたいとします。

// hello.c
#include <stdio.h>

int main() {
    printf("Hello, Makefile!\n"); // 「Hello, Makefile!」と出力
    return 0;
}

そして、対応するMakefileは次のとおりです。

# CプログラムをコンパイルするためのシンプルなMakefile
hello: hello.c
	gcc hello.c -o hello

clean:
	rm -f hello

コンパイルするには、同じディレクトリでターミナルを開き、次のように入力するだけです。

make hello

このとき、makeはhello.cをチェックします。もしhello.cがhelloより新しい場合（またはhelloファイルが存在しない場合）、gcc hello.c -o helloコマンドが実行されます。
コンパイルされたhelloファイルを削除したい場合は、次のように入力します。

make clean

makeはターゲットcleanを見つけて、rm -f helloコマンドを実行します。非常にシンプルですよね？

詳細な実践：Makefileでワークフローをレベルアップ

Makefileの基本的な概念は理解できましたか？それでは、特に私がよく作業するPython環境で、実際のプロジェクト管理にどのように適用できるかを掘り下げていきましょう。

1. 基本的なPythonプロジェクト向けMakefile

Pythonプロジェクトでは、アプリケーションの実行、テストの実行、ライブラリのインストール、一時ファイルのクリーンアップといったタスクがよく必要になります。あなたの小さなPythonプロジェクトのために、シンプルなMakefileを一緒に構築してみましょう。

app.pyとtest_app.pyファイルが次のようにあるとします。

# app.py
def greet(name):
    return f"Hello, {name}!" # 挨拶メッセージを返す

if __name__ == "__main__":
    print(greet("World")) # 「World」に挨拶し、結果を出力
# test_app.py
import unittest
from app import greet

class TestApp(unittest.TestCase):
    def test_greet(self):
        self.assertEqual(greet("Alice"), "Hello, Alice!") # Aliceへの挨拶をテスト
        self.assertEqual(greet("Bob"), "Hello, Bob!") # Bobへの挨拶をテスト

if __name__ == "__main__":
    unittest.main() # テストを実行

そして、使用するMakefileは次のとおりです。

# Pythonプロジェクト用Makefile
PYTHON = python3
TEST_COMMAND = $(PYTHON) -m unittest discover

.PHONY: all run test clean install help

all: run

run:
	$(PYTHON) app.py

test:
	$(TEST_COMMAND)

clean:
	find . -type f -name "*.pyc" -delete
	find . -type d -name "__pycache__" -delete
	rm -f .coverage
	rm -rf htmlcov

install:
	pip install -r requirements.txt

help: ## 利用可能なすべてのコマンドを表示
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

このMakefileについて詳しく見ていきましょう。

  • 変数 (Variables)：PYTHONをpython3として定義し、TEST_COMMANDを$(PYTHON) -m unittest discoverとしています。変数を使用すると、複数の場所を変更することなく、一箇所で値を簡単に変更できます。例えば、python3の代わりにpythonを使いたい場合、PYTHON = python3の行をPYTHON = pythonに修正するだけです。
  • .PHONY：これは非常に重要なディレクティブです。all、run、test、clean、installがファイルではなく、「擬似ターゲット」（phony targets）であることを宣言します。これにより、同じ名前のファイルがディレクトリに存在する場合でも、makeは常にそのターゲットのコマンドを実行します。また、これによりmakeの実行がより速く効率的になります。
  • all：これはデフォルトのターゲットです。引数なしでmakeとだけ入力した場合、makeは変数または.PHONYではない最初のターゲットを実行します。ここでは、allはrunに依存しているため、makeと入力するとmake runが実行されます。
  • run：app.pyファイルを実行します。
  • test：テストを実行します。unittest discoverを使用して、テストケースを自動的に検索して実行します。
  • clean：.pycファイル、__pycache__ディレクトリ、および（存在する場合）カバレッジファイルをクリーンアップします。これは、プロジェクトディレクトリを常にきれいに保つための良い習慣です。
  • install：requirements.txtからライブラリをインストールします。

使用するには、次のようにするだけです。

make install # ライブラリをインストール
make run     # アプリケーションを実行
make test    # テストを実行
make clean   # クリーンアップ

2. 実践的なヒントでプロセスを最適化する

私の個人的な経験から、Makefileを扱う上で非常に役立ついくつかの小さなヒントがあります。

  • パスとファイル名に変数を活用する：これにより、プロジェクト構造が変更されたときにMakefileの保守が容易になります。
  • 関連するタスクをまとめる：多くの小さなターゲットを作成する代わりに、関連するタスクをより大きなターゲットにまとめましょう。例えば、buildターゲットにはcompileとlintの両方を含めることができます。
  • コメントに##を追加する：Makefileは#記号によるコメントをサポートしています。make helpと入力したときに、makeがコメント付きのターゲットをリスト表示させたい場合、ターゲットの直後に##を追加できます。

このhelpターゲットをあなたのMakefileに追加し、make helpと入力してみてください。美しいコマンドリストとそれらの説明が表示されます。とても便利です！

  • オンラインツールを活用して素早くチェックする：時々、正規表現テスターツールを素早くチェックしたり、スクリプトからのJSON出力を再フォーマットしたり、YAMLとJSON間でデータを変換したりする必要があります。マシンに追加のユーティリティやライブラリをインストールする代わりに、ブラウザを開いてtoolcraft.app/ja/tools/developer/json-formatterのようなオンラインツールや正規表現テスターツールを使用することがよくあります。この方法は非常に便利で、時間を節約し、ローカル開発環境をきれいに保つのに役立ちます。

3. 高度なMakefile：依存関係と条件

Makefileは、より複雑な依存関係を条件文とともに定義することも可能にします。

例えば、installコマンドを実行する前にPython仮想環境がアクティブになっていることを確認したい場合：

VENV_DIR = .venv
PYTHON_VENV = $(VENV_DIR)/bin/python

.PHONY: install

install: $(PYTHON_VENV)
	$(PYTHON_VENV) -m pip install -r requirements.txt

$(PYTHON_VENV):
	$(PYTHON) -m venv $(VENV_DIR)
	@echo "Virtual environment created at $(VENV_DIR)" # 仮想環境が$(VENV_DIR)に作成されました

ここでは、installターゲットが$(PYTHON_VENV)に依存しています。もし.venvディレクトリが存在しない場合、makeはpip installコマンドを実行する前に仮想環境を自動的に作成します。これが、makeがタスク間の依存関係を自動的に管理する方法です。

結論：Makefile – すべてのプロジェクトの頼れる相棒

この記事を読んで、Makefileがもたらす力と便利さに気づいていただけたことを願います。シンプルなタスクの自動化から複雑なプロセスの管理まで、Makefileはどの開発者にとっても真に不可欠なツールです。

これは貴重な時間を何時間も節約するだけでなく、手動操作によるエラーを大幅に削減します。今日からあなたの次のプロジェクトにMakefileを適用し始めましょう！

最初は、特にスペースではなくタブのルールなど、構文と動作に慣れるのに時間がかかるかもしれません。しかし、一度習得すれば、退屈な反復作業を繰り返す代わりに、より大きな課題に集中するための多くの時間を手に入れることができるでしょう。ご成功をお祈りします！

Share: