欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Python3命令行参数之getopt模块详解

程序员文章站 2024-01-30 20:01:52
文章目录简介参数返回值opts和args调用问题内建模块,用于解析带参数和选项的程序。官方介绍地址: https://docs.python.org/3.1/library/getopt.html简介具体文档请查看:print(getopt.__doc__)参数这个模块一共有两个函数,两个属性:函数:getopt.getoptgetopt.gnu_getopt属性:getopt.errorgetopt.GetoptError这两个属性主要是用来抛出错误信息的,非常友好...

内建模块,用于解析带参数和选项的程序。
官方介绍地址: https://docs.python.org/3.1/library/getopt.html

简介

具体文档请查看:

print(getopt.__doc__)

参数

这个模块一共有两个函数,两个属性:
函数:

  • getopt.getopt
  • getopt.gnu_getopt

属性:

  • getopt.error
  • getopt.GetoptError
    这两个属性主要是用来抛出错误信息的,非常友好不是吗?

我们主要经常使用getopt这个函数:

getopt.getopt(args, shortopts, longopts=[])
args指的是当前脚本接收的参数,它是一个列表,可以通过sys.argv[1:]获得
shortopts 是短参数,类似于:python test.py -h # 输出帮助信息
longopts  是长参数,类似于:python test.py -help # 输出帮助信息

返回值

这个函数返回一个元组,里面有两个元素,第一个是options的键值对列表,即输入的选项;第二个是args的列表,即输入的参数。具体说明请参看官方文档。

opts和args

opts 为分析出的格式信息。args 为不属于格式信息的剩余的命令行参数。

import getopt
import sys

ret = getopt.getopt(sys.argv[1:],'-h',['help'])
print(ret)

结果如下:

λ python test.py -h
([('-h', '')], [])
λ python dev1.py --help
([('--help', '')], [])
λ python dev1.py --help abc123
([('--help', '')], ['abc123'])

可以看到已经接收了参数。并且做了处理,为什么要传入sys.argv[1:]?

因为sys.argv里的argv[0]是当前脚本的文件名,不需要它去参与。

这个是参数+参数值的例子:

#!/usr/bin/env python
import getopt
import sys

opts,args = getopt.getopt(sys.argv[1:],'hf:v',['help','filename=','version'])
for opt_name,opt_value in opts:
    if opt_name in ('-h','--help'):
        print("[*] Help info")
    if opt_name in ('-v','--version'):
        print("[*] Version is 0.01 ")
    if opt_name in ('-f','--filename'):
        fileName = opt_value
        print("[*] Filename is ",fileName)
        # do something
exit()

运行测试结果如下:

λ python dev1.py --file=test.txt
[*] Filename is  test.txt
λ python dev1.py --file=
[*] Filename is
λ python dev1.py -f test.txt
[*] Filename is  test.txt
λ python dev1.py -hv
[*] Help info
[*] Version is 0.01

来详细解释一下这几行代码:
首先从短参数名开始。
定义了'hf:v',f后的:代表了f参数是有值的,是一个参数名+参数值的参数。
长参数名的方式和短参数差不多,唯一的区别就是长参数如果要接收值,那必须得在后面加上一个=

调用问题

  • 短参数使用的时候是-参数名[空格]参数值
  • 长参数使用的时候是参数名=参数值
  • 短参数可以连起来用,如-hv

本文地址:https://blog.csdn.net/al_888/article/details/107167525