関数

[Python] コマンドラインから関数を実行する

Pythonでは、コマンドラインから直接関数を実行することが可能です。これにより、スクリプトを実行する際に特定の関数を呼び出すことができます。

一般的には、argparseモジュールを使用してコマンドライン引数を解析し、指定された関数を実行します。

また、if __name__ == '__main__':ブロックを使用して、スクリプトが直接実行されたときにのみ関数を呼び出すことができます。

この方法は、スクリプトをモジュールとしてインポートした際に不要な実行を防ぐために役立ちます。

目次から探す

関数をコマンドラインから実行する方法
argparseモジュールの活用
応用例
まとめ

関数をコマンドラインから実行する方法

Pythonでは、コマンドラインから関数を実行することができます。

これにより、スクリプトを柔軟に操作し、さまざまな入力に応じて異なる動作をさせることが可能です。

以下では、関数をコマンドラインから実行するための基本的な方法を解説します。

関数をスクリプト内で定義する

まず、Pythonスクリプト内で関数を定義します。

関数は、特定のタスクを実行するためのコードのブロックです。

以下は、簡単な関数の例です。

def greet(name):
    # 名前を受け取って挨拶を表示する関数
    print(f"こんにちは、{name}さん！")

この関数は、引数として名前を受け取り、挨拶を表示します。

コマンドライン引数を関数に渡す

次に、コマンドラインから引数を受け取り、それを関数に渡す方法を説明します。

Pythonでは、sysモジュールを使用してコマンドライン引数を取得できます。

import sys
def greet(name):
    # 名前を受け取って挨拶を表示する関数
    print(f"こんにちは、{name}さん！")
if __name__ == "__main__":
    # コマンドライン引数を取得
    if len(sys.argv) > 1:
        name = sys.argv[1]
        greet(name)
    else:
        print("名前を入力してください。")

このスクリプトは、コマンドラインから名前を受け取り、その名前を使って挨拶を表示します。

引数が指定されていない場合は、エラーメッセージを表示します。

$ python script.py Taro
こんにちは、Taroさん！

この例では、Taroという名前をコマンドライン引数として渡し、関数がその名前を使って挨拶を表示しています。

if name == “main” の使い方

Pythonスクリプトを直接実行する際に、if __name__ == "__main__":という構文を使うことが一般的です。

これは、スクリプトが直接実行されたときにのみ、特定のコードブロックを実行するための方法です。

import sys
def greet(name):
    # 名前を受け取って挨拶を表示する関数
    print(f"こんにちは、{name}さん！")
if __name__ == "__main__":
    # スクリプトが直接実行された場合にのみ実行される
    if len(sys.argv) > 1:
        name = sys.argv[1]
        greet(name)
    else:
        print("名前を入力してください。")

この構文を使うことで、スクリプトが他のモジュールからインポートされた場合には、ifブロック内のコードが実行されないようにすることができます。

これにより、スクリプトの再利用性が向上します。

argparseモジュールの活用

Pythonのargparseモジュールは、コマンドライン引数を簡単に処理するための強力なツールです。

このモジュールを使用することで、スクリプトに対して柔軟な引数の指定が可能になり、ユーザーにとって使いやすいインターフェースを提供できます。

argparseの基本

argparseモジュールを使用するには、まずArgumentParserオブジェクトを作成します。

このオブジェクトは、コマンドライン引数を定義し、解析するための中心的な役割を果たします。

import argparse
# ArgumentParserオブジェクトの作成
parser = argparse.ArgumentParser(description="このスクリプトは挨拶を表示します。")

この例では、descriptionパラメータを使用して、スクリプトの説明を設定しています。

コマンドライン引数のパース

次に、add_argumentメソッドを使用して、スクリプトが受け取る引数を定義します。

引数の名前や型、デフォルト値などを指定できます。

# 引数の定義
parser.add_argument('name', type=str, help='挨拶する相手の名前')
# 引数の解析
args = parser.parse_args()
# 関数の実行
def greet(name):
    print(f"こんにちは、{name}さん！")
greet(args.name)

このスクリプトは、nameという引数を受け取り、その名前を使って挨拶を表示します。

$ python script.py Taro
こんにちは、Taroさん！

この例では、Taroという名前をコマンドライン引数として渡し、関数がその名前を使って挨拶を表示しています。

必須引数とオプション引数の設定

argparseでは、必須引数とオプション引数を簡単に設定できます。

必須引数は、スクリプトの実行時に必ず指定しなければならない引数です。

一方、オプション引数は指定しなくてもよい引数で、デフォルト値を設定することができます。

# オプション引数の定義
parser.add_argument('--greeting', type=str, default='こんにちは', help='挨拶の言葉')
# 引数の解析
args = parser.parse_args()
# 関数の実行
def greet(name, greeting):
    print(f"{greeting}、{name}さん！")
greet(args.name, args.greeting)

