optparse --- 命令行选项的解析器

原始碼:Lib/optparse.py

在 3.2 版之後被棄用: optparse 模块已被弃用并且将不再继续开发;开发将转至 argparse 模块进行。


optparse 是一个相比原有 getopt 模块更为方便、灵活和强大的命令行选项解析库。 optparse 使用更为显明的命令行解析风格:创建一个 OptionParser 的实例,向其中填充选项,然后解析命令行。 optparse 允许用户以传统的 GNU/POSIX 语法来指定选项,并为你生成额外的用法和帮助消息。

下面是在一个简单脚本中使用 optparse 的示例:

from optparse import OptionParser
...
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
                  help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose", default=True,
                  help="don't print status messages to stdout")

(options, args) = parser.parse_args()

通过这几行代码,你的脚本的用户可以在命令行上完成“常见任务”,例如:

<yourscript> --file=outfile -q

在它解析命令行时,optparse 会根据用户提供的命令行值设置 parse_args() 所返回的 options 对象的属性。 当 parse_args() 从解析此命令行返回时,options.filename 将为 "outfile"options.verbose 将为 Falseoptparse 支持长短两种形式的选项,允许多个短选项合并到一起,并允许选项以多种方式与其参数相关联。 因此,以下命令行均等价于以上示例:

<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

此外,用户还可以运行以下命令之一

<yourscript> -h
<yourscript> --help

这样 optparse 将打印出你的脚本的选项概要:

Usage: <yourscript> [options]

Options:
  -h, --help            show this help message and exit
  -f FILE, --file=FILE  write report to FILE
  -q, --quiet           don't print status messages to stdout

其中 yourscript 的值是在运行时确定的 (通常来自 sys.argv[0])。

背景

optparse 被显式设计为鼓励创建带有简洁直观、符合惯例的命令行接口的程序。 为了这个目标,它仅支持最常见的命令行语法和在 Unix 下使用的规范语义。 如果你不熟悉这些惯例,请阅读本小节来使自己熟悉它们。

术语

argument -- 参数

在命令行中输入的字符串,并会被 shell 传给 execl()execv()。 在 Python 中,参数将是 sys.argv[1:] 的元素 (sys.argv[0] 是被执行的程序的名称)。 Unix shell 也使用术语 "word" 来指代参数。

有时替换 sys.argv[1:] 以外的参数列表也是必要的,所以你应当将 "参数" 当作是 "sys.argv[1:] 的一个元素,或者是作为 sys.argv[1:] 的替代的其他列表"。

选项

一个用来提供额外信息以指导或定制程序的执行的参数。 对于选项有许多不同的语法;传统的 Unix 语法是一个连字符 ("-") 后面跟单个字母,例如 -x-F。 此外,传统的 Unix 语法允许将多个选项合并为一个参数,例如 -x -F 就等价于 -xF。 GNU 项目引入了 -- 后面跟一串以连字符分隔的单词,例如 --file--dry-run。 它们是 optparse 所提供的仅有的两种选项语法。

存在于世上的其他一些选项语法包括:

  • 一个连字符后面跟几个字母,例如 -pf (这与多个选项合并成单个参数 并不 一样)

  • 一个连字符后面跟一个完整单词,例如 -file (这在技术上等同于前面的语法,但它们通常不在同一个程序中出现)

  • 一个加号后面跟一个字母,或几个字母,或一个单词,例如 +f, +rgb

  • 一个斜杠后面跟一个字母,或几个字母,或一个单词,例如 /f, /file

这些选项语法都不被 optparse 所支持,也永远不会支持。 这是有意为之的:前三种在任何环境下都是非标准的,而最后一种只在你专门针对 Windows 或某些旧平台(例如 VMS, MS-DOS)时才有意义。

可选参数:

一个跟在某个选项之后的参数,与该选项紧密相关,并会在该选项被消耗时从参数列表中被消耗。 使用 optparse,选项参数可以是其对应选项以外的一个单独参数:

-f foo
--file foo

或是包括在同一个参数中:

-ffoo
--file=foo

通常,一个给定的选项将接受一个参数或是不接受。 许多人想要“可选的可选参数”特性,即某些选项将在看到特定参数时接受它,而如果没看到特定参数则不接受。 在某种程度上说这一特性是存在争议的,因它它将使解析发生歧义:如果 -a 接受一个可选参数而 -b 是完全不同的另一个选项,那我们该如何解读 -ab 呢? 由于这会存在歧义,因此 optparse 不支持这一特性。

positional argument -- 位置参数

在解析选项之后,即在选项及其参数解析完成并从参数列表中移除后参数列表中余下的内容。

必选选项

必须在命令行中提供的选项;请注意在英文中 "required option" 这个短语是自相矛盾的。 optparse 不会阻止你实现必须选项,但也不会在这方面给你什么帮助。

例如,考虑这个假设的命令行:

prog -v --report report.txt foo bar

-v--report 都是选项。 假定 --report 接受一个参数,report.txt 是一个选项参数。 foobar 是位置参数。

选项的作用是什么?

选项被用来提供额外信息以便微调或定制程序的执行。 需要明确的一点是,选项通常都是 可选的。 一个程序应当能在没有设置任何选项的的情况下正常运行。 (从 Unix 或 GNU 工具集中随机挑选一个程序。 它是否能在未设置任何选项的情况下运行并且仍然得到有意义的结果? 主要的例外有 find, tardd --- 它们都是些因为语法不标准和界面混乱而受到公正抨击的变异奇行种。)

有很多人希望他们的程序具有“必需选项”。 请再思考一下。 如果某个项是必需的,那么它就 不是可选的! 如果你的程序必需要有某项信息才能成功运行,则它更适合作为位置参数。

作为良好的命令行界面设计的一个例子,请看基本的用于拷贝文件的 cp 工具。 试图拷贝文件而不提供一个目标和至少一个源是没有什么意义的。 因此,如果你不带参数地运行 cp 它将会报错。 不过,它具有一个完全不需要任何选项的灵活、易用的语法:

cp SOURCE DEST
cp SOURCE ... DEST-DIR

你只使用这个语法就能畅行无阻。 大多数 cp 实现还提供了许多精确调整文件拷贝方式的选项:你可以保留模式和修改时间,避免跟随符号链接,覆盖现有文件之前先询问,诸如此类。 但这些都不会破坏 cp 的核心任务,即将一个文件拷贝为另一个文件,或将多个文件拷贝到另一个目录。

位置参数有什么用?

位置参数是对于你的程序运行来说绝对、肯定需要的信息片段。

一个好的用户界面应当尽可能少地设置绝对必需提供的信息。 如果你的程序必需提供 17 项不同的信息片段才能成功运行,那么你要 如何 从用户获取这些信息将不是问题的关键 --- 大多数人会在他们成功运行此程序之前放弃并离开。 无论用户界面是命令行、配置文件还是 GUI 都一样适用:如果你对你的用户提出如此多的要求,它们大多将会直接放弃。

