getopt模块的使用

对于tensorflow而言有单独的tf.flag用法

一、什么是命令行参数？

在shell等运行脚本时，可以在运行.py文件后跟上一部分参数供脚本使用，例如一个文件处理程序test.py，可以将需要处理的文件路径写入命令行参数中，每次使用时在命令行输入

python test.py -'home/workplace/data.doc'

即可运行程序处理data.doc文件，增加程序通用性

二、使用命令行参数步骤

分为两个步骤：
1.取得命令行参数
2.对命令行参数进行分析

1. 取得命令行参数

在使用之前，首先要取得命令行参数。使用sys模块可以得到命令行参数。
例：一个get.py文件如下：

import sys
print sys.argv

在shell命令行输入

python get.py -o t --help cmd file1 file2

运行结果打印

['get.py', '-o', 't', '--help', 'cmd', 'file1', 'file2']

可见，所有命令行参数以空格为分隔符，都保存在了sys.argv列表中。其中第1个为脚本的文件名。

  • 选项的写法要求
    对于短格式，"-"号后面要紧跟一个选项字母。如果还有此选项的附加参数，可以用空格分开，也可以不分开。长度任意，可以用引号。
  • 以下是正确的：
-o
-oa
-obbbb
-o bbbb
-o "a b"

对于长格式，"–“号后面要跟一个单词。如果还有些选项的附加参数，后面要紧跟”="，再加上参数。"="号前后不能有空格。如以下是正确的：

--help=file1
  • 这些是不正确的：
-- help=file1
--help =file1
--help = file1
--help= file1
2. 如何使用命令行参数进行分析

例如模块test1.py:

import getopt, sys

opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])#"ho:"也可以写成'-h-o:'
print（opts）
print(args)

用上面解释的一个命令行例子运行：

python test1.py -h -o file --help --output=out file1 file2

opts的输出结果为：

[('-h', ''), ('-o', 'file'), ('--help', ''), ('--output', 'out')]
  1. 处理所使用的函数叫getopt()，因为是直接使用import导入的getopt模块，所以要加上限定getopt才可以。
  2. 使用sys.argv[1:]过滤掉第一个参数（它是执行脚本的名字，不应算作参数的一部分）。
  3. 使用短格式分析串"ho:"。当一个选项只是表示开关状态时，即后面不带附加参数时，在分析串中写入选项字符。当选项后面是带一个附加参数时，在分析串中写入选项字符同时后面加一个":"号。所以"ho:"就表示"h"是一个开关选项；"o:"则表示后面应该带一个参数。
  4. 使用长格式分析串列表：[“help”, “output=”]。长格式串也可以有开关状态，即后面不跟"="号。如果跟一个等号则表示后面还应有一个参数。这个长格式表示"help"是一个开关选项；"output="则表示后面应该带一个参数。
  5. 调用getopt函数。函数返回两个列表：opts和args。opts为分析出的格式信息。args为不属于格式信息的剩余的命令行参数,即不是按照getopt(）里面定义的长或短选项字符和附加参数以外的信息。opts是一个两元组的列表。每个元素为：(选项串,附加参数)。如果没有附加参数则为空串’’。
  6. 整个过程使用异常来包含，这样当分析出错时，就可以打印出使用信息来通知用户如何使用这个程序。