argparse --- 命令行选项、参数和子命令解析器

argparse --- 命令行选项、参数和子命令解析器

官方解释：https://docs.python.org/zh-cn/3/library/argparse.html#argumentparser-objects

官方教程：https://docs.python.org/zh-cn/3/howto/argparse.html#id1

argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

1 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, exit_on_error=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）
allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：True）
exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)

2 add_argument() 方法¶

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() 所返回对象上的属性名。

3 手动构造一个Namespace

mnamespace = argparse.Namespace(agnostic_nms=False, augment=False, classes=None, conf_thres=0.4,
    config_deepsort='deep_sort_pytorch/configs/deep_sort.yaml',
    deep_sort_weights='deep_sort_pytorch/deep_sort/deep/checkpoint/ckpt.t7', device='',
    evaluate=False, fourcc='mp4v', img_size=640, iou_thres=0.5, output='inference/output',
    save_txt=False, save_vid=False, show_vid=False, source='data/1.mp4', yolo_weights='yolov5/weights/yolov5s.pt')

示例

import argparse


if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Run the tracker on your webcam.')
    parser.add_argument('--tracker_name', type=str, help='Name of tracking method.', default="Asd", required=False)
    parser.add_argument('--id', type=str, default="dwqd", required=False)
    args = parser.parse_args()
    print(args)

python test.py --tracker_name=a --id=1

可选参数如果想要赋值，那么必须显示的指定这个参数并赋值。

下面这样隐式的不可以

python test.py a 1