简而言之,请尽量最小化绝对要求用户提供的信息量 --- 只要有可能就使用合理的默认值。 当然,你希望程序足够灵活也是合理的。 这就是选项的作用。 同样,选项是配置文件中的条目,GUI 中的“首选项”对话框中的控件,还是命令行选项不是问题的关键 --- 你实现的选项越多,你的程序就越灵活,它的具体实现也会变得更为复杂。 当然,太大的灵活性也存在缺点;过多的选项会让用户更难掌握并使你的代码更难维护。

教程

虽然 optparse 非常灵活和强大,但在大多数情况下它也很简明易用。 本小节介绍了任何基于 optparse 的程序中常见的代码模式。

首先,你需要导入 OptionParser 类;然后在主程序的开头部分,创建一个 OptionParser 实例:

from optparse import OptionParser
...
parser = OptionParser()

然后你可以开始定义选项。 基本语法如下:

parser.add_option(opt_str, ...,
                  attr=value, ...)

每个选项有一个或多个选项字符串,如 -f--file,以及一些选项属性用来告诉 optparse 当它在命令行中遇到该选项时将得到什么和需要做什么。

通常,每个选项都会有一个短选项字符串和一个长选项字符串,例如

parser.add_option("-f", "--file", ...)

你可以随你的喜好自由定义任意数量的短选项字符串和任意数量的长选项字符串(包括零个),只要总计至少有一个选项字符串。

传给 OptionParser.add_option() 的选项字符串实际上是特定调用所定义的选项的标签。 为了表述简单,我们将经常会说在命令行中 遇到一个选项;而实际上,optparse 是遇到了 选项字符串 并根据它们来查找选项。

一旦你定义好所有的选项,即可指令 optparse 来解析你的程序的命令行:

(options, args) = parser.parse_args()

(如果你愿意,可以将自定义的参数列表传给 parse_args(),但很少有必要这样做:默认它将使用 sys.argv[1:]。)

parse_args() 回傳兩個值:

  • options,一个包含你所有的选项的值的对象 --- 举例来说,如果 --file 接受一个字符串参数,则 options.file 将为用户所提供的文件名,或者如果用户未提供该选项则为 None

  • args,由解析选项之后余下的位置参数组成的列表

本教学章节只介绍了四个最重要的选项属性: action, type, dest (destination) 和 help。 其中,action 是最基本的一个。

理解选项动作

动作是告诉 optparse 当它在命令行中遇到某个选项时要做什么。 有一个固定的动作集被硬编码到 optparse 内部;添加新的动作是将在 扩展 optparse 章节中介绍的进阶内容。 大多数动作都是告诉 optparse 将特定的值存储到某个变量中 --- 例如,从命令行接收一个字符串并将其存储到 options 的某个选项中。

如果你没有指定一个选项动作,optparse 将默认选择 store

store 动作

最常用的选项动作是 store,它告诉 optparse 接收下一个参数(或当前参数的剩余部分),确认其为正确的类型,并将其保存至你选择的目标。

舉例來說:

parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")

现在让我们编一个虚假的命令行并让 optparse 来解析它:

args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)

optparse 看到选项字符串 -f 时,它将获取下一个参数 foo.txt,并将其保存到 options.filename 中。 因此,在这个对 parse_args() 的调用之后,options.filename 将为 "foo.txt"

受到 optparse 支持的其他一些选项类型有 intfloat。 下面是一个接受整数参数的选项:

parser.add_option("-n", type="int", dest="num")

请注意这个选项没有长选项字符串,这是完全可接受的。 而且,它也没有显式的动作,因为使用默认的 store

让我们解析另一个虚假的命令行。 这一次,我们将让选项参数与选项紧贴在一起:因为 -n42 (一个参数) 与 -n 42 (两个参数) 是等价的,以下代码

(options, args) = parser.parse_args(["-n42"])
print(options.num)

将会打印 42

如果你没有指明类型,optparse 会假定类型为 string。 加上默认动作为 store 这一事实,意味着我们的第一个示例可以变得更加简短:

parser.add_option("-f", "--file", dest="filename")

如果你没有提供目标,optparse 会从选项字符串推断出一个合理的默认目标:如果第一个长选项字符串为 --foo-bar,则默认目标为 foo_bar。 如果没有长选项字符串,则 optparse 会查找第一个短选项字符串:针对 -f 的默认目标将为 f

optparse 还包括了内置的 complex 类型。 添加类型的方式将在 扩展 optparse 一节中介绍。

处理布尔值(旗标)选项

旗标选项 --- 当看到特定选项时将某个变量设为真值或假值 --- 是相当常见的。 optparse 通过两个单独的动作支持它们,store_truestore_false。 例如,你可能会有个 verbose 旗标将通过 -v 来启用并通过 -q 来禁用:

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")

这里我们有两个相同目标的不同选项,这是完全可行的。 (只是这意味着在设置默认值时你必须更加小心 --- 见下文所述。)

optparse 在命令行中遇到 -v 时,它会将 options.verbose 设为 True;当它遇到 -q 时,则会将 options.verbose 设为 False

其他动作

受到 optparse 支持的其他动作还有:

"store_const"

存储一个常量值,通过 Option.const 预设

"append"

将此选项的参数添加到一个列表

"count"

让指定的计数器加一

"callback"

调用指定函数

这些在 参考指南,以及 选项回调 等章节中有说明。

默认值

上述示例全都涉及当看到特定命令行选项时设置某些变量(即“目标”)的操作。 如果从未看到这些选项那么会发生什么叱?由于我们没有提供任何默认值,它们全都会被设为 None。 这通常是可以的,但有时你会想要更多的控制。 optparse 允许你为每个目标提供默认值,它们将在解析命令行之前被赋值。

首先,考虑这个 verbose/quiet 示例。 如果我们希望 optparseverbose 设为 True 除非看到了 -q,那么我们可以这样做:

parser.add_option("-v", action="store_true", dest="verbose", default=True)
parser.add_option("-q", action="store_false", dest="verbose")

由于默认值将应用到 destination 而不是任何特定选项,并且这两个选项正好具有相同的目标,因此这是完全等价的:

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose", default=True)

考虑一下:

parser.add_option("-v", action="store_true", dest="verbose", default=False)
parser.add_option("-q", action="store_false", dest="verbose", default=True)

同样地,verbose 的默认值将为 True: 最终生效的将是最后提供给任何特定目标的默认值。

一种更清晰的默认值指定方式是使用 OptionParser 的 set_defaults() 方法,你可以在调用 parse_args() 之前的任何时候调用它:

parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()

如前面一样,最终生效的将是最后为特定选项目标指定的值。 为清楚起见,请使用一种或另外一种设置默认值的方法,而不要同时使用。

生成帮助

optparse 自动生成帮助和用法文本的功能适用于创建用户友好的命令行界面。 你所要做的只是为每个选项提供 help 值,并可选项为你的整个程序提供一条简短的用法消息。 下面是一个填充了用户友好的(文档)选项的 OptionParser:

usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose",
                  help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
                  metavar="FILE", help="write output to FILE")
parser.add_option("-m", "--mode",
                  default="intermediate",
                  help="interaction mode: novice, intermediate, "
                       "or expert [default: %default]")

如果 optparse 在命令行中遇到了 -h--help,或者如果你调用了 parser.print_help(),它会把以下内容打印到标准输出:

Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

(如果帮助输出是由 help 选项触发的,optparse 将在打印帮助文本之后退出。)

