网站建设与优化合同,外贸网站设计多少钱,品牌咨询公司,免费简历在线制作网站argparse库是 Python 标准库中用于解析命令行参数和选项的模块。它使得编写命令行界面#xff08;CLI#xff09;变得更加容易。#xff0c;在深度学习中用到的比较多~~
我们运行Python文件往往是直接输入命令 python test.py 但是如果我们想给Python文件脚本运行时候传入参…argparse库是 Python 标准库中用于解析命令行参数和选项的模块。它使得编写命令行界面CLI变得更加容易。在深度学习中用到的比较多~~
我们运行Python文件往往是直接输入命令 python test.py 但是如果我们想给Python文件脚本运行时候传入参数像是下面这种 python test.py 123 456 -config 该怎么做呢就是要用到argparse库~
将argparse库的基础用法总结如下 文章目录 1 参数的基本类型2 用法2.1 创建参数总容器2.2 添加参数2.3.1 name 添加参数名称2.3.2 type 解析类型2.3.3 参数默认值2.3.4 参数是否必须设置2.3.5 参数提示信息2.3.6 参数动作2.3.7 参数可选值列表2.3.8 参数个数 2.3 解析命令行参数2.4 使用参数 3 完整代码 1 参数的基本类型
在命令行运行 Python 文件时可以向文件传递不同类型的参数。主要有以下几种类型的参数 位置参数Positional arguments位置参数是指在命令行中按照特定顺序传递给程序的参数它们不带任何前缀。例如在命令行中运行 python script.py arg1 arg2arg1 和 arg2 就是位置参数。 选项参数Optional arguments选项参数是可选的参数它们通常以短横线-或双短横线--开头。选项参数可以有一个或多个值。例如-h 或 --help 是常见的用于显示帮助信息的选项参数。 标志参数Flag arguments标志参数是一种特殊的选项参数它们不带值只用于表示某个状态或开关是否打开。通常以短横线和单个字符表示例如 -v 表示 verbose 模式。 环境变量参数Environment variable arguments有时候程序可能会从环境变量中读取参数值。这种方式不需要在命令行中显式传递参数而是通过预先设置的环境变量来传递参数信息。
这些参数可以混合使用例如 python script.py arg1 -v --output result.txt其中 arg1 是位置参数-v 是标志参数--output result.txt 是选项参数表示输出到 result.txt 文件中。
2 用法
2.1 创建参数总容器
import argparse
parserargparse.ArgumentParser()用ArgumentParser类实例化即可创建一个总的容器类parser
之后我们添加参数就是往这个parser里面添加
2.2 添加参数
parser.add_argument(num1, typeint, helpThe first number)
parser.add_argument(num2, typeint, helpThe second number)调用add_argument函数做参数的的添加
add_argument 方法是 argparse.ArgumentParser 类的一个方法用于向解析器添加一个新的参数。add_argument 方法有很多参数
2.3.1 name 添加参数名称
name or flags参数的名称或者选项标志可以是一个字符串位置参数或者一个列表选项参数。例如--output 表示一个长选项-o, --output 表示一个短选项和一个长选项。
2.3.2 type 解析类型
type参数的类型用于指定参数的值应该被解析成什么类型。例如int 表示整数float 表示浮点数默认的话是字符型这时候如果我们期望做数值运算肯定得转换为整形或浮点型
2.3.3 参数默认值
default参数的默认值如果用户没有提供该参数则使用默认值。默认值可以是任何合法的 Python 值。
2.3.4 参数是否必须设置
required指定参数是否是必需的默认为 False。如果设置为 True则用户必须提供该参数否则会显示错误信息。
2.3.5 参数提示信息
help参数的帮助信息用于描述参数的作用和用法。当用户使用 -h 或 --help 选项时会显示帮助信息。
2.3.6 参数动作
action参数的动作指定参数应该如何处理。常用的值包括 store存储参数值、store_true如果存在该参数则存储 True否则存储 False、store_false如果存在该参数则存储 False否则存储 True等。
action 参数用于指定参数在解析时应该如何处理。它定义了当参数在命令行中出现时应该采取的动作。下面是一些常见的 action 参数值及其含义
store默认行为将参数的值存储起来。如果不指定 action则默认为 store。
store_const将一个常量值存储到参数中。通常与 const 参数一起使用。例如
parser.add_argument(--verbose, actionstore_const, constTrue)这会将 --verbose 参数的值设置为 True。
store_true将参数的值设置为 True。通常用于标记某个选项是否存在。例如
parser.add_argument(--verbose, actionstore_true)如果用户在命令行中使用了 --verbose则参数的值为 True否则为 False。
store_false将参数的值设置为 False。与 store_true 类似用于标记某个选项是否不存在。
append将参数值追加到列表中。通常与 nargs 一起使用表示参数可以接受多个值这些值将被追加到一个列表中。
append_const将一个常量值追加到列表中。通常与 const 参数一起使用。
count统计参数出现的次数。用于统计某个选项在命令行中出现的次数。
help显示帮助信息并退出。
2.3.7 参数可选值列表
choices参数的可选值列表用户只能从列表中选择一个值作为参数的值。如果用户提供的值不在列表中则会显示错误信息。
通过使用 add_argument 方法可以灵活地定义各种不同类型的参数并在命令行中解析这些参数从而实现更加复杂的命令行界面。
2.3.8 参数个数 nargs 参数用于指定一个参数应该接受的命令行参数数量。它可以取以下几种值 N表示参数应该接受 N 个命令行参数。 ?表示参数可以接受零个或一个命令行参数。如果没有提供命令行参数则该参数的值为 None。 *表示参数可以接受零个或多个命令行参数。命令行参数会被收集到一个列表中。 表示参数可以接受一个或多个命令行参数。命令行参数会被收集到一个列表中。
例如对于一个参数定义如下
parser.add_argument(--inputs, nargs)这表示 --inputs 参数可以接受一个或多个命令行参数这些参数会被收集到一个列表中。
另一个例子是
parser.add_argument(--output, nargs?, constdefault.txt)这表示 --output 参数可以接受零个或一个命令行参数。如果用户没有提供命令行参数则参数的值将为 default.txt。
2.3 解析命令行参数
添加好后我们进行解析
args parser.parse_args()
#解析命令行参数2.4 使用参数
解析好后我们就可以
直接通过.来使用了
sum args.num1 args.num2
print(fThe sum of {args.num1} and {args.num2} is {sum})
3 完整代码
import argparse# 创建 ArgumentParser 对象
parser argparse.ArgumentParser(descriptionAdd two numbers)# 添加两个参数
parser.add_argument(num1, typeint, helpThe first number)
parser.add_argument(num2, typeint, helpThe second number)# 解析命令行参数
args parser.parse_args()# 计算和并输出结果
sum args.num1 args.num2
print(fThe sum of {args.num1} and {args.num2} is {sum})
运行 python test.py 5 3
