単純なargparseの例：1つの引数、3つの結果

argparse pythonモジュールのドキュメントはすばらしいと思いますが、小さな初心者の脳には今すぐ理解するには多すぎます。コマンドラインで数学を実行したり、画面のフォーマット行をいじったり、オプション文字を変更したりする必要はありません。私がやりたいことは、「argがAの場合、これを行い、Bがそれを行う場合、上記のいずれもヘルプを表示せずに終了する場合」です。

元の質問に対する私の理解は2つあります。最初に、可能な最も単純なargparseの例に関して、私はここでそれを見たことがないことに驚いています。もちろん、非常にシンプルになるには、すべてのオーバーヘッドがあり、電力もほとんどありませんが、それで始められるかもしれません。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("a")
args = parser.parse_args()

if args.a == 'magic.name':
    print 'You nailed it!'

しかし、この位置引数は今必要です。このプログラムを呼び出すときに省略した場合、引数の不足に関するエラーが発生します。これにより、元の質問の2番目の部分に進みます。Matt Wilkieは、名前付きラベルなしの単一のオプション引数（--optionラベル）を望んでいるようです。上記のコードを次のように変更することをお勧めします。

...
parser.add_argument("a", nargs='?', default="check_string_for_empty")
...
if args.a == 'check_string_for_empty':
    print 'I can tell that no argument was given and I can deal with that here.'
elif args.a == 'magic.name':
    print 'You nailed it!'
else:
    print args.a

よりエレガントな解決策があるかもしれませんが、これは機能し、ミニマリストです。

これが私がそれを行う方法ですargparse（複数の引数を使用）：

parser = argparse.ArgumentParser(description='Description of your program')
parser.add_argument('-f','--foo', help='Description for foo argument', required=True)
parser.add_argument('-b','--bar', help='Description for bar argument', required=True)
args = vars(parser.parse_args())

args 引数を含む辞書になります：

if args['foo'] == 'Hello':
    # code here

if args['bar'] == 'World':
    # code here

あなたのケースでは、引数を1つだけ追加します。

argparseドキュメントには、合理的に良いのですが、葉アウト明白ではないかもしれないいくつかの有用な詳細情報。（@Diego Navarroはすでにこれのいくつかについて言及しましたが、私は彼の答えを少し拡張してみます。）基本的な使用法は次のとおりです。

parser = argparse.ArgumentParser()
parser.add_argument('-f', '--my-foo', default='foobar')
parser.add_argument('-b', '--bar-value', default=3.14)
args = parser.parse_args()

元に戻すオブジェクトparse_args()は「名前空間」オブジェクトです。メンバー変数がコマンドライン引数に基づいて名前が付けられているオブジェクトです。Namespaceオブジェクトは、あなたの引数とそれに関連付けられた値にアクセスする方法です。

args = parser.parse_args()
print args.my_foo
print args.bar_value

（argparse変数に名前を付けるときに、引数名の「-」がアンダースコアに置き換えられることに注意してください。）

多くの状況では、引数を、値を取らないフラグとして単に使用したい場合があります。これらを次のようにargparseに追加できます。

parser.add_argument('--foo', action='store_true')
parser.add_argument('--no-foo', action='store_false')

上記は、値がTrueの「foo」、値がFalseの「no_foo」という変数をそれぞれ作成します。

if (args.foo):
    print "foo is true"

if (args.no_foo is False):
    print "nofoo is false"

引数を追加するときに「必須」オプションを使用できることにも注意してください。

parser.add_argument('-o', '--output', required=True)

このように、コマンドラインでこの引数を省略した場合、argparse欠落していることが通知され、スクリプトの実行が停止します。

最後に、vars関数を使用して引数のdict構造を作成することが可能であることに注意してください。

args = parser.parse_args()
argsdict = vars(args)
print argsdict['my_foo']
print argsdict['bar_value']

ご覧のとおりvars、引数名をキーとして、その値をer値として、dictを返します。

他にも多くのオプションと実行可能な操作がありますが、これは最も重要で一般的な使用シナリオをカバーするはずです。

