python argparse

API

class argparse.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', add_help=True)

创建一个新的ArgumentParser对象。所有的参数应该以关键字参数传递。下面有对每个参数各自详细的描述，但是简短地讲它们是：

    prog - 程序的名字（默认：sys.argv[0]）
    usage - 描述程序用法的字符串（默认：从解析器的参数生成）
    description - 参数帮助信息之前的文本（默认：空）
    epilog - 参数帮助信息之后的文本（默认：空）
    parents - ArgumentParser 对象的一个列表，这些对象的参数应该包括进去
    formatter_class - 定制化帮助信息的类
    prefix_chars - 可选参数的前缀字符集（默认：‘-‘）
    fromfile_prefix_chars - 额外的参数应该读取的文件的前缀字符集（默认：None）
    argument_default - 参数的全局默认值（默认：None）
    conflict_handler - 解决冲突的可选参数的策略（通常没有必要）
    add_help - 给解析器添加-h/–help 选项（默认：True）

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

定义应该如何解析一个命令行参数。下面每个参数有它们自己详细的描述，简单地讲它们是：

    name or flags - 选项字符串的名字或者列表，例如foo 或者-f, --foo。
    action - 在命令行遇到该参数时采取的基本动作类型。
    nargs - 应该读取的命令行参数数目。
    const - 某些action和nargs选项要求的常数值。
    default - 如果命令行中没有出现该参数时的默认值。
    type - 命令行参数应该被转换成的类型。
    choices - 参数可允许的值的一个容器。
    required - 该命令行选项是否可以省略（只针对可选参数）。
    help - 参数的简短描述。
    metavar - 参数在帮助信息中的名字。
    dest - 给parse_args()返回的对象要添加的属性名称。

示例

#!/usr/bin/env python2.7
# -*- coding: utf-8 -*-

'''
Created on 2016/05/19
File Name:py_test.py
author: LindenTao
Description : test argparse demo
'''
import argparse

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

#!/usr/bin/env python2.7
# -*- coding: utf-8 -*-

'''
Created on 2016/05/19
File Name:py_test.py
author: LindenTao
Description : test argparse demo
'''

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("x", type = int, help = 'the base')
parser.add_argument("y", help = 'the exponent', type = int)
parser.add_argument("-v", "--verbosity", action = "count", default = 0)
args = parser.parse_args()
answer = args.x ** args.y
if 2 <= args.verbosity:
    print "{} to the power {} equals {}".format(args.x, args.y, answer)
elif 1 <= args.verbosity:
    print "{}^{} == {}".format(args.x, args.y, answer)
else:
    print answer

链接

• http://python.usyiyi.cn/python_278/library/argparse.html
• https://docs.python.org/2/howto/argparse.html
• http://blog.ixxoo.me/argparse.html
• http://blog.xiayf.cn/2013/03/30/argparse/