$ python script.py Taro --greeting "おはよう"
おはよう、Taroさん！

この例では、--greetingオプションを使用して、挨拶の言葉を変更しています。

ヘルプメッセージの自動生成

argparseは、スクリプトの使い方を示すヘルプメッセージを自動的に生成します。

ユーザーが-hまたは--helpオプションを指定すると、定義された引数の説明が表示されます。

$ python script.py -h
usage: script.py [-h] [--greeting GREETING] name
このスクリプトは挨拶を表示します。
positional arguments:
  name                  挨拶する相手の名前
optional arguments:
  -h, --help            show this help message and exit
  --greeting GREETING   挨拶の言葉

このヘルプメッセージは、スクリプトの使い方をユーザーにわかりやすく伝えるために非常に便利です。

応用例

Pythonのコマンドライン引数処理を応用することで、より高度なスクリプトを作成することができます。

ここでは、いくつかの応用例を紹介します。

複数の関数をコマンドラインから選択して実行

複数の関数を持つスクリプトで、コマンドライン引数を使って実行する関数を選択することができます。

以下の例では、greetとfarewellという2つの関数を用意し、コマンドライン引数でどちらを実行するかを指定します。

import argparse
def greet(name):
    print(f"こんにちは、{name}さん！")
def farewell(name):
    print(f"さようなら、{name}さん！")
parser = argparse.ArgumentParser(description="挨拶または別れのメッセージを表示します。")
parser.add_argument('action', choices=['greet', 'farewell'], help='実行するアクション')
parser.add_argument('name', type=str, help='対象の名前')
args = parser.parse_args()
if args.action == 'greet':
    greet(args.name)
elif args.action == 'farewell':
    farewell(args.name)

$ python script.py greet Taro
こんにちは、Taroさん！
$ python script.py farewell Taro
さようなら、Taroさん！

この例では、action引数で実行する関数を選択しています。

サブコマンドの実装

argparseを使ってサブコマンドを実装することも可能です。

サブコマンドは、GitやDockerのようなコマンドラインツールでよく見られる機能です。

import argparse
def greet(name):
    print(f"こんにちは、{name}さん！")
def farewell(name):
    print(f"さようなら、{name}さん！")
parser = argparse.ArgumentParser(description="サブコマンドを持つスクリプト")
subparsers = parser.add_subparsers(dest='command')
# greetサブコマンド
greet_parser = subparsers.add_parser('greet', help='挨拶を表示')
greet_parser.add_argument('name', type=str, help='挨拶する相手の名前')
# farewellサブコマンド
farewell_parser = subparsers.add_parser('farewell', help='別れの挨拶を表示')
farewell_parser.add_argument('name', type=str, help='別れを告げる相手の名前')
args = parser.parse_args()
if args.command == 'greet':
    greet(args.name)
elif args.command == 'farewell':
    farewell(args.name)

$ python script.py greet Taro
こんにちは、Taroさん！
$ python script.py farewell Taro
さようなら、Taroさん！

この例では、greetとfarewellというサブコマンドを実装しています。

コマンドラインツールの作成

Pythonスクリプトをコマンドラインツールとして使うためには、実行可能なスクリプトとして設定することが重要です。

以下は、setuptoolsを使ってコマンドラインツールを作成する方法の概要です。

setup.pyファイルを作成し、エントリーポイントを設定します。

from setuptools import setup
setup(
    name='greet_tool',
    version='0.1',
    py_modules=['script'],
    entry_points={
        'console_scripts': [
            'greet_tool=script:main',
        ],
    },
)

script.pyにmain関数を定義します。

def main():
    import argparse
    def greet(name):
        print(f"こんにちは、{name}さん！")
    parser = argparse.ArgumentParser(description="挨拶を表示します。")
    parser.add_argument('name', type=str, help='挨拶する相手の名前')
    args = parser.parse_args()
    greet(args.name)

コマンドラインツールをインストールします。

$ pip install .

これで、greet_toolコマンドとしてスクリプトを実行できるようになります。

環境変数を使った設定の変更

環境変数を使用して、スクリプトの動作を変更することもできます。

環境変数は、システム全体で設定されるため、スクリプトの設定を外部から変更するのに便利です。

import os
def greet(name):
    greeting = os.getenv('GREETING', 'こんにちは')
    print(f"{greeting}、{name}さん！")
greet('Taro')

$ export GREETING="おはよう"
$ python script.py
おはよう、Taroさん！

この例では、GREETINGという環境変数を使って、挨拶の言葉を変更しています。

環境変数が設定されていない場合は、デフォルトの挨拶が使用されます。

まとめ

Pythonでコマンドラインから関数を実行する方法は、argparseモジュールを活用することで非常に柔軟かつ強力になります。

この記事では、基本的な使い方から応用例までを紹介し、コマンドライン引数の処理を効率化する方法を学びました。

これを機に、Pythonスクリプトをより使いやすく、機能的にするための工夫を実践してみてください。