Zenn
Closed4

Pythonのコマンドラインパーサー

Python
#
click
#
argparse
shotakahashotakaha

argpase

  • Pythonの標準パッケージなので、そのまま使うことができる
  • 基本的な使い方は以下のとおり
import argparse

# オプション解析オブジェクトを作成
parser = argparse.ArgumentParser(description="プログラムの説明")

# オプションを追加
parser.add_argument("-a", help="オプションの説明")
parser.add_argument("-b", help="オプションの説明")

# 解析したオプションを取得
args = parser.parse_args() 

# 関数の引数に使う
if args.a:
    関数(b)
shotakahashotakaha

サブコマンド（ArgumentParser.add_subparsers）

  • （動作確認はしてない）
parser = argparse.ArgumentParser(description="プログラムの説明")
parser.add_argument("-a", help="オプションの説明")
subparsers = parser.add_subparsers(help="サブコマンドの説明")

# config コマンド
parser_config = subparsers.add_parser("config", help="show config")
parser_config.add_argument("-l", help="list configurations")
shotakahashotakaha

バージョン表示

from パッケージ名 import __version__
parser.add_argument("--version", action="version", version=f"{__version__}")
  • パッケージのバージョンを表示するためのactionがある
  • version=とセットで使う必要がある（ないとエラーになる）
  • __init__.pyなどに定義したバージョン（__version__）を表示できる
このスクラップは4ヶ月前にクローズされました