← Python 字典( Dictionary ) items() 方法 Python os.lchown() 方法 →

Python 3 命令行参数

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

有时候我们运行 Python 脚本时需要向脚本传递一些参数，比如

$ python main.py "Hello" "World" "Nice to meet you"

Python 获取命令行传递的参数有很多方法，我们这里只介绍两种

1. 使用 sys 模块的 sys.argv 属性来获取命令行参数

sys.argv 属性返回的是命令行参数列表

其中 sys.argv[0] 表示脚本名

可以通过 len(sys.argv) 是获得命令行参数个数

下面的代码使用 sys.argv 输出所有的命令行参数

    # file: main.py

import sys

print ( '参数个数为:', len(sys.argv), '个参数' )
print ( '参数列表:', str(sys.argv))

运行以上代码，输出结果如下

$ python main.py "Hello" "World" "Nice to meet you"
参数个数为: 4 个参数
参数列表: ['main.py', 'Hello', 'World', 'Nice to meet you']

2. getopt 模块

getopt 模块是专门处理命令行参数的模块，用于获取命令行选项和参数

getopt 模块支持短选项模式 (-) 和长选项模式 ( -- )

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

getopt.getopt() 函数

getopt.getopt() 函数用于解析命令行参数列表

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

参数说明

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

返回值

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

Exception getopt.GetoptError

getopt.getopt() 函数如果没有找到参数列表，或选项的需要的参数为空时会触发该异常

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

范例

我们创建一个范例，这个范例可以通过命令行向脚本文件传递两个文件名，同时我们通过另外一个选项查看脚本的使用

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

main.py

#!/usr/bin/python

import sys, getopt

def main(argv):
   inputfile = ''
   outputfile = ''
   try:
      opts, args = getopt.getopt(argv,"hi:o:",["ifile=","ofile="])
   except getopt.GetoptError:
      print ( 'main.py -i <inputfile> -o <outputfile>' )
      sys.exit(2)
   for opt, arg in opts:
      if opt == '-h':
         print ( 'main.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:])

运行以上 Python 代码，输出结果如下

$ python main.py -h
usage: main.py -i <inputfile> -o <outputfile>

$ python main.py -i inputfile -o outputfile
输入的文件为： inputfile
输出的文件为： outputfile

返回上一级