Pythonのargparseモジュールを使用して、コマンドラインインターフェース(CLI)のバージョン情報を表示する方法について説明します。
argparseとは
argparseはPythonの標準ライブラリで、コマンドラインオプション、引数、サブコマンドのパーサーです。このモジュールはユーザーフレンドリーなコマンドラインインターフェースを簡単に作成することができます。
バージョン情報の表示
argparseを使用して、--version
オプションを実装する一例を以下に示します。
import argparse
def get_version():
return '1.0.0.0'
if __name__ == '__main__':
parse = argparse.ArgumentParser()
parse.add_argument('-v', '--version', action='version', version=get_version(), help='Display version')
上記のコードでは、get_version
関数を定義してバージョン情報を返し、argparse.ArgumentParser
のインスタンスを作成しています。そして、add_argument
メソッドを使用して-v
または--version
オプションを追加し、action='version'
とversion=get_version()
を指定してバージョン情報を表示するように設定しています。
このコードを実行すると、-v
または--version
オプションを指定してプログラムを実行すると、get_version
関数が返すバージョン情報が表示されます。
注意点
argparseのparser.version
属性は非推奨となっています。そのため、バージョン情報を取得するためには、argparse._VersionActionオブジェクトを見つけてそこから取得する必要があります。
以上が、Pythonのargparseを使用してバージョン情報を表示する方法になります。この情報がPythonのCLIツール開発に役立つことを願っています。