在这里为帮助 optparse 生成尽可能好的帮助消息做了很多工作:

  • 该脚本定义了自己的用法消息:

    usage = "usage: %prog [options] arg1 arg2"
    

    optparse 会将用法字符串中的 %prog 扩展为当前程序的名称,即 os.path.basename(sys.argv[0])。 随后将在详细选项帮助之前打印这个经过扩展的字符串。

    如果你未提供用法字符串,optparse 将使用一个直白而合理的默认值: "Usage: %prog [options]",这在你的脚本不接受任何位置参数时是可以的。

  • 每个选项都定义了帮助字符串,并且不用担心换行问题 --- optparse 将负责执行换行并使帮助输出有良好的外观格式。

  • 需要接受值的选项会在它们自动生成的帮助消息中提示这一点,例如对于 "mode" 选项:

    -m MODE, --mode=MODE
    

    在这里,"MODE" 被称为元变量:它代表预期用户会提供给 -m/--mode 的参数。 在默认情况下,optparse 会将目标变量名转换为大写形式并将其用作元变量。 有时,这并不是你所希望的 --- 例如,--filename 选项显式地设置了 metavar="FILE",结果将自动生成这样的选项描述:

    -f FILE, --filename=FILE
    

    不过,这具有比节省一点空间更重要的作用:手动编写的帮助文本使用元变量 FILE 来提示用户在半正式的语法 -f FILE 和非正式的描述 "write output to FILE" 之间存在联系。 这是一种使你的帮助文本更清晰并对最终用户来说更易用的简单而有效的方式。

  • 具有默认值的选项可以在帮助字符串中包括 %default --- optparse 将用该选项的默认值的 str() 来替代它。 如果一个选项没有默认值 (或默认值为 None),则 %default 将被扩展为 none

选项分组

在处理大量选项时,可以方便地将选项进行分组以提供更好的帮助输出。 OptionParser 可以包含多个选项分组,每个分组可以包含多个选项。

选项分组是使用 OptionGroup 类来生成的:

class optparse.OptionGroup(parser, title, description=None)

其中

  • parser 是分组将被插入的 OptionParser 实例

  • title 是分组的标题

  • description,可选项,是分组的长描述文本

OptionGroup 继承自 OptionContainer (类似 OptionParser) 因此 add_option() 方法可被用来向分组添加选项。

一旦声明了所有选项,使用 OptionParser 方法 add_option_group() 即可将分组添加到之前定义的解析器。

继续使用前一节定义的解析器,很容易将 OptionGroup 添加到解析器中:

group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)

这将产生以下帮助输出:

Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.

更完整一些的示例可能涉及使用多个分组:继续扩展之前的例子:

group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)

group = OptionGroup(parser, "Debug Options")
group.add_option("-d", "--debug", action="store_true",
                 help="Print debug information")
group.add_option("-s", "--sql", action="store_true",
                 help="Print all SQL statements executed")
group.add_option("-e", action="store_true", help="Print every action done")
parser.add_option_group(group)

