Python Argparse模块详解与应用-优快云博客

本文链接：https://blog.youkuaiyun.com/Lin_RD/article/details/96855319

Argparse是Python的标准库，用于命令行选项、参数和子命令解析。它支持位置参数和可选参数，可以设置参数的数据类型、action、短名称、choices限制以及互斥参数组。通过指定type参数，可以改变默认的字符串类型。action属性可以设定参数行为，例如'help'用于生成帮助信息。短名称可以通过-前缀定义，choices限制输入参数的可选范围，而互斥参数组确保同一组内只能有一个参数被指定。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Argparse是python标准库中的命令行解析模块。

命令行中的调用形式，形如ls命令

ls option
python filename.py option

其中参数分为两种，

一种是位置参数，程序通过命令行中输入的顺序来确定如何操作。
另一种是可选参数，–varname来指定，同时也可以同时支持短命名形式-v。

位置参数是必须的，如果在命令行调用中没有给出相应个数的位置参数，程序就会报错，并且不能像python中参数传递一样使用关键字。
可选参数的输入形式为， --varname val 或者 -v val。当命令行中没有给定可选参数时，解析器默认为其分配None。
所有的输入参数都通过解析器自动存储到对应的变量名下，并且默认为字符串类型，除非为其指定数据类型。

指定数据类型

通过type参数设置，数据类型，否则默认str类型

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
                 	  type=int)
args = parser.parse_args()
print(args.square**2)

action参数

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

help属性用于–help帮助命令时的提示信息。通过action属性，指定该参数的操作，这时命令行中不再接受val，只使用 --verbose, 或者-v。

短名称

–name长名称，-n 短名称。-只用于定义时的标识，存储时仍然存在name变量中。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

chioces限制输入的可选范围

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)

choices限制输入的可选范围

互斥参数组

import argparse

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print("{} to the power {} equals {}".format(args.x, args.y, answer))
else:
    print("{}^{} == {}".format(args.x, args.y, answer))

首先建立互斥组，然后向组中添加互斥参数。在命令行中，每个互斥组至多只能给定一个输入参数，否则报错。

$ python3 prog.py 4 2
4^2 == 16
$ python3 prog.py 4 2 -q
16
$ python3 prog.py 4 2 -v
4 to the power 2 equals 16
$ python3 prog.py 4 2 -vq
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
$ python3 prog.py 4 2 -v --quiet
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose

参考Argparse