Python argparse 库命令行参数处理详解

argparse 是 Python 标准库中用于处理命令行参数的模块。

命令行参数主要分为两类：位置参数和选项参数。

位置参数是指程序依据参数在命令行中出现的位置来确定其含义的参数。

例如，在命令 [root@openstack_1 /]# ls root/ 中，root/ 即为一个位置参数。

选项参数是应用程序预先定义好的参数，用户不能随意指定名称。

例如，在命令 [root@openstack_1 /]# ls -l 中，-l 是 ls 命令预定义的选项参数。

基本使用示例

import argparse

# 创建解析器
parser = argparse.ArgumentParser(description = 'This is a test')
parser.parse_args()

用户可以在 Shell 环境中进行测试验证。

$ python test.py --help
...

添加参数配置

import argparse

parser = argparse.ArgumentParser(description = 'This is a test')
parser.add_argument("-p","--port",help='increase output port') # 定义了可选参数-p和--port，赋值后，其值保存在args.port中(其值都是保存在最后一个定义的参数中)
args = parser.parse_args()
print(args.echo)

调用 argparse.ArgumentParser() 时，通常只需关注 description 参数，其他参数可根据需要选择。

prog=None：指定程序名称。

description=None：指定在显示帮助信息时开头显示的文字。

epilog=None：指定在显示帮助信息时结尾显示的文字。

parents=[]：若与其他参数配置相同，可通过此参数进行继承。

formatter_class=argparse.HelpFormatter：用于自定义帮助信息的格式。

prefix_chars='-'：指定命令的前缀字符，默认为 '-'。

fromfile_prefix_chars=None：若指定，命令行参数可从文件中读取。

argument_default=None：设置全局选项的默认值，通常建议为每个选项单独设置。

conflict_handler='error'：定义当两个 add_argument 添加的选项名称发生冲突时的处理方式，默认为抛出异常。

add_help=True：是否添加 -h/--help 选项，默认为 True。

add_argument() 方法的参数配置说明如下：

name or flags...：必选参数，用于指定参数的形式，通常建议同时提供短参数和长参数。

实际使用示例如下：

$ python test.py -p 50
或
$ python test.py --port 50

指定参数类型

在添加参数时，可以明确指定其数据类型。

import argparse

parser = argparse.ArgumentParser(description = 'This is a test')
parser.add_argument("square",help="display a given number",type=int) # 指定给square的参数为int类型

可选参数处理

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", help="increase output verbosity")
args = parser.parse_args()
if args.v:
  print("v turned on")

具体使用方式如下：

$ python test.py -v any

官方文档参考

更多应用场景请参阅百度搜索结果或官方文档：https://docs.python.org/3/library/argparse.html#module-argparse

以上内容为本文的全部介绍，希望能为读者的学习提供有益帮助，同时也欢迎大家继续支持本站。