Mattはargparseの位置パラメータについて質問しており、Pythonのドキュメントにはこの側面が欠けていることに同意します。位置パラメータの解析と使用の両方を示す〜20の奇数ページには、単一の完全な例はありません。

ここでの他の答えはどれも位置パラメータの完全な例を示していないため、ここに完全な例を示します。

# tested with python 2.7.1
import argparse

parser = argparse.ArgumentParser(description="An argparse example")

parser.add_argument('action', help='The action to take (e.g. install, remove, etc.)')
parser.add_argument('foo-bar', help='Hyphens are cumbersome in positional arguments')

args = parser.parse_args()

if args.action == "install":
    print("You asked for installation")
else:
    print("You asked for something other than installation")

# The following do not work:
# print(args.foo-bar)
# print(args.foo_bar)

# But this works:
print(getattr(args, 'foo-bar'))

私を驚かせたのは、argparseは名前付き引数「--foo-bar」を「foo_bar」に変換しますが、「foo-bar」という名前の位置パラメータは「foo-bar」のままであるため、プログラムで使用してください。

この例の終わり近くにある2行に注目してください。どちらも、foo-bar位置パラメーターの値を取得するようには機能しません。最初のものは明らかに間違っています（算術式args.fooからバーを引いたものです）が、2番目のものも機能しません。

AttributeError: 'Namespace' object has no attribute 'foo_bar'

このfoo-bar属性を使用する場合getattrは、例の最後の行にあるように、を使用する必要があります。クレイジーなのは、を使用dest=foo_barしてプロパティ名をアクセスしやすい名前に変更しようとすると、本当に奇妙なエラーメッセージが表示されるということです。

ValueError: dest supplied twice for positional argument

上記の例の実行方法は次のとおりです。

$ python test.py
usage: test.py [-h] action foo-bar
test.py: error: too few arguments

$ python test.py -h
usage: test.py [-h] action foo-bar

An argparse example

positional arguments:
  action      The action to take (e.g. install, remove, etc.)
  foo-bar     Hyphens are cumbersome in positional arguments

optional arguments:
  -h, --help  show this help message and exit

$ python test.py install foo
You asked for installation
foo

この投稿に触発された、さらに別の概要の紹介。

import argparse

# define functions, classes, etc.

# executes when your script is called from the command-line
if __name__ == "__main__":

    parser = argparse.ArgumentParser()
    #
    # define each option with: parser.add_argument
    #
    args = parser.parse_args() # automatically looks at sys.argv
    #
    # access results with: args.argumentName
    #

引数は、次の組み合わせで定義されます。

parser.add_argument( 'name', options... )              # positional argument
parser.add_argument( '-x', options... )                # single-char flag
parser.add_argument( '-x', '--long-name', options... ) # flag with long name

一般的なオプションは次のとおりです。

• help：--help使用時のこの引数の説明。
• default：引数が省略された場合のデフォルト値。
• type：floatまたはを期待する場合int（そうでない場合はstr）。
• dest：フラグに別の名前を付け'-x', '--long-name', dest='longName'ます（例：）。
  注：デフォルトで--long-nameは、args.long_name
• action：特定の引数を特別に処理するため
  • store_true, store_false：ブール引数
    '--foo', action='store_true' => args.foo == True
  • store_const：オプションで使用const
'--foo', action='store_const', const=42 => args.foo == 42
  • count：繰り返しオプションの場合、./myscript.py -vv
'-v', action='count' => args.v == 2
  • append：繰り返しオプションの場合、./myscript.py --foo 1 --foo 2
'--foo', action='append' => args.foo == ['1', '2']
• required：フラグが必要な場合、または位置引数が必要でない場合。
• nargs：N個の引数をキャプチャするフラグ
  ./myscript.py --foo a b => args.foo = ['a', 'b']
• 選択肢：可能な入力を制限します（文字列のリスト、またはの場合は整数として指定type=int）

Python HOWTOのArgparseチュートリアルに注意してください。これは、次のような最も基本的な例から始まります。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)

そして、あまり基本的でないものに進みます。

