【python】python中的argparse模块，教你如何自定义命令行参数

在这里插入图片描述

✨✨ 欢迎大家来到景天科技苑✨✨

🎈🎈 养成好习惯，先赞后看哦~🎈🎈

🏆 作者简介：景天科技苑
🏆《头衔》：大厂架构师，华为云开发者社区专家博主，阿里云开发者社区专家博主，CSDN全栈领域优质创作者，掘金优秀博主，51CTO博客专家等。
🏆《博客》：Python全栈，前后端开发，小程序开发，人工智能，js逆向，App逆向，网络系统安全，数据分析，Django，fastapi，flask等框架，linux，shell脚本等实操经验，网站搭建，数据库等分享。

所属的专栏：python入门必备，基础语法到进阶实战教学
景天的主页：景天科技苑

文章目录

一、argparse模块简介
- 1.argparse定义的四个步骤
- 2. 用法举例
二、相关方法的参数详解
- 1.add_argument() 方法
- 2. 解析命令行的参数：parse_args()

一、argparse模块简介

python中的argparse模块，是 Python内置的用于命令项选项与参数解析的模块，argparse 模块可以让人轻松编写用户友好的命令行接口，用于命令行参数的解析，能够帮助程序员为模型定义参数
这意味着我们无需在代码中手动为变量赋值，而是可以直接在命令行中向程序传递相应的参数，再由变量去读取这些参数。

1.argparse定义的四个步骤

导入argparse包 ——import argparse
创建一个命令行解析器对象 ——创建 ArgumentParser() 对象
给解析器添加命令行参数 ——调用add_argument() 方法添加参数
解析命令行的参数 ——使用 parse_args() 解析添加的参数

2. 用法举例

# 导入库
import argparse

# 1. 定义命令行解析器对象
parser = argparse.ArgumentParser(description='Usage of argparse')

# 2. 添加命令行参数,可以简写，也可以写全称
parser.add_argument('-u','--username', type=str, default="jingtian")
parser.add_argument('-p','--password', type=str, default="123456")

# 3. 从命令行中结构化解析参数
args = parser.parse_args()
print(args)

#通过args对象.参数名，获取命令行参数值
username = args.username
pwd = args.password
print(f"解析出的参数,用户名:{username},密码:{pwd}")

我们定义了两个命令行参数 --username --password 。都有str类型的默认值
在这里插入图片描述

我们用朴实无华的大白话对上面代码进行解读，首先我们导入argparse这个包，然后包中的ArgumentParser类生成一个parser对象（其中的description对参数解析器的作用进行描述）
当我们在命令行显示帮助信息的时候会看到description描述的信息。
例如：python myargparse.py -h
在这里插入图片描述

接下来我们通过对象的add_argument函数来增加参数。
这里我们增加了username和password两个参数，最后采用对象的parse_args获取解析的参数。
命令行我们可以自己指定参数值，打印结果如下图所示：
如果不加参数，则使用我们设置的默认值
./myargparse.py
在这里插入图片描述

我们也可以在命令行自定义
./myargparse.py -u tianya -p 123
在这里插入图片描述

二、相关方法的参数详解

1.add_argument() 方法

（1）添加命令行参数
给一个 ArgumentParser 添加程序参数信息，是通过调用 add_argument() 方法完成的。通常，这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。
这些信息在 parse_args() 调用时被存储在ArgumentParser实例化对象中，以供后续使用。add_argument() 方法定义如何解析命令行参数的呢？

（2）add_argument() 方法定义如何解析命令行参数
parser.add_argument(name or flags…[, action][, nargs][, const][, default][, type][,choices][, required][, help][, metavar][, dest])

参数详解:

name or flags: 普通参数或flag参数选项参数的名称或标签，例如 username 或者 -u, --username。Flag参数不需要指定参数值，只需要带有参数名即可。
action: 命令行遇到flags参数时的动作。有两个常见的动作，store_true：设定flag参数为true；store_false：设定flag参数为False。注意：如果直接运行程序，默认不读取该变量，要使用必须要进行传参，例如：python myargparse.py --username
nargs: 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
default: 不指定参数时该参数的默认值。
type: 命令行参数应该被转换成的数据类型。
required: 是否为必选参数或可选参数。
help: 参数的帮助信息。
metavar： 在 usage 说明中的参数名称，对于必选参数，默认就是参数名称，对于可选参数默认是全大写的参数名称。
dest： 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.
choices： 参数可允许的值的一个容器。
const： action 和 nargs 所需要的常量值。
store_const：表示赋值为const；
append：将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
append_const：将参数规范中定义的一个值保存到一个列表；
count：存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；