通过getopt模块中的getopt( )方法,我们可以获取和解析命令行传入的参数
一、函数用法
-
getopt(args, shortopts, longopts=[ ])
- args:固定写法sys.argv[1:]
- shortopts:短参
- 字符串类型,限制命令行可传入的短参名称(命令行可不传参,如果传参,必须是指定的参数名,否则会报错)
- 参数名必须为单字符,前面使用单短横线(-)
- 命令行写法:
- -a 不带参数值形式
- -b test_b 带参数值形式(中间空格可省略,个人推荐带上空格,更容易区分)
- -c 'test c' 参数值含空格,需要使用引号
- 按照上述命令行写法,shortopts的写法可以是:'ab:c:'
- 如果带参数值,则需要在参数名后面带上':'
- 各参数名先后顺序无所谓,比如'b:ac:'
- longopts:长参
- 数组类型,元素为字符串,限制命令行可传入的长参名称(命令行可不传参)
- 参数名前使用双短横线(--)
- 命令行写法:
- --aa 不带参数值形式
- --bb=test_bb 带参数值形式
- --cc='test cc' 带参数值形式,参数值含空格,需要使用引号
- 按上述命令行写法,longopts写法可以是:['aa', 'bb=', 'cc=']
- 如果带参数值,则需要在参数名后面带上'='
- 各参数名先后顺序无所谓
二、示例
-
代码
#! /usr/bin/env python # -*- coding: utf-8 -*- import sys from getopt import getopt opts, args = getopt(sys.argv[1:], 'ab:', ['aa', 'bb=']) # 解析出的参数名和值,格式:[(参数1,参数值1), (参数2,参数值2)...] print(f'opts: {opts}') # 未解析出来的参数值部分 print(f'args: {args}')
-
命令行
python main.py -a -b 'test short_b' --aa --bb=long_bb xxxx
输出:
opts: [('-a', ''), ('-b', 'test short_b'), ('--aa', ''), ('--bb', 'long_bb')] args: ['xxxx']
对于没有参数值的a和aa参数,解析出的参数值都为空字符串'',由于bb参数的参数值long_bb和xxxx之间有空格,所以未解析出
-
命令行
python main.py -b=test_b
输出:
opts: [('-b', '=test_b')] args: []
参数可传,也可省略,如果传,则必须是代码中所指定的