コンテンツにスキップ
CodeMDD.io | Coding Tutorials

argparseを使ってコマンドライン引数を簡単に処理する方法

[

argparse python

コマンドラインアプリケーションは、一般的なユーザーの間では一般的ではありませんが、開発、データサイエンス、システム管理などの操作においては頻繁に使用されています。コマンドラインアプリケーション自体とやり取りするために、ユーザーフレンドリーなコマンドラインインターフェース（CLI）が必要です。Pythonでは、標準ライブラリの**argparse**モジュールを使用して、充実した機能を備えたCLIを作成することができます。

この記事では、次のことを学びます：

  • コマンドラインインターフェースの使い方
  • Pythonでコマンドラインアプリケーションプロジェクトを組織化し、レイアウトする方法
  • Pythonの**argparseを使ってコマンドラインインターフェース**を作成する方法
  • argparseのいくつかのパワフルな機能を使ってCLIをカスタマイズする方法

Command-Line Interfacesの理解

Command-Line Interfaces（CLIs）

コマンドラインインターフェース（CLI）は、ユーザーがコマンドライン（ターミナル）経由でアプリケーションと対話するための方法です。一部のユーザーは、GUI（グラフィカルユーザーインターフェース）を使用したアプリケーションとは異なり、コマンドラインインターフェースの方が効率的に作業できると感じています。

コマンド、引数、オプション、パラメータ、サブコマンド

CLIでは、いくつかの重要な用語を理解する必要があります。

  • コマンド（Command）：アプリケーションが実行する動作を指示するコマンドのことです。例えば、ファイルを作成するためのcreateコマンドやデータを表示するためのshowコマンドなどがあります。

  • 引数（Argument）：コマンドの実行に必要な情報を指定するための値です。例えば、ファイル名やデータのIDなどが引数として使用されます。

  • オプション（Option）：コマンドのオプション設定を指定するためのフラグです。例えば、-vオプションを使用することで、詳細な出力を表示することができます。

  • パラメータ（Parameter）：オプションに関連付けられた値です。通常、オプションとパラメータは一緒に使用され、オプションの設定に値を与えるために使用されます。例えば、--output=filenameというオプションとパラメータの組み合わせで、出力先のファイル名を指定することができます。

  • サブコマンド（Subcommand）：メインのコマンドによって指示される追加のコマンドです。サブコマンドはメインコマンドに関連した特定の操作を行うために使用されます。例えば、Gitコマンドラインツールではgit commitやgit pushのようなサブコマンドがあります。

PythonでCLIsを使い始める：sys.argv vs argparse

Pythonでは、コマンドライン引数を処理するための2つの主要な方法があります。1つはsys.argvを使用する方法であり、もう1つはargparseを使用する方法です。それぞれのメリットとデメリットを理解し、どちらを使うべきかを判断することが重要です。

sys.argvを使用して最小限のCLIを作成する

Pythonのsysモジュールには、プログラムの実行時にコマンドライン引数を取得するためのargvというリストがあります。このリストを使用することで、シンプルなCLIを作成することができます。

以下は、sys.argvを使用してコマンドライン引数を処理する簡単なCLIの例です。

import sys


def main():
    # コマンドライン引数の取得
    args = sys.argv


    # 引数の解析と処理
    if len(args) == 1:
        print("Hello, World!")
    else:
        name = args[1]
        print(f"Hello, {name}!")


if __name__ == "__main__":
    main()

このコードでは、コマンドライン引数が指定されていない場合はHello, World!と表示し、コマンドライン引数が指定されている場合はその引数の値を用いてHello, {name}!と表示します。

argparseを使ってCLIを作成する

Pythonのargparseモジュールは、より複雑なCLIを作成するための柔軟でパワフルなツールです。argparseを使うことで、引数とオプションを簡単に定義し、パースすることができます。

以下は、argparseを使用してコマンドライン引数を処理するCLIの例です。

import argparse


def main():
    # コマンドライン引数の定義
    parser = argparse.ArgumentParser(description="This is a sample CLI.")
    parser.add_argument("name", help="Your name")


    # 引数の解析と処理
    args = parser.parse_args()
    name = args.name
    print(f"Hello, {name}!")


if __name__ == "__main__":
    main()

このコードでは、argparse.ArgumentParserを使用してコマンドライン引数の定義を行っています。add_argumentメソッドを使用することで、引数やオプションの詳細を指定することができます。parse_argsメソッドを使用することで、コマンドライン引数を解析し、指定された値を取得することができます。

Pythonのargparseを使ったコマンドラインインターフェースの作成

Command-Line Argument Parserの作成

CLIを作成する際には、まずargparse.ArgumentParserオブジェクトを作成する必要があります。このオブジェクトは、あらゆる引数やオプションの詳細を設定するためのメソッドを提供します。

以下は、argparse.ArgumentParserオブジェクトを作成する例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")

この例では、argparse.ArgumentParserオブジェクトを作成しています。description引数には、CLIの説明を指定することができます。

引数とオプションの追加

引数やオプションをCLIに追加するには、add_argumentメソッドを使用します。このメソッドには、追加する引数やオプションの情報を指定するための引数があります。

以下は、引数とオプションを追加する例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数の追加
parser.add_argument("name", help="Your name")


# オプションの追加
parser.add_argument("--greeting", help="The greeting message", default="Hello")

この例では、add_argumentメソッドを使用して、nameという引数と、greetingというオプションをCLIに追加しています。help引数には、引数やオプションの説明を指定することができます。default引数には、オプションのデフォルト値を指定することができます。

コマンドライン引数とオプションのパース

argparse.ArgumentParserオブジェクトに引数やオプションが追加されたら、コマンドライン引数とオプションをパースする準備が整いました。パースとは、コマンドラインから渡された引数やオプションの値を解析して取得することです。

以下は、コマンドライン引数とオプションをパースする例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数の追加
parser.add_argument("name", help="Your name")


# オプションの追加
parser.add_argument("--greeting", help="The greeting message", default="Hello")


# 引数とオプションのパース
args = parser.parse_args()
name = args.name
greeting = args.greeting
print(f"{greeting}, {name}!")

この例では、parser.parse_argsメソッドを使用して、コマンドライン引数とオプションをパースしています。パースされた結果は、argsオブジェクトに保存されます。argsオブジェクトの属性を使用して、引数やオプションの値にアクセスできます。

CLIアプリケーションのレイアウトとビルドシステムのセットアップ

CLIアプリケーションを構築する際には、適切なレイアウトとビルドシステムのセットアップも重要です。これにより、CLIアプリケーションを効果的に管理し、実行することができます。

以下は、CLIアプリケーションの一般的なレイアウトの例です。

mycli/
    mycli/
        __init__.py
        main.py
    setup.py
    README.md

この例では、mycliという名前のディレクトリ内にPythonモジュールとしてのCLIアプリケーションが配置されています。また、ルートディレクトリにはsetup.pyファイルとREADME.mdファイルがあります。

必要に応じて、setup.pyファイルを使用してCLIアプリケーションのビルドシステムを設定できます。これにより、他のユーザーがCLIアプリケーションを簡単にインストールおよび使用できるようになります。

コマンドライン引数パーサのカスタマイズ

プログラムのヘルプと使用方法のカスタマイズ

argparse.ArgumentParserオブジェクトは、add_argumentメソッドの他にも多くのカスタマイズオプションを提供しています。例えば、プログラムのヘルプや使用方法などの表示をカスタマイズすることができます。

以下は、ヘルプと使用方法をカスタマイズする例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(
    description="This is a sample CLI.",
    prog="mycli",
    usage="%(prog)s [name] [--greeting GREETING]",
    epilog="Thank you for using my CLI!"
)


# 引数の追加
parser.add_argument("name", help="Your name")


# オプションの追加
parser.add_argument("--greeting", help="The greeting message", default="Hello")


# 引数とオプションのパース
args = parser.parse_args()
name = args.name
greeting = args.greeting
print(f"{greeting}, {name}!")

この例では、argparse.ArgumentParserオブジェクトのコンストラクタにprog引数とusage引数を追加しています。prog引数では、プログラムの名前を指定することができます。usage引数では、プログラムの使用方法を指定することができます。また、epilog引数を使用することで、プログラムの実行後に表示されるメッセージを指定することもできます。

引数とオプションのためのグローバル設定の提供

argparse.ArgumentParserオブジェクトのadd_argumentメソッドでは、引数やオプションにさまざまなカスタマイズオプションを設定することができます。しかし、同じ設定を複数の引数やオプションに適用する場合、DRY原則に従って、コードの重複を避けることが重要です。

以下は、引数とオプションのためのグローバル設定を提供する例です。

import argparse


# グローバルな設定を定義
name_config = {
    "help": "Your name"
}


greeting_config = {
    "help": "The greeting message",
    "default": "Hello"
}


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数の追加
parser.add_argument("name", **name_config)


# オプションの追加
parser.add_argument("--greeting", **greeting_config)


# 引数とオプションのパース
args = parser.parse_args()
name = args.name
greeting = args.greeting
print(f"{greeting}, {name}!")

この例では、グローバルな設定を辞書として定義し、**を使って引数やオプションに展開しています。これにより、同じ設定を複数の引数やオプションに適用することができます。

コマンドライン引数とオプションの微調整

オプションのアクションの設定

argparseでは、オプションのアクションを設定することにより、オプションの挙動をカスタマイズすることができます。アクションは、オプションが指定されたときに実行されるコードのブロックです。

以下は、オプションのアクションを設定する例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# オプションの追加
parser.add_argument("--uppercase", help="Convert the greetings to uppercase", action="store_true")
parser.add_argument("--lowercase", help="Convert the greetings to lowercase", action="store_true")


# 引数とオプションのパース
args = parser.parse_args()
greeting = "Hello"


if args.uppercase:
    greeting = greeting.upper()


if args.lowercase:
    greeting = greeting.lower()


print(greeting)

この例では、action引数を使用してオプションのアクションを設定しています。store_trueアクションは、オプションが指定された場合に変数にTrueを格納し、指定されなかった場合にはFalseを格納します。このようにして、オプションの指定に応じて異なる挙動を実現することができます。

引数やオプションの入力値のカスタマイズ

argparseでは、引数やオプションの入力値をカスタマイズすることもできます。例えば、数値型の引数やオプションの入力値を制限することができます。

以下は、入力値をカスタマイズする例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数とオプションの追加
parser.add_argument("number", type=int, help="Enter a number between 1 and 10", choices=range(1, 11))


# 引数とオプションのパース
args = parser.parse_args()
number = args.number
print(f"The number you entered is {number}.")

この例では、type引数を使用して引数やオプションのデータ型を指定しています。また、choices引数を使用して、入力値の候補を指定することもできます。入力値が指定された候補に一致しない場合は、エラーメッセージが表示されます。

引数やオプションのヘルプメッセージの提供とカスタマイズ

argparseでは、引数やオプションのヘルプメッセージを提供することができます。また、デフォルトのヘルプメッセージをカスタマイズすることもできます。

以下は、ヘルプメッセージを提供し、カスタマイズする例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数とオプションの追加
parser.add_argument("name", help="Your name", metavar="NAME")
parser.add_argument("--greeting", help="The greeting message", default="Hello", metavar="GREETING")


# 引数とオプションのパース
args = parser.parse_args()
name = args.name
greeting = args.greeting
print(f"{greeting}, {name}!")

この例では、help引数を使用して引数やオプションの説明を指定しています。また、metavar引数を使用して、引数やオプションの値の表示をカスタマイズしています。

互いに排他的な引数とオプショングループの定義

argparseでは、互いに排他的な引数やオプショングループを定義することができます。これにより、同時に指定できない引数やオプションの組み合わせを定義することができます。

以下は、互いに排他的な引数やオプショングループを定義する例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数のグループを作成
group = parser.add_mutually_exclusive_group()


# 引数の追加
group.add_argument("--english", help="Use English greetings")
group.add_argument("--japanese", help="Use Japanese greetings")


# 引数とオプションのパース
args = parser.parse_args()
if args.english:
    print("Hello!")
elif args.japanese:
    print("こんにちは！")
else:
    print("No greetings selected.")

この例では、argparse.ArgumentParserオブジェクトのadd_mutually_exclusive_groupメソッドを使用して、互いに排他的な引数グループを作成しています。それぞれのオプションを別々に追加する必要があります。

CLIsにサブコマンドを追加する

argparseを使用すれば、メインコマンドとサブコマンドを使って複数のコマンドを持つCLIを作成することもできます。

以下は、サブコマンドを持つCLIの例です。

import argparse


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# サブコマンドのサブパーサーを作成
subparsers = parser.add_subparsers(title="subcommands", dest="subcommand")


# サブコマンド：greet
greet_parser = subparsers.add_parser("greet", help="Greet someone")
greet_parser.add_argument("name", help="The name of the person to greet")


# サブコマンド：count
count_parser = subparsers.add_parser("count", help="Count the number of items")
count_parser.add_argument("items", nargs="+", help="The items to count")


# 引数とオプションのパース
args = parser.parse_args()


# サブコマンド毎に処理を実行
if args.subcommand == "greet":
    name = args.name
    print(f"Hello, {name}!")


elif args.subcommand == "count":
    items = args.items
    count = len(items)
    print(f"The number of items is {count}.")

この例では、argparse.ArgumentParserオブジェクトのadd_subparsersメソッドを使用して、サブコマンドのサブパーサーを作成しています。各サブコマンドに対して、個別の引数やオプションを追加することができます。また、dest引数を使用して、選択されたサブコマンドを識別するための変数を指定しています。

CLIアプリケーションの実行の終了方法の処理

CLIアプリケーションの実行が終了する場合には、適切な終了方法の処理が重要です。argparseを使用すれば、CLIアプリケーションがいつ終了するかを指定することができます。

以下は、CLIアプリケーションの実行終了方法の処理の例です。

import argparse
import sys


# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="This is a sample CLI.")


# 引数とオプションの追加
parser.add_argument("--exit", help="Exit the program", action="store_true")


# 引数とオプションのパース
args = parser.parse_args()


# オプションが指定された場合、プログラムを終了する
if args.exit:
    sys.exit()

この例では、argparseを使用してexitというオプションを追加しています。オプションが指定された場合、sys.exit()関数を使用してプログラムを終了します。

結論

Pythonのargparseモジュールを使用すると、コマンドラインインターフェース（CLI）を作成するのに役立つさまざまな機能を利用することができます。本記事では、コマンドラインインターフェースの基本的な使い方から高度なカスタマイズまでを学びました。ぜひ、PythonのCLIアプリケーション開発でargparseを活用してみてください。

この記事がいいね！だと思ったら、以下をクリックしてシェアしてください。

関連するビデオコース

ビデオコース：argparseを使ったコマンドラインインターフェースの構築

以上