这会产生以下输出:

Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert
                        [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.

  Debug Options:
    -d, --debug         Print debug information
    -s, --sql           Print all SQL statements executed
    -e                  Print every action done

另一个有趣的方法,特别适合在编程处理选项分组时使用:

OptionParser.get_option_group(opt_str)

返回短或长选项字符串 opt_str (例如 '-o''--option') 所属的 OptionGroup。 如果没有对应的 OptionGroup,则返回 None

打印版本字符串

与简短用法字符串类似,optparse 还可以打印你的程序的版本字符串。 你必须将该字符串作为 version 参数提供给 OptionParser:

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

%prog 会像在 usage 中那样被扩展。 除了这一点,version 还可包含你想存放的任何东西。 当你提供它时,optparse 将自动向你的解析器添加一个 --version 选项。 如果它在命令行中遇到了该选项,它将扩展你的 version 字符串 (通过替换 %prog),将其打印到标准输出,然后退出。

举例来说,如果你的脚本是 /usr/bin/foo:

$ /usr/bin/foo --version
foo 1.0

下列两个方法可被用来打印和获取 version 字符串:

OptionParser.print_version(file=None)

将当前程序的版本消息 (self.version) 打印到 file (默认为 stdout)。 就像 print_usage() 一样,任何在 self.version 中出现的 %prog 将被替换为当前程序的名称。 如果 self.version 为空或未定义则不做任何操作。

OptionParser.get_version()

print_version() 相似但是会返回版本字符串而不是打印它。

optparse 如何处理错误handles errors

optparse 必须考虑两种宽泛的错误类:程序员错误和用户错误。 程序员错误通常是对 OptionParser.add_option() 的错误调用,例如无效的选项字符串,未知的选项属性,不存在的选项属性等等。 这些错误将以通常的方式来处理:引发一个异常 (或者是 optparse.OptionError 或者是 TypeError) 并让程序崩溃。

处理用户错误更为重要,因为无论你的代码有多稳定他们都肯定会发生。 optparse 可以自动检测部分用户错误,例如不正确的选项参数(如传入 -n 4x-n 接受整数参数),缺少参数(如 -n 位于命令行的末尾,而 -n 接受任意类型的参数)。 并且,你可以调用 OptionParser.error() 来指明应用程序自定义的错误条件:

(options, args) = parser.parse_args()
...
if options.a and options.b:
    parser.error("options -a and -b are mutually exclusive")

在两种情况下,optparse 都是以相同方式处理错误的:它会将程序的用法消息和错误消息打印到标准错误并附带错误状态 2 退出。

考虑上面的第一个示例,当用户向一个接受整数的选项传入了 4x:

$ /usr/bin/foo -n 4x
Usage: foo [options]

foo: error: option -n: invalid integer value: '4x'

或者,当用户未传入任何值:

$ /usr/bin/foo -n
Usage: foo [options]

foo: error: -n option requires an argument

optparse 生成的错误消息总是会确保提示在错误中涉及的选项;请确保在从你的应用程序代码调用 OptionParser.error() 时也做同样的事。

如果 optparse 的默认错误处理行为不适合你的需求,你需要子类化 OptionParser 并重写它的 exit() 和/或 error() 方法。

合并所有代码

下面是基于 optparse 的脚本通常的结构:

from optparse import OptionParser
...
def main():
    usage = "usage: %prog [options] arg"
    parser = OptionParser(usage)
    parser.add_option("-f", "--file", dest="filename",
                      help="read data from FILENAME")
    parser.add_option("-v", "--verbose",
                      action="store_true", dest="verbose")
    parser.add_option("-q", "--quiet",
                      action="store_false", dest="verbose")
    ...
    (options, args) = parser.parse_args()
    if len(args) != 1:
        parser.error("incorrect number of arguments")
    if options.verbose:
        print("reading %s..." % options.filename)
    ...

if __name__ == "__main__":
    main()

参考指南

创建解析器

使用 optparse 的第一步是创建 OptionParser 实例。

class optparse.OptionParser(...)

OptionParser 构造器没有必需的参数,只有一些可选的关键字参数。 你应当始终以关键字参数形式传入它们,即不要依赖于声明参数所在位置的顺序。

usage (默认: "%prog [options]")

当你的程序不正确地运行或附带 help 选项运行时将打印的用法说明。 当 optparse 打印用法字符串时,它会将 %prog 扩展为 os.path.basename(sys.argv[0]) (或者如果你传入 prog 则为该关键字参数值)。 要屏蔽用法说明,请传入特殊值 optparse.SUPPRESS_USAGE

option_list (默认: [])

一个用于填充解析器的由 Option 对象组成的列表。 option_list 中的选项将添加在 standard_option_list (一个可由 OptionParser 的子类设置的类属性) 中的任何选项之后,以及任何版本或帮助选项之前。 已被弃用;请改为在创建解析器之后使用 add_option()

option_class (默认: optparse.Option)

当在 add_option() 中向解析器添加选项时要使用的类。

version (默认: None)

当用户提供了 version 选项时将会打印的版本字符串。 如果你为 version 提供真值,optparse 将自动添加单个选项字符串 --version 形式的 version 选项。 子字符串 %prog 会以与 usage 相同的方式扩展。

conflict_handler (默认: "error")

指定当有相互冲突的选项字符串的选项被添加到解析器时要如何做;参见 选项之间的冲突 一节。

description (默认: None)

一段提供你的程序的简短介绍的文本。 optparse 会重格式化段落以适合当前终端宽度并在用户请求帮助时打印其内容(在 usage 之后,选项列表之前)。

formatter (默认: 一个新的 IndentedHelpFormatter)

一个将被用于打印帮助文本的 optparse.HelpFormatter 实例。 optparse 为此目的提供了两个实体类: IndentedHelpFormatter 和 TitledHelpFormatter。

add_help_option (默认: True)

如为真值,optparse 将向解析器添加一个 help 选项 (使用选项字符串 -h--help)。

prog

当在 usageversion 中用于代替 os.path.basename(sys.argv[0]) 来扩展 %prog 的字符串。

epilog (默认: None)

一段将在选项帮助之后打印的帮助文本。

填充解析器

有几种方式可以为解析器填充选项。 最推荐的方式是使用 OptionParser.add_option(),如 教程 一节所演示的。 add_option() 可以通过两种方式来调用:

  • 传入一个 Option 实例(即 make_option() 所返回的对象)

  • 传入 make_option() 可接受的(即与 Option 构造器相同的)任意位置和关键字参数组合,它将为你创建 Option 实例

另一种方式是将由预先构造的 Option 实例组成的列表传给 OptionParser 构造器,如下所示:

option_list = [
    make_option("-f", "--filename",
                action="store", type="string", dest="filename"),
    make_option("-q", "--quiet",
                action="store_false", dest="verbose"),
    ]
parser = OptionParser(option_list=option_list)

(make_option() 是一个用于创建 Option 实例的工厂函数;目前它是 Option 构造器的一个别名。 未来的 optparse 版本可能会将 Option 拆分为多个类,而 make_option() 将选择适当的类来实例化。 请不要直接实例化 Option。)

定义选项

每个 Option 实例代表一组同义的命令行选项字符串,例如 -f--file。 你可以指定任意数量的短和长选项字符串,但你必须指定总计至少一个选项字符串。

创建 Option 的正规方式是使用 OptionParseradd_option() 方法。

OptionParser.add_option(option)
OptionParser.add_option(*opt_str, attr=value, ...)

定义只有一个短选项字符串的选项:

parser.add_option("-f", attr=value, ...)

以及定义只有一个长选项字符串的选项:

parser.add_option("--foo", attr=value, ...)

该关键字参数定义新 Option 对象的属性。 最重要的选项属性是 action,它主要负责确定其他的属性是相关的还是必须的。 如果你传入了不相关的选项属性,或是未能传入必须的属性,optparse 将引发一个 OptionError 异常来说明你的错误。

选项的 action 决定当 optparse 在命令行中遇到该选项时要做什么。 硬编码在 optparse 中的标准选项动作有:

"store"

存储此选项的参数(默认)

"store_const"

存储一个常量值,通过 Option.const 预设

"store_true"

存储 True

"store_false"

存储 False

"append"

将此选项的参数添加到一个列表

"append_const"

将指定常量值添加到一个列表,可通过 Option.const 预设

"count"

让指定的计数器加一

"callback"

调用指定函数

"help"

打印用法消息,包括所有选项和它们的文档

(如果你没有提供动作,则默认为 "store"。 对于此动作,你还可以提供 typedest 选项属性;参见 标准选项动作。)

如你所见,大多数动作都在某处保存或更新一个值。 optparse 总是会为此创建一个特殊对象,它被恰当地称为 options,是 optparse.Values 的实例。

class optparse.Values

一个将被解析的参数名和值作为属性保存的对象。 一般是通过调用 OptionParser.parse_args() 来创建,并可被传给 OptionParser.parse_args()values 参数的自定义子类所覆盖(如在 解析参数 中描述的那样)。

Option 参数(以及各种其他的值)将根据 dest (目标) 选项属性被保存为此对象的属性。

例如說,當你呼叫:

parser.parse_args()

optparse 首先会做的一件事情是创建 options 对象:

options = Values()

如果该解析器中的某个选项定义带有

parser.add_option("-f", "--file", action="store", type="string", dest="filename")

并且被解析的命令行包括以下任意一项:

-ffoo
-f foo
--file=foo
--file foo

那么 optparse 在看到此选项时,将执行这样的操作

options.filename = "foo"

typedest 选项属性几乎与 action 一样重要,但 action 是唯一对 所有 选项都有意义的。

选项属性

class optparse.Option

一个单独的命令行参数,带有以关键字参数形式传给构造器的各种属性。 通常使用 OptionParser.add_option() 创建而不是直接创建,并可被作为 OptionParseroption_class 参数传入的自定义类来重写。

下列选项属性可以作为关键字参数传给 OptionParser.add_option()。 如果你传入一个与特定选项无关的选项属性,或是未能传入必要的选项属性,optparse 将会引发 OptionError

Option.action

(預設值: "store"

用于当在命令行中遇到此选项时确定 optparse 的行为;可用的选项记录在 这里

Option.type

(預設值: "string"

此选项所接受的参数类型 (例如 "string""int");可用的选项类型记录在 这里

Option.dest

(默认: 获取自选项字符串)

如果此选项的动作涉及在某处写入或修改一个值,该属性将告诉 optparse 将它写入到哪里: dest 指定 optparse 在解析命令行时构建的 options 对象的某个属性。

Option.default

当未在命令行中遇到此选项时将被用作此选项的目标的值。 另请参阅 OptionParser.set_defaults()

Option.nargs

(預設值:1)

当遇到此选项时应当读取多少个 type 类型的参数。 如果 > 1,optparse 会将由多个值组成的元组保存到 dest

Option.const

对于保存常量值的动作,指定要保存的常量值。

Option.choices

对于 "choice" 类型的选项,由用户可选择的字符串组成的列表。

Option.callback

对于使用 "callback" 动作的选项,当遇到此选项时要调用的可调用对象。 请参阅 选项回调 一节了解关于传给可调用对象的参数的详情。

Option.callback_args
Option.callback_kwargs

将在四个标准回调参数之后传给 callback 的额外的位置和关键字参数。

Option.help

当用户提供 help 选项 (如 --help) 之后将在列出所有可有远项时针对此选项打印的文本。 如果没有提供帮助文本,则列出选项时将不附带帮助文本。 要隐藏此选项,请使用特殊值 optparse.SUPPRESS_HELP

Option.metavar

(默认: 获取自选项字符串)

当打印帮助文本时要使用的代表选项参数的名称。 请参阅 教程 一节查看相应示例。

标准选项动作

各种选项动作具有略微不同的要求和效果。 大多数动作都具有几个可被你指定的独步选项属性用来控制 optparse 的行为;少数还具有一些必需属性,你必须为任何使用该动作的选项指定这些属性。

  • "store" [关联: type, dest, nargs, choices]

    该选项后必须跟一个参数,它将根据 type 被转换为相应的值并保存至 dest。 如果 nargs > 1,则将从命令行读取多个参数;它们将全部根据 type 被转换并以元组形式保存至 dest。 参见 标准选项类型 一节。

    如果提供了 choices (由字符串组成的列表和元组),则类型默认为 "choice"

    如果未提供 type,则默认为 "string"

    如果未提供 dest,则 optparse 会从第一个长选项字符串派生出目标 (例如 --foo-bar 将对应 foo_bar)。 如果不存在长选项字符串,则 optparse 会从第一个短选项字符串派生出目标 (例如 -f 将对应 f)。

    範例:

    parser.add_option("-f")
    parser.add_option("-p", type="float", nargs=3, dest="point")
    

    当它解析命令行

    -f foo.txt -p 1 -3.5 4 -fbar.txt
    

    optparse 将设置

    options.f = "foo.txt"
    options.point = (1.0, -3.5, 4.0)
    options.f = "bar.txt"
    
  • "store_const" [要求: const; 关联: dest]

    const 将存放到 dest 中。

    範例:

    parser.add_option("-q", "--quiet",
                      action="store_const", const=0, dest="verbose")
    parser.add_option("-v", "--verbose",
                      action="store_const", const=1, dest="verbose")
    parser.add_option("--noisy",
                      action="store_const", const=2, dest="verbose")
    

    如果看到了 --noisyoptparse 将设置

    options.verbose = 2
    
  • "store_true" [关联: dest]

    True 存放到 dest 中的 "store_const" 的特例。

  • "store_false" [关联: dest]

    类似于 "store_true",但是存放 False

    範例:

    parser.add_option("--clobber", action="store_true", dest="clobber")
    parser.add_option("--no-clobber", action="store_false", dest="clobber")
    
  • "append" [关联: type, dest, nargs, choices]

    该选项必须跟一个参数,该参数将被添加到 dest 的列表中。 如果未提供 dest 的默认值,那么当 optparse 首次在命令行中遇到该选项时将自动创建一个空列表。 如果 nargs > 1,则会读取多个参数,并将一个长度为 nargs 的元组添加到 dest

    typedest 的默认值与 "store" 动作的相同。

    範例:

    parser.add_option("-t", "--tracks", action="append", type="int")
    

    如果在命令行中遇到 -t3optparse 将执行这样的操作:

    options.tracks = []
    options.tracks.append(int("3"))
    

    如果,在稍后的时候,再遇到 --tracks=4,它将执行:

    options.tracks.append(int("4"))
    

    append 动作会在选项的当前值上调用 append 方法。 这意味着任何被指定的默认值必须具有 append 方法。 这还意味着如果默认值非空,则其中的默认元素将存在于选项的已解析值中,而任何来自命令行的值将被添加到这些默认值之后:

    >>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])
    >>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])
    >>> opts.files
    ['~/.mypkg/defaults', 'overrides.mypkg']
    
  • "append_const" [需要: const; 关联: dest]

    "store_const" 类似,但 const 值将被添加到 dest;与 "append" 一样,dest 默认为 None,并且当首次遇到该选项时将自动创建一个空列表。

  • "count" [关联: dest]

    对保存在 dest 的整数执行递增。 如果未提供默认值,则 dest 会在第一次执行递增之前被设为零。

    範例:

    parser.add_option("-v", action="count", dest="verbosity")
    

    第一次在命令行中看到 -v 时,optparse 将执行这样的操作:

    options.verbosity = 0
    options.verbosity += 1
    

    后续每次出现 -v 都将导致

    options.verbosity += 1
    
  • "callback" [需要: callback; 关联: type, nargs, callback_args, callback_kwargs]

    调用 callback 所指定的函数,它将以如下形式被调用

    func(option, opt_str, value, parser, *args, **kwargs)
    

    更多細節請見 选项回调

  • "help"

    为当前选项解析器中所有的选项打印完整帮助消息。 该帮助消息是由传给 OptionParser 的构造器的 usage 字符串和传给每个选项的 help 字符串构造而成的。

    如果没有为某个选项提供 help 字符串,它仍将在帮助消息中列出。 要完全略去某个选项,请使用特殊值 optparse.SUPPRESS_HELP

    optparse 将自动为所有OptionParser 添加 help 选项,因此你通常不需要创建选项。

    範例:

    from optparse import OptionParser, SUPPRESS_HELP
    
    # usually, a help option is added automatically, but that can
    # be suppressed using the add_help_option argument
    parser = OptionParser(add_help_option=False)
    
    parser.add_option("-h", "--help", action="help")
    parser.add_option("-v", action="store_true", dest="verbose",
                      help="Be moderately verbose")
    parser.add_option("--file", dest="filename",
                      help="Input file to read data from")
    parser.add_option("--secret", help=SUPPRESS_HELP)
    

    如果 optparse 在命令行中看到 -h--help,它将将类似下面这样的帮助消息打印到 stdout (假设 sys.argv[0]"foo.py"):

    Usage: foo.py [options]
    
    Options:
      -h, --help        Show this help message and exit
      -v                Be moderately verbose
      --file=FILENAME   Input file to read data from
    

    在打印帮助消息之后,optparse 将使用 sys.exit(0) 来终结你的进程。

  • "version"

    将提供给 OptionParser 的版本号打印到 stdout 并退出。 该版本号实际上是由 OptionParser 的 print_version() 方法进行格式化并打印的。 这通常只在向 OptionParser 构造器提供了 version 参数时才有意义。 与 help 选项类似,你很少会创建 version 选项,因为 optparse 会在需要时自动添加它们。

