argparse模块的位置参数和可选(必选)参数

2019年11月26日 / 8次阅读 / Last Modified 2019年11月26日

argparse是python标准库中提供的用来解析命令行参数的模块,非常强大!在深入学习argparse模块之前,需要先搞清楚命令行位置参数和可选参数的概念。

位置参数

基于位置的参数,参数的出现不需要前缀(以 - 或 -- 开头的),而且是必须配置的参数。定义argparse模块的位置参数,参数名称不要有前缀(- 或 --),argparse模块使用这个前缀来判断是位置参数,还是可选参数。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('echo')
args = parser.parse_args()
print(args.echo)

这个代码定义了一个位置参数echo,由于是必须出现的位置参数,程序后面在打印echo参数的值的时候,不需要判断是否配置了这个参数。因为如果没有配置,parser.parse_args()这个函数就会报错。

$ python3 arg.py
usage: arg.py [-h] echo
arg.py: error: the following arguments are required: echo
$ python3 arg.py abcde
abcde
$ python3 arg.py 'abcde 12345'
abcde 12345
$ python3 arg.py -h
usage: arg.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit

如果参数中有空格,参数需要使用引号括起来。

位置参数在命令行中的出现和配置顺序,与代码中参数的定义顺序是对应的。如果定义了多个位置参数,命令行输入参数的时候,顺序要与多个参数的定位顺序保持一致

位置参数在命令使用时,直接输入参数。

可选(必选)参数

凡是用 - 或者 -- 开头定义的命令行参数,都属于可选参数。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-s','--sn')
args = parser.parse_args()
if args.sn: print(args.sn)
else: print('no argument')

这里有一个约定俗成的惯例:单个字母只是用一个 - ,多个字母使用两个 - (--)。python也支持一个 - 后面跟多个字母,不过看起来有关怪异。上面的定义 -s 显然是 --sn 的简写。(Linux命令行参数风格

我们也可以只定义 -s 简写,或者之定义 --sn 这种,代码直接去掉一个参数即可。在两者都有的情况下,后面的代码引用参数的值,需要使用 -- 后面的那个词。

$ python3 arg.py
no argument
$ python3 arg.py -s 123
123
$ python3 arg.py --sn abc
abc

其实,可选参数也可以变成必选参数!必选参数跟位置参数还不一样,必选参数的位置可以比较灵活。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-s', required=True)
parser.add_argument('-e','--echo')
args = parser.parse_args()
if args.s: print(args.s)
if args.echo: print(args.echo)

这段代码 -s 参数是必须参数,但是它出现的位置是灵活的。

$ python3 arg.py -h
usage: arg.py [-h] -s S [-e ECHO]

optional arguments:
  -h, --help            show this help message and exit
  -s S
  -e ECHO, --echo ECHO
$ python3 arg.py -s 123
123
$ python3 arg.py -s 123 -e abc
123
abc
$ python3 arg.py -e abc
usage: arg.py [-h] -s S [-e ECHO]
arg.py: error: the following arguments are required: -s
$ python3 arg.py -e abc -s 123
123
abc

-e 和 -s 出现的位置可以调换,而且 -s 必须要有。

由可选参数变化而来的必选参数,有的时候比位置固定的参数更好用。就是因为它必须出现,而且位置灵活。位置参数的位置是固定的。argparse模块功能非常强大,几乎你需要的关于命令行参数解析的功能,它都能提供。本文只是蜻蜓点水,仅仅介绍两个基本概念。

-- EOF --

本文链接:https://www.pynote.net/archives/1562

相关文章

    留言区

    《argparse模块的位置参数和可选(必选)参数》有1条留言

    电子邮件地址不会被公开。 必填项已用*标注

    • 麦新杰

      使用required=True,可选参数就变成了位置可变的必选参数。 [回复]


    前一篇:
    后一篇:

    More

    麦新杰的Python笔记

    Ctrl+D 收藏本页


    ©Copyright 麦新杰 Since 2019 Python笔记

    go to top