Python argparse教程展示了如何使用argparse模块解析Python中的命令行参数。

文章目录

  • ​​1 使用说明​​
  • ​​1.1 Python argparse可选参数​​
  • ​​1.2 Python argparse必需参数​​
  • ​​1.3 Python argparse位置参数​​
  • ​​1.4 Python argparse dest​​
  • ​​1.5 Python argparse type​​
  • ​​1.6 Python argparse default​​
  • ​​1.7 Python argparse metavar​​
  • ​​1.8 Python argparse append action​​
  • ​​1.9 Python argparse choices​​
  • ​​2 参考​​

1 使用说明

argparse模块使编写用户友好的命令行界面变得容易。它从中解析定义的参数sys.argv。该模块还自动生成帮助和用法消息，并在用户为程序提供无效参数时发出错误。使用ArgumentParser创建分析器，并使用add_argument()添加新参数变量。参数可以是optional（可选）, required（必须）, or positional(位置)。add_argument()中的常用参数设定值如下所示：

  • name or flags，输入参数的名字或者列表，例如 foo 或者 -f, --foo；
  • action，命令行遇到参数时的动作，默认值是 store；
  • store_const，表示赋值为const；
  • append，将输入的值存储成列表，也就是如果参数重复则会保存多个值;
  • append_const，将参数规范中定义的一个值保存到一个列表；
  • count，存储遇到的次数；
  • nargs，应该读取的命令行参数个数；
  • const，action 和 nargs 所需要的常量值；
  • defaul，参数的默认值；
  • type，命令行参数应该被转换成的类型；
  • choices，可用的参数集合；
  • required，该参数为必选输入参数；
  • help，帮助说明；
  • metavar，输入参数的替代名
  • dest，被添加到 parse_args()所返回对象上的属性名；

1.1 Python argparse可选参数

下面的示例创建test1.py，内容为一个简单的参数解析器。add_argument添加参数-o和–out两个参数，参数效果一样，都是可选参数。前一个为参数简写只有一个字母，后一个为全参数。如果输入参数则输出This is some output。还有一个add_argument还有一个固定参数action=‘store_true’，表示命令行遇到参数时的操作，store将参数设为const，默认值是 store。参数用解析parse_args()。解析后的参数作为对象属性存在。

#!/usr/bin/env python

import argparse


parser = argparse.ArgumentParser()

# action 命令行遇到参数时的动作
# -o为短参数，--output长参数
parser.add_argument('-o', '--output', action='store_true', help="shows output")

# parse_args()解析参数
args = parser.parse_args()

# 如果存在output
if args.output:
   print("This is some output")
else:
   print("This is not some output")
# 执行test1.py文件
# 输入--output参数
!python test1.py --output
print('-'*50)
# 输入-o参数
!python test1.py -o
print('-'*50)
# 什么都不输入
!python test1.py
print('-'*50)
# 输入--help参数
!python test1.py --help
!python test1.py -h
This is some output
--------------------------------------------------
This is some output
--------------------------------------------------
This is not some output
--------------------------------------------------
usage: test1.py [-h] [-o]

optional arguments:
  -h, --help    show this help message and exit
  -o, --output  shows output
usage: test1.py [-h] [-o]

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

1.2 Python argparse必需参数

下面的示例创建test2.py，.add_argument()设定required = True，表示必须参数，该示例必须name指定选项。否则失败。

#!/usr/bin/env python

import argparse

# 创建解析器
parser = argparse.ArgumentParser()
# 设置--name为必须参数  
parser.add_argument('--name', required=True)
# 解析参数
args = parser.parse_args()

print('Hello {}'.format(args.name))
# 执行test2.py文件
# 不输入参数
!python test2.py
print('-'*50)
# 输入参数
!python test2.py --name hello
usage: test2.py [-h] --name NAME
test2.py: error: the following arguments are required: --name
--------------------------------------------------
Hello hello

1.3 Python argparse位置参数

下面的示例创建test3.py，位置参数不需要前缀符号，直接输入参数值。

#!/usr/bin/env python

import argparse

# positional args

parser = argparse.ArgumentParser()
   
parser.add_argument('name')
parser.add_argument('age')

args = parser.parse_args()