标准选项类型

optparse 有五种内置选项类型: "string", "int", "choice", "float""complex"。 如果你需要添加新的选项类型,请参阅 扩展 optparse 一节。

传给 string 类型选项的参数不会以任何方式进行检查或转换:命令行中的文本将被原样保存至目标(或传给回调)。

整数参数 ("int" 类型) 将以如下方式解析:

  • 如果数字开头为 0x,它将被解析为十六进制数

  • 如果数字开头为 0,它将被解析为八进制数

  • 如果数字开头为 0b,它将被解析为二进制数

  • 在其他情况下,数字将被解析为十进制数

转换操作是通过调用 int() 并传入适当的 base (2, 8, 10 或 16) 来完成的。 如果转换失败, optparse 也将失败,但它会附带更有用的错误消息。

"float""complex" 选项参数会直接通过 float()complex() 来转换,使用类似的错误处理。

"choice" 选项是 "string" 选项的子类型。 choices 选项属性(由字符串组成的序列)定义了允许的选项参数的集合。 optparse.check_choice() 将用户提供的选项参数与这个主列表进行比较并会在给出无效的字符串时引发 OptionValueError

解析参数

创建和填充 OptionParser 的基本目的是调用其 parse_args() 方法。

OptionParser.parse_args(args=None, values=None)

