pythonのargparseモジュール(1)
7374 ワード
一、紹介:
argparseはpythonがコマンドラインパラメータとオプションを解析するための標準モジュールであり、古いoptparseモジュールの代わりに使用されます.Argparseモジュールの役割は、python parseTestのようなコマンドラインパラメータを解析することである.py input.txt output.txt --user=name --port=8080.
二、使用手順:
1:import argparse
2:parser = argparse.ArgumentParser()
3:parser.add_argument()
4:parser.parse_args()
説明:まずモジュールをインポートします.解析オブジェクトを作成します.次に、各add_Argumentメソッドは、注目するパラメータまたはオプションに対応します.最後にparse_を呼び出すargs()法による解析;解析に成功したら使用できますが、手順2と3を簡単に説明します.
三、方法ArgumentParser(prog=None,usage=None,description=None,epilog=None,parents=[],formatter_class=argparse.HelpFormatter,prefix_chars='-',fromfile_prefix_chars=None,argument_default=None,conflict_handler='error',ad_help=True)
これらのパラメータにはparserが呼び出されるデフォルト値があります.print_help()またはプログラムを実行するときにパラメータが正しくないため(python解釈器もpring_help()メソッドを呼び出している場合)、これらの記述情報が印刷されます.一般的にdescriptionパラメータを渡すだけです.
四、方法add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
次のようになります.
name or flags:上のaddressや-p、--port.コマンドラインパラメータが指定されておらず、defualtが設定されていない場合、エラーが発生します.ただしオプションであればNoneに設定
nargs:コマンドラインパラメータの個数で、一般的にワイルドカードで表されます.表示は1つだけで、'*'は0から複数を表し、'+'は少なくとも1つを表す.
default:デフォルト
type:パラメータのタイプ、デフォルトは文字列stringタイプ、float、intなどのタイプ
help:ArgumentParserメソッドのパラメータの役割と似ており,出現する場合も一致する.
最もよく使われる場所はこれらで、その他は公式ドキュメントを参考にすることができます.次に、一般的な状況を基本的に含む例を示します.
スクリプトを実行します:python test.py --port 10000 --delay 1.2 127.0.0.1 172.16.55.67 poetry/ecstasy.txt
出力:
The address is : 127.0.0.1 . The address is : 172.16.55.67 . The filename is : poetry/ecstasy.txt . The port is : 10000. The interface is : localhost. The number of seconds between sending bytes : 1.200000 The number of bytes to send at a time : 10.
argparseはpythonがコマンドラインパラメータとオプションを解析するための標準モジュールであり、古いoptparseモジュールの代わりに使用されます.Argparseモジュールの役割は、python parseTestのようなコマンドラインパラメータを解析することである.py input.txt output.txt --user=name --port=8080.
二、使用手順:
1:import argparse
2:parser = argparse.ArgumentParser()
3:parser.add_argument()
4:parser.parse_args()
説明:まずモジュールをインポートします.解析オブジェクトを作成します.次に、各add_Argumentメソッドは、注目するパラメータまたはオプションに対応します.最後にparse_を呼び出すargs()法による解析;解析に成功したら使用できますが、手順2と3を簡単に説明します.
三、方法ArgumentParser(prog=None,usage=None,description=None,epilog=None,parents=[],formatter_class=argparse.HelpFormatter,prefix_chars='-',fromfile_prefix_chars=None,argument_default=None,conflict_handler='error',ad_help=True)
これらのパラメータにはparserが呼び出されるデフォルト値があります.print_help()またはプログラムを実行するときにパラメータが正しくないため(python解釈器もpring_help()メソッドを呼び出している場合)、これらの記述情報が印刷されます.一般的にdescriptionパラメータを渡すだけです.
四、方法add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
次のようになります.
name or flags:上のaddressや-p、--port.コマンドラインパラメータが指定されておらず、defualtが設定されていない場合、エラーが発生します.ただしオプションであればNoneに設定
nargs:コマンドラインパラメータの個数で、一般的にワイルドカードで表されます.表示は1つだけで、'*'は0から複数を表し、'+'は少なくとも1つを表す.
default:デフォルト
type:パラメータのタイプ、デフォルトは文字列stringタイプ、float、intなどのタイプ
help:ArgumentParserメソッドのパラメータの役割と似ており,出現する場合も一致する.
最もよく使われる場所はこれらで、その他は公式ドキュメントを参考にすることができます.次に、一般的な状況を基本的に含む例を示します.
スクリプトを実行します:python test.py --port 10000 --delay 1.2 127.0.0.1 172.16.55.67 poetry/ecstasy.txt
import argparse
def parse_args():
description = usage: %prog [options] poetry-file
This is the Slow Poetry Server, blocking edition.
Run it like this:
python slowpoetry.py
If you are in the base directory of the twisted-intro package,
you could run it like this:
python blocking-server/slowpoetry.py poetry/ecstasy.txt
to serve up John Donne's Ecstasy, which I know you want to do.
parser = argparse.ArgumentParser(description = description)
help = The addresses to connect.
parser.add_argument('addresses',nargs = '*',help = help)
help = The filename to operate on.Default is poetry/ecstasy.txt
parser.add_argument('filename',help=help)
help = The port to listen on. Default to a random available port.
parser.add_argument('-p',--port', type=int, help=help)
help = The interface to listen on. Default is localhost.
parser.add_argument('--iface', help=help, default='localhost')
help = The number of seconds between sending bytes.
parser.add_argument('--delay', type=float, help=help, default=.7)
help = The number of bytes to send at a time.
parser.add_argument('--bytes', type=int, help=help, default=10)
args = parser.parse_args();
return args
if __name__ == '__main__':
args = parse_args()
for address in args.addresses:
print 'The address is : %s .' % address
print 'The filename is : %s .' % args.filename
print 'The port is : %d.' % args.port
print 'The interface is : %s.' % args.iface
print 'The number of seconds between sending bytes : %f'% args.delay
print 'The number of bytes to send at a time : %d.' % args.bytes 出力:
The address is : 127.0.0.1 . The address is : 172.16.55.67 . The filename is : poetry/ecstasy.txt . The port is : 10000. The interface is : localhost. The number of seconds between sending bytes : 1.200000 The number of bytes to send at a time : 10.
# -*- coding: utf-8 -*-
import argparse
args = "-f hello.txt -n 1 2 3 -x 100 -y b -z a -q hello @args.txt i_am_bar -h".split()
# @args.txt fromfile_prefix_chars="@"
# args.txt ， convert_arg_line_to_args()
# ArgumentParser
## description - ， ，
# epilog -
# prog - (default: sys.argv[0]) ， ， ， help ， %(prog)s
# prefix_chars - ， -， -f/--file。 /f ， prefix_chars="/"
# fromfile_prefix_chars - (default: None) ， 。 ， fromfile_prefix_chars='@', "@args.txt"，args.txt
# add_help - -h/-help (default: True)， help ， 。
## parents - list， parser parser ， parents ， parents=[parent_parser]
## formatter_class - （description epilog）。 。
# ：
# class argparse.RawDescriptionHelpFormatter description epilog （ ）
# class argparse.RawTextHelpFormatter description epilog add_argument help （ ）
## class argparse.ArgumentDefaultsHelpFormatter ， 。 ！
# argument_default - (default: None) ， ， ，
# usage - (default: generated) usage （usage: PROG [-h] [--foo [FOO]] bar [bar ...]）， ， 。
# conflict_handler - 。 ， add_argument ， 。
# ##
parser = argparse.ArgumentParser(description="This is a description of %(prog)s", epilog="This is a epilog of %(prog)s", prefix_chars="-+", fromfile_prefix_chars="@", formatter_class=argparse.ArgumentDefaultsHelpFormatter)
# ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
# add_argument 。。。
# name or flags - ， ， ， ， ， "-f", "--file"
# ， ， ，
parser.add_argument("-f", "--file", help="test test test")
# ， "prog i_am_bar"， ，i_am_bar bar ，
parser.add_argument("bar", help="test test test")
# nargs - value ， ， -n 1 2 3 4， n [1, 2, 3, 4]
parser.add_argument("-n", "--num", nargs="+", type=int)
# nargs="+" ， -n ， -n ，+ ,? 0 ,*0 ，
# default - ， default
parser.add_argument("+g", "++gold", help="test test test", default="test_gold")# prefix_chars "+"
# type - （ float, int or file ），
parser.add_argument("-x", type=int)
# choices - ， choices ， type
parser.add_argument("-y", choices=['a', 'b', 'd'])
# required - -f ， required=True
parser.add_argument("-z", choices=['a', 'b', 'd'], required=True)
# metavar - ， .
parser.add_argument("-o", metavar="OOOOOO")
# help -
# dest -
parser.add_argument("-q", dest="world")
args = parser.parse_args(args) # args ， sys.argv， 。 ，
# args.world -q
# action - The basic type of action to be taken when this argument is encountered at the command line.
# const - A constant value required by some action and nargs selections.
# ，
# http://docs.python.org/library/argparse.html
print args