Pythonのmain関数とコマンドライン引数の受け取り方

2025年2月12日2025年2月13日

当ページのリンクには広告が含まれています。

Pythonでプログラムを作成する際に、main関数を定義し、引数を渡す方法を理解しておくことは重要です。本記事では、Pythonのmain関数の役割や、引数の受け取り方法について詳しく解説します。

Python1年生第2版体験してわかる！会話でまなべる！プログラミングのしくみ [ 森巧尚 ]

楽天ブックス

¥2,178 （2025/02/12 10:57時点 | 楽天市場調べ）

Amazon

楽天市場

メルカリ

ポチップ

1. Pythonにおけるmain関数とは？

1.1 main関数の基本構造

PythonにはCやJavaのように厳格なmain関数はありませんが、一般的に次のような構造で記述します。

import sys

def main():
    print("Hello, Python main function!")

if __name__ == "__main__":
    main()

この構造により、スクリプトが直接実行された場合のみmain関数が実行されます。

1.2 モジュール化を考慮したmain関数

他のスクリプトからインポートされた際には実行されないため、モジュール化にも適しています。

def process():
    print("Processing data...")

def main():
    process()

if __name__ == "__main__":
    main()

こうすることで処理の流れを整理しやすくなります。

2. コマンドライン引数を取得する方法

2.1 sys.argvを使った引数の取得

Pythonではsys.argvを使ってコマンドライン引数を取得できます。

import sys

def main():
    args = sys.argv[1:]  # スクリプト名を除外して取得
    print("Received arguments:", args)

if __name__ == "__main__":
    main()

2.2 実行例と出力

例えば次のようなスクリプトを実行したとします。

$ python script.py arg1 arg2 arg3

すると出力は次のようになります。

Received arguments: ['arg1', 'arg2', 'arg3']

2.3 sys.argvを使う際の注意点

引数が空の場合でもエラーにはなりませんが、期待した値が入っているかチェックする必要があります。
sys.argvは全て文字列として扱われるため、数値を扱う場合はint()で変換する必要があります。

数値を扱う場合の例を見てみましょう。

import sys

def main():
    if len(sys.argv) < 3:
        print("Usage: python script.py num1 num2")
        return
    num1 = int(sys.argv[1])
    num2 = int(sys.argv[2])
    print("Sum:", num1 + num2)

if __name__ == "__main__":
    main()

3. argparseを使った引数の解析

3.1 argparseを使うメリット

sys.argvはシンプルですが、argparseモジュールを使用することでより高度な引数解析を行うことができます。

3.2 argparseを使用した基本例

import argparse

def main():
    parser = argparse.ArgumentParser(description="引数の解析を行うサンプル")
    parser.add_argument("name", help="ユーザー名を入力してください")
    parser.add_argument("--age", type=int, help="年齢を入力してください")
    parser.add_argument("--city", help="都市名を入力してください")
    
    args = parser.parse_args()
    print(f"こんにちは、{args.name}さん！")
    if args.age:
        print(f"あなたは{args.age}歳ですね。")
    if args.city:
        print(f"出身地は{args.city}ですね。")

if __name__ == "__main__":
    main()

3.3実行例

次のスクリプトを実行すると、

$ python script.py Taro --age 25 --city Tokyo

以下のような出力になります。

こんにちは、Taroさん！
あなたは25歳ですね。
出身地はTokyoですね。

3.3.1 argparseの利点

必須引数とオプション引数を明確に分けられる。
helpメッセージが自動生成される。
データ型の変換を自動で行ってくれる（type=intなど）。

3.3.2　デフォルト値を設定する例

parser.add_argument("--age", type=int, default=20, help="年齢を入力してください（デフォルト: 20）")

4. main関数のベストプラクティス

4.1 main関数を使う理由

if __name__ == “__main__” を用いることで、モジュールとしても使いやすくなる。
引数の解析にはargparseを推奨。
main関数を定義し、処理を分割して整理することで、可読性が向上する。
コマンドライン引数を適切にチェックし、エラーハンドリングを行う。

4.2 汎用的なテンプレート

次のようなテンプレートを作成しておくと、再利用しやすくなり便利です。

import argparse

def process_data(name, age, city):
    print(f"こんにちは、{name}さん！")
    if age:
        print(f"あなたは{age}歳ですね。")
    if city:
        print(f"出身地は{city}ですね。")

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument("name", help="名前を入力してください")
    parser.add_argument("--age", type=int, help="年齢を入力してください")
    parser.add_argument("--city", help="都市名を入力してください")
    args = parser.parse_args()
    process_data(args.name, args.age, args.city)

if __name__ == "__main__":
    main()