Python 中 使用 Argparse 解析命令行参数
Argparse 模块是 Python 的标准库,提供了一种解析命令行参数的简单方法,可以轻松定义和解析命令行参数。在本文中,我们将探讨如何在 Python 3 中使用 argparse 将传递命令行参数。
简单的 Argparse 示例
import argparse
parser = argparse.ArgumentParser(description='一个简单的 argparse 命令行参数示例')
parser.add_argument('name', help='输入用户名')
args = parser.parse_args()
print(f"Hello, {args.name}!")
以上代码,使用 ArgumentParser() 创建新的 ArgumentParser 对象。使用 add_argument() 添加基本参数,第一个参数是命令行参数的名称。help 参数提供了参数的简要描述。
可以使用以下命令运行:
PS C:\> python 1.py kitty
Hello, kitty!
当只用 -h 或 --help 参数运行程序时,将显示描述内容。
PS C:\> python 1.py -h
usage: 1.py [-h] name
一个简单的 argparse 命令行参数示例
positional arguments:
name 输入用户名
options:
-h, --help show this help message and exit
可选参数
上面示例中的参数 name 属于位置参数,是最基本的参数类型。是必需的,并且以正确的顺序在命令中使用。可选参数不是必需的,通常以一个或两个短划线- --开头。
import argparse
parser = argparse.ArgumentParser(description='一个简单的 argparse 命令行参数示例')
parser.add_argument('name', help='输入用户名')
parser.add_argument('-w', '--welcome', help='欢迎语', default="Hello")
args = parser.parse_args()
print(f"{args.welcome}, {args.name}!")
PS C:\> python 1.py kitty --welcome hi
hi, kitty!
PS C:\> python 1.py kitty
Hello, kitty!
PS C:\> python 1.py kitty -w hi
上面示例中的参数 welcome 是可选参数,如果省略,使用 default 指定的默认值。
参数类型
默认情况下,所有参数都被视为字符串,也可以指定所需的参数类型。
import argparse
parser = argparse.ArgumentParser(description='会员打折')
parser.add_argument('quantity', type=int, help='数量')
parser.add_argument('price', type=float, help='价格')
parser.add_argument('--vip', type=bool, help='会员', default=False)
args = parser.parse_args()
total_amount = args.quantity * args.price
vip_amount = args.quantity * args.price * 0.8
if args.vip:
print(f"会员价:{vip_amount:.2f}")
else:
print(f"价格:{total_amount:.2f}")
PS C:\> python 1.py 10 6.6
价格:66.00
PS C:\> python 1.py 10 6.6 --vip true
会员价:52.80
一个参数传递多个值
nargs 参数设置为 + ,指示可以为此参数传递多个值。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--numbers', nargs='+', type=int, help='List of numbers')
args = parser.parse_args()
print(args.numbers)
PS C:\> python 1.py --numbers 1 2 3 4 5 6
[1, 2, 3, 4, 5, 6]
限制参数值的选择
可以使用选项 choices 限制参数的可能值。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--gender', choices=["Male", "Female"])
args = parser.parse_args()
print(args.gender)
PS C:\> python 1.py --gender Male
Male
PS C:\> python 1.py --gender Female
Female
PS C:\> python 1.py --gender abc
usage: 1.py [-h] [--gender {Male,Female}]
1.py: error: argument --gender: invalid choice: 'abc' (choose from 'Male', 'Female')
以上介绍了 Argparse 模块的基本使用方法,Argparse 还有更多高级功能,可以编写专业、用户友好的 Python 脚本,创建直观且强大的命令行界面。