Python3 命令行参数

Python 提供了 getopt 模块来获取命令行参数。

$ python test.py arg1 arg2 arg3

Python 中也可以所用 sys 的 sys.argv 来获取命令行参数：

• sys.argv 是命令行参数列表。
• len(sys.argv) 计算命令行参数个数。

注：sys.argv[0] 表示脚本名。

实例

test.py 文件代码如下：

#!/usr/bin/python3 import sys print ('参数个数为:', len(sys.argv), '个参数。') print ('参数列表:', str(sys.argv)) print ('脚本名:', str(sys.argv[0]))

执行以上代码，输出结果为：

$ python3 test.py arg1 arg2 arg3 参数个数为: 4 个参数。 参数列表: ['test.py', 'arg1', 'arg2', 'arg3'] 脚本名: test.py

getopt 模块

getopt 模块是专门处理命令行参数的模块，用于获取命令行选项和参数，也就是 sys.argv。命令行选项使得程序的参数更加灵活。支持短选项模式 - 和长选项模式 --。

该模块提供了两个方法及一个异常处理来解析命令行参数。

getopt.getopt 方法

getopt.getopt 方法用于解析命令行参数列表，语法格式如下：

getopt.getopt(args, options[, long_options])

方法参数说明：

• args: 要解析的命令行参数列表。
• options: 以字符串的格式定义，options 后的冒号 : 表示该选项必须有附加的参数，不带冒号表示该选项不附加参数。
• long_options: 以列表的格式定义，long_options 后的等号 = 表示如果设置该选项，必须有附加的参数，否则就不附加参数。

该方法返回值由两个元素组成: 第一个是 (option, value) 元组的列表。 第二个是参数列表，包含那些没有 - 或 -- 的参数。

短选项模式

接下来我们定义一个 site() 函数，然后通过命令行输入站点名称 name 和网址 url，可以用缩写 n 和 u:

import sys import getopt def site(): name = None url = None argv = sys.argv[1:] try: opts, args = getopt.getopt(argv, "n:u:") # 短选项模式 except: print("Error") for opt, arg in opts: if opt in ['-n']: name = arg elif opt in ['-u']: url = arg print( name +" " + url) site()

测试以上代码，命令行中输入：

python3 test.py -n csdn -u blog.csdn.net

输出结果为：

csdn blog.csdn.net

长选项模式

以下实例演示长选项模式的使用：

mport sys import getopt def site(): name = None url = None argv = sys.argv[1:] try: opts, args = getopt.getopt(argv, "n:u:", ["name=", "url="]) # 长选项模式 except: print("Error") for opt, arg in opts: if opt in ['-n', '--name']: name = arg elif opt in ['-u', '--url']: url = arg print( name + " " + url) site()

测试以上代码，命令行中输入：

python3 test.py -n csdn -u blog.csdn.net

输出结果为：

csdn blog.csdn.net

另外一个方法是 getopt.gnu_getopt，用到的情况比较少，这里不多做介绍。

---

Exception getopt.GetoptError异常处理

在没有找到参数列表，或选项的需要的参数为空时会触发该异常。

异常的参数是一个字符串，表示错误的原因。属性 msg 和 opt 为相关选项的错误信息。

实例

假定我们创建这样一个脚本，可以通过命令行向脚本文件传递两个文件名，同时我们通过另外一个选项查看脚本的使用。脚本使用方法如下：

usage: test.py -i <inputfile> -o <outputfile>

test.py 文件代码如下所示：

#!/usr/bin/python3 import sys, getopt def main(argv): inputfile = '' outputfile = '' try: opts, args = getopt.getopt(argv,"hi:o:",["ifile=","ofile="]) except getopt.GetoptError: print ('test.py -i <inputfile> -o <outputfile>') sys.exit(2) for opt, arg in opts: if opt == '-h': print ('test.py -i <inputfile> -o <outputfile>') sys.exit() elif opt in ("-i", "--ifile"): inputfile = arg elif opt in ("-o", "--ofile"): outputfile = arg print ('输入的文件为：', inputfile) print ('输出的文件为：', outputfile) if __name__ == "__main__": main(sys.argv[1:])

执行以上代码，输出结果为：

$ python3 test.py -h usage: test.py -i <inputfile> -o <outputfile> $ python3 test.py -i inputfile -o outputfile 输入的文件为： inputfile 输出的文件为： outputfile

---

getopt 官方文档解释：

语法

getopt.getopt(args, shortopts, longopts=[])

三个参数：

• args: 这个很清楚，就是参数列表。直接把 sys.args[1:] 切片传进来就可以。
• shortopts: 这个参数是个字符串，把需要解析的“短选项”挨着写在一起就可以，这里的“短选项”指的是以 '-' 开头的选项，叫短选项是因为这种选项只支持单个字母，就算你写 -test 这样子的参数，能被 getopt 识别出来的也是 -t 和 est，其中 est 会被当作 -t 选项的参数。所以假设你想支持 “-h -i -o” 三个短选项， shortopts 就可以写成 “hio”。如果其中某个短选项想要接受参数，比如 "-h -i inputfile -o outputfile"，那就需要在字母后面加 ":" 冒号，变成 "hi:o"
• longopts=[]: 这个参数是个列表，因为每个长选项有多个字母，不可能像短选项一样用一个字符串就都表示出来。所谓长选项，就是以 “--” 开头的选项，比如 --usr --ifile --ofile 等，传参的时候写成 ['--user', '--ifile', '--ofile']，如果某个选项需要接受参数，则在后面加 "=" 等号，比如 ['--user', '--ifile=', '--ofile=']。

返回值，有两个：

• opts：是有一个列表，列表里是元组（opt, value）的格式。比如上面的 "-h -i inputfile -o outputfile" 那就是 [('-h', ''), ('-i', 'inputfile'), ('-o', 'outputfile')] 这样的返回值。长选项和短选项以及各自的参数都会按先后次序放在这里。用的时候可以以 for opt,val in opts: 这样的方式来遍历。值得注意的是，返回的 opt 里面，'-' 和 '--' 都被保留下来了，另外，当用户输入的长选项没有写完的时候，会被自动补全。比如用户输入的是 --u，通过 getopt 会被自动补全成 --user，这个需要注意（除非有两个长选项都有相同的开头，无法确定是哪个）。
• args：如果用户输入的信息太多，除了长选项和短选项以及各自选项的参数以外，还有一些其它的未知的参数，则会被放到这里。