質問のように、オプションの定義済みの選択肢の例があります。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

これは主に@DMHのおかげで私の学習プロジェクトで思いついたものです...

デモコード：

import argparse

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('-f', '--flag', action='store_true', default=False)  # can 'store_false' for no-xxx flags
    parser.add_argument('-r', '--reqd', required=True)
    parser.add_argument('-o', '--opt', default='fallback')
    parser.add_argument('arg', nargs='*') # use '+' for 1 or more args (instead of 0 or more)
    parsed = parser.parse_args()
    # NOTE: args with '-' have it replaced with '_'
    print('Result:',  vars(parsed))
    print('parsed.reqd:', parsed.reqd)

if __name__ == "__main__":
    main()

これは進化した可能性があり、オンラインで利用できます：command-line.py

このコードにワークアウトを与えるスクリプト：command-line-demo.sh

また、plac（ラッパーのラッパーargparse）を使用することもできます。

おまけとして、それはきちんとしたヘルプ指示を生成します-以下を見てください

スクリプトの例：

#!/usr/bin/env python3
def main(
    arg: ('Argument with two possible values', 'positional', None, None, ['A', 'B'])
):
    """General help for application"""
    if arg == 'A':
        print("Argument has value A")
    elif arg == 'B':
        print("Argument has value B")

if __name__ == '__main__':
    import plac
    plac.call(main)

出力例：

引数が指定されていません- example.py：

usage: example.py [-h] {A,B}
example.py: error: the following arguments are required: arg

予期しない引数が指定されました- example.py C：

usage: example.py [-h] {A,B}
example.py: error: argument arg: invalid choice: 'C' (choose from 'A', 'B')

正しい引数が指定されました- example.py A：

Argument has value A

完全なヘルプメニュー（自動生成）- example.py -h：

usage: example.py [-h] {A,B}

General help for application

positional arguments:
  {A,B}       Argument with two possible values

optional arguments:
  -h, --help  show this help message and exit

簡単な説明：

引数の名前は通常、パラメーター名（arg）と同じです。

argパラメーターの後のタプルアノテーションには次の意味があります。

• 説明（Argument with two possible values）
• 引数のタイプ-'flag'、 'option'、または 'positional'（positional）のいずれか
• 略語（None）
• 引数値のタイプ-例 float、string（None）
• 制限された選択肢のセット（['A', 'B']）

ドキュメンテーション：

placの使用について詳しくは、優れたドキュメントをご覧ください。

Plac：コマンドラインを簡単に解析する

他の人が述べたことに追加するには：

私は通常、「dest」パラメーターを使用して変数名を指定し、次に「globals（）。update（）」を使用してそれらの変数をグローバル名前空間に配置します。

使用法：

$ python script.py -i "Hello, World!"

コード：

...
parser.add_argument('-i', '--input', ..., dest='inputted_variable',...)
globals().update(vars(parser.parse_args()))
...
print(inputted_variable) # Prints "Hello, World!"

argparseを使用して '-h' / '-help'スイッチを修正し、独自の個人コードのヘルプ手順を表示する本当に簡単な方法は、デフォルトのヘルプをFalseに設定することです。好きなだけ.add_argumentsを追加することもできます。 ：

import argparse

parser = argparse.ArgumentParser(add_help=False)

parser.add_argument('-h', '--help', action='help',
                help='To run this script please provide two arguments')
parser.parse_args()

実行：python test.py -h

出力：

usage: test.py [-h]

optional arguments:
  -h, --help  To run this script please provide two arguments

最も簡単な答え！

PS argparseのドキュメントを書いた人はバカです

Pythonコード：

import argparse
parser = argparse.ArgumentParser(description='')
parser.add_argument('--o_dct_fname',type=str)
parser.add_argument('--tp',type=str)
parser.add_argument('--new_res_set',type=int)
args = parser.parse_args()
o_dct_fname = args.o_dct_fname
tp = args.tp
new_res_set = args.new_res_set

実行中のコード

python produce_result.py --o_dct_fname o_dct --tp father_child --new_res_set 1