argparse是一个Python模块，用来解析命令行参数，主要有三个步骤：
1、创建 ArgumentParser() 对象
2、调用 add_argument() 方法添加参数
3、使用 parse_args() 解析添加的参数
一、创建解析器
代码示例：
parser = argparse.ArgumentParser('DETR training and evaluation script', parents=[get_args_parser()])def get_args_parser():
parser = argparse.ArgumentParser('Set transformer detector', add_help=False)
parser.add_argument('--lr', default=1e-4, type=float)
parser.add_argument('--lr_backbone', default=1e-5, type=float)
parser.add_argument('--batch_size', default=4, type=int)
parser.add_argument('--weight_decay', default=1e-4, type=float)
parser.add_argument('--epochs', default=300, type=int)
parser.add_argument('--lr_drop', default=200, type=int)
parser.add_argument('--clip_max_norm', default=0.1, type=float,
help='gradient clipping max norm')
return parser使用 argparse 的第一步是创建一个 ArgumentParser 对象。
ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。
ArgumentParser 对象
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, allow_abbrev=True)
对象中的成员：
- (常用)prog - 程序的名称（默认：sys.argv[0]）
如代码示例所示是 DETR training and evaluation script
- usage - 描述程序用途的字符串（默认值：None）
如代码示例：usage: DETR training and evaluation script [-h] [--lr LR]
[--lr_backbone LR_BACKBONE]
[--batch_size BATCH_SIZE]
[--weight_decay WEIGHT_DECAY]
[--epochs EPOCHS]
[--lr_drop LR_DROP]
[--clip_max_norm CLIP_MAX_NORM]
- 如代码示例(常用)description - 在参数帮助文档之前显示的文本（默认值：None）
- epilog - 在参数帮助文档之后显示的文本（默认值：None）
>>> parser = argparse.ArgumentParser(
... description='A foo that bars',
... epilog="And that's how you'd foo a bar")
>>> parser.print_help()#打印帮助文档
usage: argparse.py [-h]
A foo that bars
options:
-h, --help show this help message and exit
And that's how you'd foo a bar
- (常用)parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内，有些时候，少数解析器会使用同一系列参数。 单个解析器能够通过提供
parents=参数给 ArgumentParser 而使用相同的参数而不是重复这些参数的定义。parents=参数使用 ArgumentParser 对象的列表，从它们那里收集所有的位置和可选的行为，然后将这写行为加到正在构建的 ArgumentParser 对象。
如代码示例所示，parents列表里有一个ArgumentParser 对象是get_args_parser()返回的parser。 - formatter_class - 用于自定义帮助文档的输出格式，例如自动换行等
- prefix_chars - 可选参数的前缀字符集合（默认值：’-’），可更改为+/++等
- fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值：None），从文件读取的参数在默认情况下必须一个一行
例如：
with open('args.txt', 'w') as fp:
fp.write('-f\nbar')
parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
parser.add_argument('-f')
parser.parse_args(['-f', 'foo', '@args.txt'])
- argument_default - 参数的全局默认值（默认值： None）
- conflict_handler - 解决冲突选项的策略（通常是不必要的）
- add_help - 是否为解析器添加一个 -h/–help 选项（默认值： True）如果
-hor--help在命令行中被提供, 参数解析器帮助信息会打印:
$ python myprogram.py --help usage: myprogram.py [-h] [--foo FOO] options: -h, --help show this help message and exit --foo FOO foo help
二、添加参数
对象创建好后，需要用add_argument()给它添加参数。
add_argument() 方法
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
- name or flags - 一个命名或者一个选项字符串的列表，例如
foo或-f, --foo。选项会以-前缀识别。剩下的参数则会被假定为命名的赋值，命名在命令行赋值不需要标识。
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args(['BAR'])
Namespace(bar='BAR', foo=None)
>>> parser.parse_args(['BAR', '--foo', 'FOO'])
Namespace(bar='BAR', foo='FOO')- action - 当参数在命令行中出现时使用的动作基本类型。
'store'- 存储参数的值。这是默认的动作。'store_const'- 存储被 const 命名参数指定的值。'store_true'and'store_false'- 这些是'store_const'分别用作存储True和False值的特殊用例。另外，它们的默认值分别为False和True。'append'- 存储一个列表，并且将每个参数值追加到列表中。在允许多次使用选项时很有用。'count'- 计算一个关键字参数出现的数目或次数。
-
nargs - 命令行参数应当消耗的数目。
>>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs=2) >>> parser.add_argument('bar', nargs=1) >>> parser.parse_args('c --foo a b'.split()) Namespace(bar=['c'], foo=['a', 'b']) >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs='*') >>> parser.add_argument('--bar', nargs='*') >>> parser.add_argument('baz', nargs='*') >>> parser.parse_args('a b --foo x y --bar 1 2'.split()) Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y']) -
default - 当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值。
>>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default=42) >>> parser.parse_args(['--foo', '2']) Namespace(foo='2') >>> parser.parse_args([]) Namespace(foo=42) -
type - 命令行参数应当被转换成的类型。
-
choices - 可用的参数的容器。
-
required - 此命令行选项是否可省略 （仅选项可用）。
通常，argparse 模块会认为-f和--bar等旗标是指明 可选的 参数，它们总是可以在命令行中被忽略。 要让一个选项成为 必需的，则可以将required = True -
help - 一个此选项作用的简单描述。
-
metavar - 在使用方法消息中使用的参数值示例。
-
dest - 被添加到 parse_args() 所返回对象上的属性名。
代码示例：
def get_args_parser():
parser = argparse.ArgumentParser('Set transformer detector', add_help=False)
parser.add_argument('--lr', default=1e-4, type=float)
parser.add_argument('--lr_backbone', default=1e-5, type=float)
parser.add_argument('--batch_size', default=4, type=int)
parser.add_argument('--weight_decay', default=1e-4, type=float)
parser.add_argument('--epochs', default=300, type=int)
parser.add_argument('--lr_drop', default=200, type=int)
parser.add_argument('--clip_max_norm', default=0.1, type=float,
help='gradient clipping max norm')
return parser三、解析参数
选项和命名添加后，用parse_args()方法解析参数来对他们赋值
parse_args()方法
ArgumentParser.parse_args(args=None, namespace=None)parse_args() 方法支持多种指定选项值的方式（如果它接受选项的话）。 在最简单的情况下，选项和它的值是作为两个单独参数传入的:
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('--foo')
>>> parser.parse_args(['-x', 'X'])
Namespace(foo=None, x='X')
>>> parser.parse_args(['--foo', 'FOO'])
Namespace(foo='FOO', x=None)
6330
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
