Pythonでコマンドラインツールを作る方法（基本のprint & input）

1. 実行コマンド・引数・入力ファイルを決める

1. 実行コマンド・引数・入力ファイルを決める

コマンドラインツールを作る方法は、ただライブラリ名を覚えるだけでは実務で使いにくいテーマです。まずは 手作業をコマンドで自動化するCLIツール という具体例に置き換えて、入力、処理、出力、エラー時の動きを確認します。

import sys
from pathlib import Path

if len(sys.argv) < 2:
    print("usage: python tool.py input.txt")
    raise SystemExit(1)

path = Path(sys.argv[1])
print(path.read_text(encoding="utf-8")[:100])

2. argparseでコマンドライン引数を受け取る

2. argparseでコマンドライン引数を受け取る

argparseを使う前に、インストール方法、実行環境、扱うデータの範囲を整理しておきます。特にネットワーク、メール、IoT、セキュリティ系は、自分が管理する環境で試すことが大切です。

import logging

logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
logger = logging.getLogger(__name__)

logger.info("処理を開始しました")

3. ファイルパス・オプション・環境変数を検証する

3. ファイルパス・オプション・環境変数を検証する

Pythonコードでは、正常に動くケースだけでなく、タイムアウト、ファイルなし、認証失敗、入力ミスなども想定します。例外処理を入れておくと、学習用コードでも原因を追いやすくなります。

from pathlib import Path

output = Path("result.txt")
output.write_text("処理結果を保存しました\n", encoding="utf-8")

print(output.read_text(encoding="utf-8"))

4. 標準出力とloggingを使い分ける

4. 標準出力とloggingを使い分ける

処理結果は、画面に表示するだけでなく、ログやファイルに残すと確認しやすくなります。あとから失敗原因を追えるように、日時、対象、結果を記録する習慣をつけましょう。

def validate_required(value: str, label: str) -> list[str]:
    errors = []
    if not value.strip():
        errors.append(f"{label}は必須です")
    return errors

print(validate_required("Python", "キーワード"))

5. 終了コードで成功と失敗をシェルへ伝える

5. 終了コードで成功と失敗をシェルへ伝える

同じ処理を何度も書く場合は、関数や小さなクラスへ分けます。関数名に目的を入れると、あとで見返したときに「何をするコードか」がすぐ分かります。

try:
    result = 10 / 2
except ZeroDivisionError as exc:
    logging.exception("計算に失敗しました")
else:
    print(result)

6. WindowsとLinuxで動かすときの注意点

6. WindowsとLinuxで動かすときの注意点

最後に、手作業をコマンドで自動化するCLIツール として動く形へまとめます。コードを写すだけでなく、対象データや引数を変えて試すと、検索されるだけでなく読者の学習にも役立つ記事になります。

from dataclasses import dataclass

@dataclass
class Result:
    success: bool
    message: str

print(Result(True, "完了しました"))

7. CLIツールとして使える完成コード

7. CLIツールとして使える完成コード

手作業をコマンドで自動化するCLIツールとして使うなら、サンプルコードを1回動かして終わりにせず、対象データ、ファイル名、URL、認証情報、実行環境を変えて確認しましょう。argparseの役割が見えると、応用もしやすくなります。

実務では、正常系よりも失敗時の扱いで差が出ます。ログ、例外、タイムアウト、入力チェックを入れておくことで、読者がそのまま練習しやすいコードになります。

8. 定期実行やCIへつなげる改善ポイント

8. 定期実行やCIへつなげる改善ポイント

コマンドラインツールを作る方法を身につけるには、まず小さなコードで動きを確認し、次にログ出力、設定ファイル、テスト、自動実行へ広げるのがおすすめです。記事を読んだ人が自分の環境で試せるように、値を変えやすい形で残しておきましょう。

次の練習では、この記事のコードに設定ファイル読み込み、CSV保存、pytestでの確認、GitHub Actionsでの自動実行のどれか1つを追加してみてください。