解析 args 中的命令行选项。

输入形参为

args

要处理的参数列表 (默认: sys.argv[1:])

values

要用于存储选项参数的 Values 对象(默认值:一个新的 Values 实例) -- 如果你给出一个现有对象,则不会基于它来初始化选项的默认值。

并且返回值是一个 (options, args) 对,其中

options

就是作为 values 传入的同一个对象,或是由 optparse 创建的 optparse.Values 实例

args

在所有选项被处理完毕后余下的位置参数

最常见的用法是不提供任何关键字参数。 如果你提供了 values,它将通过重复的 setattr() 调用来修改(大致为每个存储到指定选项目标的选项参数调用一次)并由 parse_args() 返回。

如果 parse_args() 在参数列表中遇到任何错误,它将调用 OptionParser 的 error() 方法并附带适当的最终用户错误消息。 这会完全终结你的进程并将退出状态设为 2 (传统的针对命令行错误的 Unix 退出状态)。

查询和操纵你的选项解析器

选项解析器的默认行为可被轻度地定制,并且你还可以调整你的选项解析器查看实际效果如何。 OptionParser 提供了一些方法来帮助你进行定制:

OptionParser.disable_interspersed_args()

设置解析在第一个非选项处停止。 举例来说,如果 -a-b 都是不接受参数的简单选项,则 optparse 通常会接受这样的语法:

prog -a arg1 -b arg2

并会这样处理它

prog -a -b arg1 arg2

要禁用此特性,则调用 disable_interspersed_args()。 这将恢复传统的 Unix 语法,其中选项解析会在第一个非选项参数处停止。

如果你用一个命令处理程序来运行另一个拥有它自己的选项的命令而你希望参确保这些选项不会被混淆就可以使用此方法。 例如,每个命令可能具有不同的选项集合。

OptionParser.enable_interspersed_args()

设置解析不在第一个非选项处停止,允许多个命令行参数的插入相互切换。 这是默认的行为。

OptionParser.get_option(opt_str)

返回具有选项字符串 opt_str 的的 Option 实例,或者如果不存在具有该选项字符串的选项则返回 None

OptionParser.has_option(opt_str)

如果 OptionParser 包含一个具有选项字符串 opt_str 的选项 (例如 -q--verbose) 则返回 True

OptionParser.remove_option(opt_str)

如果 OptionParser 包含一个对应于 opt_str 的选项,则移除该选项。 如果该选项提供了任何其他选项字符串,这些选项字符串将全部不可用。 如果 opt_str 不存在于任何属于此 OptionParser 的选项之中,则会引发 ValueError

选项之间的冲突

如果你不够小心,很容易会定义具有相互冲突的选项字符串的多个选项:

parser.add_option("-n", "--dry-run", ...)
...
parser.add_option("-n", "--noisy", ...)

(当你自定义具有某些标准选项的 OptionParser 时特别容易发生这种情况。)

每当你添加一个选项时,optparse 会检查它是否与现有选项冲突。 如果发现存在冲突,它将发起调用当前的冲突处理机制。 你可以选择在构造器中设置冲突处理机制:

parser = OptionParser(..., conflict_handler=handler)

或是在单独调用中设置:

parser.set_conflict_handler(handler)

可用的冲突处理句柄有:

"error" (默认)

将选项冲突视为编程错误并引发 OptionConflictError

"resolve"

智能地解决选项冲突(见下文)

举例来说,让我们定义一个智能地解决冲突的 OptionParser 并向其添加相互冲突的选项:

parser = OptionParser(conflict_handler="resolve")
parser.add_option("-n", "--dry-run", ..., help="do no harm")
parser.add_option("-n", "--noisy", ..., help="be noisy")

这时,optparse 会检测到之前添加的选项已经在使用 -n 选项字符串。 由于 conflict_handler"resolve",它将通过在之前选项的选项字符串列表中移除 -n 来解决冲突。 现在 --dry-run 将是用户激活该选项的唯一方式。 如果用户要获取帮助,帮助消息将反映这一变化:

Options:
  --dry-run     do no harm
  ...
  -n, --noisy   be noisy

之前添加的选项有可能不断更取代直到一个都不剩,这样用户将无法再从命令行发起调用相应的选项。 在这种情况下,optparse 将完全移除这样的选项,使它不会在帮助文本或任何其他地方显示。 如果我们继续修改现有的 OptionParser:

parser.add_option("--dry-run", ..., help="new dry-run option")

这时,原有的 -n/--dry-run 选项将不再可用,因此 optparse 会将其移除,帮助文本将变成这样:

Options:
  ...
  -n, --noisy   be noisy
  --dry-run     new dry-run option

清理

OptionParser 实例存在一些循环引用。 这对 Python 的垃圾回收器来说应该不是问题,但你可能希望在你完成对 OptionParser 的使用后通过调用其 destroy() 来显式地中断循环引用。 这在可以从你的 OptionParser 访问大型对象图的长期运行应用程序中特别有用。

其他方法

OptionParser 还支持其他一些公有方法:

OptionParser.set_usage(usage)

根据上述的规则为 usage 构造器关键字参数设置用法字符串。 传入 None 将设置默认的用法字符串;使用 optparse.SUPPRESS_USAGE 将屏蔽用法说明。

OptionParser.print_usage(file=None)

将当前程序的用法消息 (self.usage) 打印到 file (默认为 stdout)。 出现在 self.usage 中的字符串 %prog 将全部被替换为当前程序的名称。 如果 self.usage 为空或未定义则不做任何事情。

OptionParser.get_usage()

print_usage() 类似但是将返回用法字符串而不是打印它。

OptionParser.set_defaults(dest=value, ...)

一次性地为多个选项目标设置默认值。 使用 set_defaults() 是为选项设置默认值的推荐方式同,因为多个选项可以共享同一个目标。 举例来说,如果几个 "mode" 选项全部设置了相同的目标,则它们中的任何一个都可以设置默认值,而最终生效的将是最后一次设置的默认值:

parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced",
                  default="novice")    # overridden below
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # overrides above setting

为避免混淆,请使用 set_defaults():

parser.set_defaults(mode="advanced")
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced")
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice")

选项回调

optparse 的内置动作和类型不能满足你的需要时,你有两个选择:扩展 optparse 或定义一个回调选项。 扩展 optparse 的方式更为通用,但对许多简单场景来说是大材小用了。 你所需要的往往只是一个简单的回调。

定义一个回调选项分为两步:

  • 使用 "callback" 动作定义选项本身

  • 编写回调;它是一个接受至少四个参数的函数(或方法),如下所述

定义回调选项

一般来说,定义回调选项的最简单方式是使用 OptionParser.add_option() 方法。 在 action 之外,你必须指定的唯一选项属性是 callback,即要调用的函数:

parser.add_option("-c", action="callback", callback=my_callback)