print('{} is {} years old'.format(args.name,args.age))
!python test3.py -h
print('-'*50)
!python test3.py --name
print('-'*50)
# 输入参数
!python test3.py "jack" 12
usage: test3.py [-h] name age

positional arguments:
  name
  age

optional arguments:
  -h, --help  show this help message and exit
--------------------------------------------------
usage: test3.py [-h] name age
test3.py: error: the following arguments are required: name, age
--------------------------------------------------
jack is 12 years old

1.4 Python argparse dest

dest选项为add_argument()参数指定名称。如果未给出，则从选项中推断出来。下面的示例创建test4.py，将-n的参数名称设定为now。

#!/usr/bin/env python

import argparse

parser = argparse.ArgumentParser()
   
parser.add_argument('-n', dest='now', action='store_true', help="shows now")

args = parser.parse_args()

# -n代表now
if args.now:
   print(args.now)
# 运行文件
!python test4.py -n
True

1.5 Python argparse type

通过type参数确定参数类型。下面的示例创建test5.py。程序显示从-100到100的n个随机整数。

#!/usr/bin/env python

import argparse
import random


parser = argparse.ArgumentParser()

# type确定参数的类型值
parser.add_argument('-n', type=int, required=True, 
    help="define the number of random integers")
args = parser.parse_args()

n = args.n

# 输出随机数
for i in range(n):
    print(random.randint(-100, 100))
# 运行程序
!python test5.py -n 5
34
-81
76
-62
-66

1.6 Python argparse default

default如果未指定该值，则该选项指定默认值。下面的示例创建test6.py。该示例计算指数,不需要指数值；如果未给出，则默认值为2。如果输入参数没有必选参数，可以直接运行代码输出值；如果想在代码内改变值，直接参数复制即可如arg.b=2。

#!/usr/bin/env python

import argparse

parser = argparse.ArgumentParser()
# required设置强制性参数，设置输入参数
parser.add_argument('-b', type=int, required=True, help="defines the base value")
# default设置默认参数，设置指数值
parser.add_argument('-e', type=int, default=2, help="defines the exponent value")
args = parser.parse_args()

val = 1

base = args.b
exp = args.e

for i in range(exp):
    val *= base

print(val)
# 使用 默认参数
!python test6.py -b 2
print('-'*50)
# 给定默认参数
!python test6.py -b 2 -e 3
4
--------------------------------------------------
8

1.7 Python argparse metavar

metavar选项为错误的期望值命名，并提供帮助输出。下面的示例创建test7.py。该示例设置期望值为value。默认名称是v。

#!/usr/bin/env python

import argparse

parser = argparse.ArgumentParser()
   
parser.add_argument('-v', type=int, required=True, metavar='value', 
    help="computes cube for the given value")
args = parser.parse_args()

print(args)

val = args.v

print(val * val * val)
!python test7.py -h
usage: test7.py [-h] -v value

optional arguments:
  -h, --help  show this help message and exit
  -v value    computes cube for the given value

1.8 Python argparse append action

append操作允许对重复选项进行分组。下面的示例创建test8.py。

#!/usr/bin/env python

import argparse

# append action allows to group repeating
# options

parser = argparse.ArgumentParser()
   
parser.add_argument('-n', '--name', dest='names', action='append', 
    help="provides names to greet")

args = parser.parse_args()

names = args.names

# 分组输出
for name in names:
    print('Hello {}!'.format(name))
!python test8.py -n Jack -n Rosy --name Jane
Hello Jack!
Hello Rosy!
Hello Jane!

1.9 Python argparse choices

choices选项将参数限制为给定列表。在示例test9.py中，now选项可以接受以下值：1，2，3。

#!/usr/bin/env python

import argparse
import datetime
import time

parser = argparse.ArgumentParser()

parser.add_argument('--now', dest='format', type=int, choices=[1, 2, 3],help="shows num in given format")

args = parser.parse_args()
fmt = args.format

print(fmt)
# 输入在可选范围内值
!python test9.py --now 1
print('-'*50)
# 输入不在可选范围内值
!python test9.py --now 4
print('-'*50)
# 不输入
!python test9.py
1
--------------------------------------------------
usage: test9.py [-h] [--now {1,2,3}]
test9.py: error: argument --now: invalid choice: 4 (choose from 1, 2, 3)
--------------------------------------------------
None

2 参考