Python 中 使用 Argparse 解析命令行参数

liftword3个月前 (03-17)技术文章15

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 脚本,创建直观且强大的命令行界面。

相关文章

Python 函数参数

1.函数基本参数#基本样例 函数参数的定义要和调用参数匹配,否则会报错 def fun01(a, b): print(a, b) if __name__ == '__main__':...

Python基础 - 函数的位置参数、关键字参数、默认参数

在 Python 中,调用函数可以按照函数的位置传递参数(位置参数),也可以按照参数的名称传递参数(关键字参数),函数的参数还可以在定义的时候指定默认值(默认参数)。此外,Python 还支持可变参数...

python之函数的参数详解

参数传递:1.不可变数据类型:数字number(含int、float、bool、complex)、字符串string、元组tuple。当不可变数据类型被当作函数的参数,传递的是值,函数体内改变值时实际...

真相!Python 默认值参数深度解析,从踩坑到精通的进阶秘籍

一、开发中遇到的问题问题 1:默认值参数为可变对象的陷阱在 Python 开发里,不少初学者会在默认值参数为可变对象时踩坑。比如,我们想定义一个函数,用于向列表中添加元素,代码如下:def add_t...

Python 函数之参数

定义一个函数非常简单,但是怎么定义一个函数,需要什么参数,怎么去调用却是我们需要去思考的问题。如同大多数语言一样(如 Java),Python 也提供了多种参数的设定(如:默认值参数、关键字参数、形参...

Python命令行参数解析模块argparse

前言以前 optparse 比较火,但是在python2.7版本后,官方不再维护这个模块,转而大力支持 argparse 。argparse 模块可以让人轻松编写用户友好的命令行接口。她可以从 sys...