callback 是一个函数(或其他可调用对象),因此当你创建这个回调选项时你必须已经定义了 my_callback()。 在这个简单的例子中,optparse 甚至不知道 -c 是否接受任何参数,这通常意味着该选项不接受任何参数 --- 它需要知道的就是存在命令行参数 -c。 但是,在某些情况下,你可能希望你的回调接受任意数量的命令行参数。 这是编写回调的一个麻烦之处;本小节将稍后讲解这个问题。

optparse 总是会向你的回调传递四个特定参数,它只会在你通过 callback_argscallback_kwargs 进行指定时才传入额外的参数。 因此,最小化的回调函数签名如下:

def my_callback(option, opt, value, parser):

对传给回调的四个参数的说明见下文。

当你定义回调选项时还可以提供一些其他的选项属性:

type

具有其通常的含义:与在 "store""append" 动作中一样,它指示 optparse 读取一个参数并将其转换为 type。 但是,optparse 并不会将所转换的值保存到某个地方,而是将其传给你的回调函数。

nargs

同样具有其通常的含义:如果提供了该属性并且其值 > 1,optparse 将读取 nargs 个参数,每个参数都必须可被转换为 type。 随后它会将被转换值的元组传给你的回调。

callback_args

一个要传给回调的由额外位置参数组成的元组

callback_kwargs

一个要传给回调的由额外关键字参数组成的字典

回调应当如何调用

所有回调都将使用以下方式调用:

func(option, opt_str, value, parser, *args, **kwargs)

其中

option

是调用该回调的 Option 实例

opt_str

是在触发回调的命令行参数中出现的选项字符串。 (如果使用了长选项的缩写形式,则 opt_str 将为完整规范的选项字符串 --- 举例来说,如果用户在命令行中将 --foo 作为 --foobar 的缩写形式,则 opt_str 将为 "--foobar"。)

value

是在命令行中提供给该选项的参数。 optparse 将只在设置了 type 的时候才接受参数;value 将为该选项的类型所指定的类型。 如果该选项的 typeNone (不接受参数),则 value 将为 None。 如果 nargs > 1,则 value 将为由指定类型的值组成的元组。

parser

是驱动选项解析过程的 OptionParser 实例,主要作用在于你可以通过其实例属性访问其他一些相关数据:

parser.largs

当前的剩余参数列表,即已被读取但不属于选项或选项参数的参数。 可以任意修改 parser.largs,例如通过向其添加更多的参数。 (该列表将成为 args,即 parse_args() 的第二个返回值。)

parser.rargs

当前的保留参数列表,即移除了 opt_strvalue (如果可用),并且只有在它们之后的参数才会被保留。 可以任意修改 parser.rargs,例如通过读取更多的参数。

parser.values

作为选项值默认保存位置的对象(一个 optparse.OptionValues 实例)。 这使得回调能使用与 optparse 的其他部分相同的机制来保存选项值;你不需要手动处理全局变量或闭包。 你还可以访问或修改在命令行中遇到的任何选项的值。

args

是一个由通过 callback_args 选项属性提供的任意位置参数组成的元组。

kwargs

是一个由通过 callback_kwargs 提供的任意关键字参数组成的字典。

在回调中引发错误

如果选项或其参数存在任何问题则回调函数应当引发 OptionValueErroroptparse 将捕获该异常并终止程序,将你提供的错误消息打印到 stderr。 你的消息应当清晰、简洁、准确并指明出错的选项。 否则,用户将很难弄清楚自己做错了什么。

回调示例 1:最简回调

下面是一个不接受任何参数,只是简单地记录所遇见的选项的回调选项示例:

def record_foo_seen(option, opt_str, value, parser):
    parser.values.saw_foo = True

parser.add_option("--foo", action="callback", callback=record_foo_seen)

当然,你也可以使用 "store_true" 动作做到这一点。

回调示例 2:检查选项顺序

下面是一个更有趣些的示例:当看到 -a 出现时将会记录,而如果它在命令行中出现于 -b 之后则将报告错误。

def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use -a after -b")
    parser.values.a = 1
...
parser.add_option("-a", action="callback", callback=check_order)
parser.add_option("-b", action="store_true", dest="b")

回调示例 3:检查选项顺序(通用)

如果你希望为多个类似的选项重用此回调(设置旗标,而在看到 -b 出现时触发),则需要一些额外工作:它设置的错误消息和旗标必须进行通用化。

def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use %s after -b" % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("-a", action="callback", callback=check_order, dest='a')
parser.add_option("-b", action="store_true", dest="b")
parser.add_option("-c", action="callback", callback=check_order, dest='c')

回调示例 4:检查任意条件

当然,你可以设置任何条件 --- 并不限于检查已定义选项的值。 举例来说,如果你有一个不应当在满月时被调用的选项,你就可以这样做:

def check_moon(option, opt_str, value, parser):
    if is_moon_full():
        raise OptionValueError("%s option invalid when moon is full"
                               % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("--foo",
                  action="callback", callback=check_moon, dest="foo")

(定义 is_moon_full() 的任务将作为留给读者的练习。)

回调示例 5:固定的参数

当你定义接受固定数量参数的 callback 选项时情况会变得更有趣一点。 指定一个 callback 选项接受参数的操作类似于定义一个 "store""append" 选项:如果你定义 type,那么该选项将接受一个必须可被转换为相应类型的参数;如果你进一步定义 nargs,那么该选项将接受 nargs 个参数。

下面是一个模拟了标准 "store" 动作的示例:

def store_value(option, opt_str, value, parser):
    setattr(parser.values, option.dest, value)
...
parser.add_option("--foo",
                  action="callback", callback=store_value,
                  type="int", nargs=3, dest="foo")

请注意 optparse 将为你读取 3 个参数并将它们转换为整数;你所要做的只是保存它们。 (或任何其他操作;对于这个示例显然你不需要使用回调。)

回调示例 6:可变的参数

当你想要一个选项接受可变数数量的参数时情况会变得更麻烦一点。 对于这种场景,你必须编写一个回调,因为 optparse 没有为它提供任何内置的相应功能。 而你必须处理 optparse 通常会为你处理的传统 Unix 命令行的某些细节问题。 特别地,回调应当实现单个 --- 参数的惯例规则:

  • --- 都可以作为选项参数

  • 单个 -- (如果不是某个选项的参数): 停止命令行处理并丢弃该 --

  • 单个 - (如果不是某个选项的参数): 停止命令行处理但保留 - (将其添加到 parser.largs)

如果你想要一个选项接受可变数量的参数,那么有几个微妙、棘手的问题需要考虑到。 你选择的具体实现将基于你的应用程序对于各方面利弊的权衡(这就是为什么 optparse 没有直接支持这一功能)。

无论如何,下面是一个对于接受可变参数的选项的回调的尝试:

def vararg_callback(option, opt_str, value, parser):
    assert value is None
    value = []

    def floatable(str):
        try:
            float(str)
            return True
        except ValueError:
            return False

    for arg in parser.rargs:
        # stop on --foo like options
        if arg[:2] == "--" and len(arg) > 2:
            break
        # stop on -a, but not on -3 or -3.0
        if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):
            break
        value.append(arg)

    del parser.rargs[:len(value)]
    setattr(parser.values, option.dest, value)

