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

liftword2个月前 (03-17)技术文章7

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 函数之参数

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

【Python程序开发系列】一文总结Python函数参数和传递方式

这是我的第217篇原创文章。一、引言函数,在定义的时候,可以有参数的,也可以没有参数。从函数定义的角度来看,参数可以分为两种:必选参数:调用函数时必须要指定的参数,在定义时没有等号可选参数:也叫默认参...

python函数参数详解

python有两种传参的方式,位置参数和关键字参数位置参数位置参数是基于它们的位置或顺序传递给函数的参数。这些参数是必需的,并且必须按照与函数参数列表匹配的正确顺序提供。以下是一个示例:def gre...

如何在运行 Python 脚本文件时传递参数

在 Python 中,可以使用命令行参数为程序传递额外的信息。在操作系统的命令行运行 Python 脚本文件时,文件名称之后添加的参数称为命令行参数。可以根据需要使用这些命令行参数,比如根据不同的参数...

Python教程(25)——Python中参数类型详解

当我们在编写函数时,会定义一些占位符,这些占位符就是参数,参数是函数定义中用于接收外部传递值的占位符,这个会帮助我们在函数被调用时接收外部传递的值。在Python当中,有各种各样类型的参数,主要有位置...