python 系统变量操作argparse/add_argument/parse_args

参考

[官网]

https://docs.python.org/zh-cn/3/library/argparse.html

1概述

argparse

 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 

argparse

 将弄清如何从 

sys.argv

 解析出那些参数。 

argparse

 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

2小例子

以下代码是一个 Python 程序，它获取一个整数列表并计算总和或者最大值：

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))           

3使用

要查看具体参数，请点击参数打开连接。

3.1创建ArgumentParser

https://docs.python.org/zh-cn/3/library/argparse.html#argumentparser-objects

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)

创建一个新的 

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

  ）

在 3.5 版更改: 添加 allow_abbrev 参数。

3.2增加变量add_argument() 方法

https://docs.python.org/zh-cn/3/library/argparse.html#the-add-argument-method

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.2.1 name

xxx：必选参数

-xxx：可选参数

--xxx：别名

3.3解析：parse_args() 方法

https://docs.python.org/zh-cn/3/library/argparse.html#the-parse-args-method

可以直接解析参数 ，或赋值。

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('--foo')
>>> parser.parse_args(['-x', 'X'])
Namespace(foo=None, x='X')