...
parser.add_option("-c", "--callback", dest="vararg_attr",
                  action="callback", callback=vararg_callback)

扩展 optparse

由于控制 optparse 如何读取命令行选项的两个主要因子是每个选项的动作和类型,所以扩展最可能的方向就是添加新的动作和新的类型。

添加新的类型

要添加新的类型,你必须自定义 optparseOption 类的子类。 这个类包含几个用来定义 optparse 的类型的属性: TYPESTYPE_CHECKER

Option.TYPES

一个由类型名称组成的元组;在你的子类中,简单地定义一个在标准元组基础上构建的新元组 TYPES

Option.TYPE_CHECKER

一个将类型名称映射到类型检查函数的字典。 类型检查函数具有如下签名:

def check_mytype(option, opt, value)

其中 option 是一个 Option 实例,opt 是一个选项字符串 (例如 -f),而 value 是来自命令行的必须被检查并转换为你想要的类型的字符串。 check_mytype() 应当返回假设的类型 mytype 的对象。 类型检查函数所返回的值将最终出现在 OptionParser.parse_args() 所返回的 OptionValues 实例中,或是作为 value 形参传给一个回调。

如果你的类型检查函数遇到任何问题则应当引发 OptionValueErrorOptionValueError 接受一个字符串参数,该参数将被原样传递给 OptionParsererror() 方法,该方法将随后附加程序名称和字符串 "error:" 并在终结进程之前将所有信息打印到 stderr。

下面这个很傻的例子演示了如何添加一个 "complex" 选项类型以便在命令行中解析 Python 风格的复数。 (现在这个例子比以前更傻了,因为 optparse 1.3 增加了对复数的内置支持,但是不必管它了。)

首先,必要的导入操作:

from copy import copy
from optparse import Option, OptionValueError

你必须先定义自己的类型检查器,因为以后它会被引用(在你的 Option 子类的 TYPE_CHECKER 类属性中):

def check_complex(option, opt, value):
    try:
        return complex(value)
    except ValueError:
        raise OptionValueError(
            "option %s: invalid complex value: %r" % (opt, value))

最后,是 Option 子类:

class MyOption (Option):
    TYPES = Option.TYPES + ("complex",)
    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    TYPE_CHECKER["complex"] = check_complex

(如果我们不对 Option.TYPE_CHECKER 执行 copy(),我们就将修改 optparse 的 Option 类的 TYPE_CHECKER 属性。 Python 就是这样,除了礼貌和常识以外没有任何东西能阻止你这样做。)

就是这样! 现在你可以编写一个脚本以与其他基于 optparse 的脚本相同的方式使用新的选项类型,除了你必须指示你的 OptionParser 使用 MyOption 而不是 Option:

parser = OptionParser(option_class=MyOption)
parser.add_option("-c", type="complex")

作为替代选择,你可以构建你自己的选项列表并将它传给 OptionParser;如果你不是以上述方式使用 add_option(),则你不需要告诉 OptionParser 使用哪个选项类:

option_list = [MyOption("-c", action="store", type="complex", dest="c")]
parser = OptionParser(option_list=option_list)

添加新的动作

添加新的动作有一点复杂,因为你必须理解 optparse 对于动作有几种分类:

"store" 类动作

会使得 optparse 将某个值保存到当前 OptionValues 实例的特定属性中的动作;这些选项要求向 Option 构造器提供一个 dest 属性。attribute to be supplied to the constructor.

"typed" 类动作

从命令行接受某个值并预期它是一个特定类型;或者更准确地说,是可被转换为一个特定类型的字符串的动作。 这些选项要求向 Option 构造器提供一个 type 属性。attribute to the constructor.

这些是相互重叠的集合:默认的 "store" 类动作有 "store", "store_const", "append""count",而默认的 "typed" 类动作有 "store", "append""callback"

当你添加一个动作时,你需要将它列在 Option 的以下类属性的至少一个当中以对它进行分类(全部为字符串列表):

Option.ACTIONS

所有动作必须在 ACTIONS 中列出。

Option.STORE_ACTIONS

"store" 类动作要额外地在此列出。

Option.TYPED_ACTIONS

"typed" 类动作要额外地在此列出。

Option.ALWAYS_TYPED_ACTIONS

总是会接受一个类型的动作(即其选项总是会接受一个值)要额外地在此列出。 它带来的唯一影响是 optparse 会将默认类型 "string" 赋值给动作在 ALWAYS_TYPED_ACTIONS 中列出而未显式指定类型的选项。

为了真正实现你的新动作,你必须重写 Option 的 take_action() 方法并添加一个识别你的动作的分支。

例如,让我们添加一个 "extend" 动作。 它类似于标准的 "append" 动作,但 "extend" 不是从命令行接受单个值并将其添加到现有列表,而是接受形式为以单个逗号分隔的多个值的字符串,并用这些值来扩展现有列表。 也就是说,如果 --names 是一个类型为 "string""extend" 选项,则命令行

--names=foo,bar --names blah --names ding,dong

将得到一个列表

["foo", "bar", "blah", "ding", "dong"]

我们再定义一个 Option 的子类:

class MyOption(Option):

    ACTIONS = Option.ACTIONS + ("extend",)
    STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)
    TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)
    ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)

    def take_action(self, action, dest, opt, value, values, parser):
        if action == "extend":
            lvalue = value.split(",")
            values.ensure_value(dest, []).extend(lvalue)
        else:
            Option.take_action(
                self, action, dest, opt, value, values, parser)

应注意的特性:

  • "extend" 既预期在命令行接受一个值又会将该值保存到某处,因此它同时被归类于 STORE_ACTIONSTYPED_ACTIONS

  • 为确保 optparse"string" 的默认类型赋值给 "extend" 动作,我们同时将 "extend" 动作归类于 ALWAYS_TYPED_ACTIONS

  • MyOption.take_action() 只实现了这一个新动作,并将控制权回传给 Option.take_action() 以执行标准的 optparse 动作。

  • values 是 optparse_parser.Values 类的一个实例,该类提供了非常有用的 ensure_value() 方法。 ensure_value() 实际就是一个带有安全阀的 getattr();它的调用形式为

    values.ensure_value(attr, value)
    

    如果 valuesattr 属性不存在或为 None,则 ensure_value() 会先将其设为 value,然后返回 value。 这非常适用于 "extend", "append""count" 等动作,它们会将数据累积在一个变量中并预期该变量属于特定的类型(前两项是一个列表,后一项是一个整数)。 使用 ensure_value() 意味着使用你的动作的脚本无需关心为相应的选项目标设置默认值;可以简单地保持默认的 Noneensure_value() 将在必要时负责为其设置适当的值。

异常

exception optparse.OptionError

当使用无效或不一致的参数创建 Option 实例时将被引发。

exception optparse.OptionConflictError

当向 OptionParser 添加相互冲突的选项时将被引发。

exception optparse.OptionValueError

当在命令行中遇到无效的选项值时将被引发。

exception optparse.BadOptionError

当在命令行中传入无效的选项时将被引发。

exception optparse.AmbiguousOptionError

当在命令行中传入有歧义的选项时将被引发。