argparse学习笔记

2024-08-02 16:52 由 ChebyshevTST 发表于 #后端开发

argparse是 Python 的一个内置模块，用于编写用户友好的命令行接口。使用 argparse，你可以很容易地为 Python 脚本添加参数解析功能，使得脚本可以接受命令行选项和参数。学起来也比较简单，接下来我会详细讲解。

在argparse里面，有位置参数和可选参数。位置参数是必不可少的，在命令行里面不可以缺少这个选项，并且这个选项前不需要加-或者--一类的符号；可选参数则可有可无，使用的时候需要在选项之前加上-或者--。

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,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity == 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

在这个例子中，首先需要创建一个ArgumentParser的对象，然后可以通过add_argument添加需要的参数。"square"前面没有带-或者--，这是一个位置参数，而且-v或者--verbose则是可选参数。此外，还可以在add_argument当中设定type参数来指定参数的类型。在设定完参数之后，调用parse_args来完成参数的解析，之后就可以愉快地去解析具体参数的值了。

python demo.py 20 -v 1/python demo.py 20 --verbose 1/python demo.py -v 1 20/python demo.py --verbose 1 20
>>20^2 == 400
// 注意，位置参数的位置顺序是可以调换的。

python demo.py 20 -v 2/python demo.py 20 --verbose 2/python demo.py -v 2 20/python demo.py --verbose 2 20
>>the square of 20 equals 400

也可以这样玩。

parser.add_argument("-v", "--verbosity", action='count',
                    help="increase output verbosity")

python demo.py 20 -v/python demo.py 20 -vv

不少Linux的命令行都是可以通过这种方式来输出更加详细的信息，这样就不用手动指定参数了。不过这段代码依然有缺陷，来看看：

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

当我们指定参数-vvv或者-vvvv或者更多的v的时候，反而只能输出一个最简单的计算结果，所以代码的分支条件里面"=="改为">="，这样就大功告成啦。为了更加完美，还可以引入静默模式。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action='store_true',
                    help="increase output verbosity")
parser.add_argument('-q', '--quiet', action='store_true')
args = parser.parse_args()
answer = args.square**2

if args.quiet:
    print(answer)
elif args.verbosity:
    print(f"the square of {args.square} equals {answer}")
else:
    print(f"{args.square}^2 == {answer}")

这样就有模有样了，命令行的基本功能也齐全了。还可以组合参数：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbosity", action='store_true',
                    help="increase output verbosity")
parser.add_argument('-q', '--quiet', action='store_true')
args = parser.parse_args()

if args.verbosity:
    print('v is enabled')
if args.quiet:
    print('q is enabled')

python demo.py -v/python demo.py -q/python demo.py -vq/python demo.py -qv

看到这里的朋友可以点点赞或者分享给身边的朋友，以后会继续带来更多有关C++或者Python语言的有趣知识。