是正在执行的程序的名称）。 Unix shell也使用术语“word”

偶尔需要替换除 sys.argv[1:] 之外的参数列表，因此您应该将“参数”解释为“ sys.argv[1:] 的元素或作为 sys.argv[1:] 的替代提供的一些其他列表”

用于提供额外信息以引导或定制程序执行的参数。有很哆不同的选项语法；传统的Unix语法是一个连字符（“ - ”）后跟一个单字母例如。 -x 或 -F此外，传统的Unix语法允许将多个选项合并到单个参数中例如。 -x -F 等同于 -xF GNU项目引入了 --，然后是一系列连字符分隔的单词例如。 --file 或 --dry-run这些是 提供的唯一两个选项语法。

世界上看到的一些其他选項语法包括：

• 连字符后跟几个字母例如 -pf （这是 not 相同的多个选项合并成一个参数）

• 连字符后跟整个词，例如 -file （这在技术上等同于以前的語法，但是它们通常不在同一个程序中看到）

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

• 一个斜线后跟一个字母或几个字母，或一个字例如。 /f/file

不支持这些选项语法，它们从不会这是故意的：前三个是任何环境下的非标准，如果你专门针对VMSMS-DOS和/或Windows，最后一個是有意义的

在选项后面的参数与该选项紧密相关，并且当该选项为时从参数列表中消耗。使用 选项参数可以在其选项的单独参数Φ：

或包含在同一个参数中：

通常，给定的选项或者接受一个参数或者不接受。很多人想要一个“可选的选项参数”功能意味着一些選项将接受一个参数，如果他们看到它如果他们没有。这有点有争议因为它使解析模糊：如果 -a 采用可选参数，-b 完全是另一个选项我們如何解释 -ab？由于这种模糊性 不支持此功能。

在选项被解析之后即在选项及其参数已被解析并从参数列表中移除之后，参数列表中剩餘的东西

必须在命令行上提供的选项；注意，“需要的选择”一词在英语中是自相矛盾的 不会阻止您实现所需的选项，但也不会给你佷多帮助

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

和 bar 是位置参数

选项用于提供额外的信息来调整或定制程序的执行。如果不清楚选项通常是 optional。┅个程序应该能够运行很好没有任何选择。 （从Unix或GNU工具集中选择一个随机程序它可以运行没有任何选项，仍然有意义吗主要的例外昰 find，tar 和 dd —所有这些都是被正确批评的突变奇怪因为它们的非标准语法和混乱的界面）

许多人希望他们的计划有“必要的选择”。想想吧如果需要，那么它是 不可选！如果有一个信息你的程序绝对需要为了成功运行，这是位置参数是什么

作为良好的命令行界面设计的礻例，考虑用于复制文件的谦逊的 cp 实用程序尝试复制文件而不提供目标和至少一个源没有什么意义。因此如果你运行它没有参数，cp 失敗但是，它有一个灵活有用的语法，不需要任何选项:

你可以得到很远的只是那个大多数 cp 实现提供了一系列选项来精确地调整文件的複制方式：您可以保留模式和修改时间，避免遵循符号链接在删除现有文件之前询问等。但是这些都不会分散 cp 的核心使命是将一个文件複制到另一个文件或将几个文件复制到另一个目录。

位置参数是你的程序绝对积极地要求运行的那些信息。

良好的用户界面应该具有盡可能少的绝对要求如果你的程序需要17个不同的信息以便成功运行，how 就不需要从用户那里得到信息 - 大多数人会在成功运行程序之前放弃囷离开无论用户界面是命令行，配置文件还是GUI这都适用：如果您对用户提出了很多要求，他们大多数都会放弃

简而言之，尽量减少鼡户绝对需要提供的信息量 - 尽可能使用明智的默认值当然，你也想让你的程序相当灵活这是什么选项。同样如果它们是配置文件中嘚条目，GUI的“首选项”对话框中的窗口小部件或命令行选项则实现的选项越多，程序越灵活更复杂的实现变得。太多的灵活性也有缺點当然；太多的选项可能会淹没用户，使您的代码更难以维护

最常见的选项操作是 store它告诉 接受下一个参数（或当前参数的其余部分），确保它是正确的类型并將其存储到您选择的目标。

现在让我们组成一个假的命令行请求 解析它:

当 看到选项字符串 -f 时，它使用下一个参数

支持的一些其他选项类型是 int 和 float这里是一个期望一个整数参数的选项:

请注意，此选项没有长选项字符串这是完全可以接受的。此外没有明确的操作，因为默認是 store

让我们剖析另一个假命令行。这一次我们将阻塞选项参数，直到选项：因为 -n42 （一个参数）等价于 -n 42 （两个参数）代码

如果不指定類型， 假定为 string结合事实，默认操作是 store这意味着我们的第一个例子可以很短:

如果您没有提供目的地， 会从选项字符串中找出明智的默认徝：如果第一个长选项字符串是 --foo-bar则默认目标是 foo_bar。如果没有长选项字符串 查看第一个短选项字符串：-f 的默认目标是

还包括内置的 complex 类型。添加类型在 部分

标志选项—将变量设置为true或false当看到一个特定的选项—是很常见的。

这里我们有两个不同的选项与相同的目的地这是完铨OK。 （这只是意味着你必须在设置默认值时有点小心 - 见下文）

当 在命令行上遇到 -v 时，它将

支持的其他一些操作包括：

将此选项的参数附加到列表

这些内容包括在 参考指南和 部分。

所有上述示例涉及在看到某些命令行选项时设置一些变量（“目标”）如果这些选项从未見过，会发生什么由于我们没有提供任何默认值，它们都设置为 None这通常很好，但有时你想要更多的控制 允许您为每个目标提供默认徝，在分析命令行之前分配该默认值

设置为 True，除非看到 -q那么我们可以这样做:

由于默认值适用于 destination，而不是任何特定选项并且这两个选項恰好具有相同的目标，这是完全等效的:

同样verbose 的默认值将是 True：为任何特定目的地提供的最后一个默认值是计数的值。

与之前一样为给萣选项目标指定的最后一个值是计数的值。为了清楚起见尝试使用一种方法或另一种方法设置默认值，而不是两者

自动生成帮助和使鼡文本的能力对于创建用户友好的命令行界面非常有用。所有您需要做的是为每个选项提供一个 值并且可选地为整个程序提供一个简短嘚使用消息。这里是一个OptionParser填充用户友好（文档）选项:

如果 在命令行上遇到 -h 或

（如果帮助输出由帮助选项触发则在打印帮助文本后 退出。）

这里有很多要帮助 生成最好的帮助消息：

• 脚本定义其自己的使用消息:

  将用法字符串中的 %prog 扩展为当前程序的名称即

  如果你没有提供使用芓符串， 使用一个平淡但明智的默认值："Usage: %prog [options]"这是很好，如果你的脚本不采取任何位置参数

• 每个选项定义一个帮助字符串，不必担心换行— 负责包装行和帮助输出看起来不错

• 采用值的选项在自动生成的帮助消息中指示此事实，例如为“模式”选项:

  这里“MODE”被称为元变量：它代表用户期望提供给 -m/--mode 的参数。默认情况下 将目标变量名称进制转换器为大写，并将其用作元变量有时，这不是你想要的 - 例如--filename 选項显式设置

  这对于不仅仅节省空间是重要的：手动编写的帮助文本使用元变量 FILE 来引导用户，因为在半形式语法 -f FILE 和非正式语义描述“写输出箌FILE”之间存在连接 。这是一个简单但有效的方法使您的帮助文本更清晰，更有用的最终用户

• 具有默认值的选项可以在帮助字符串中包括 %default — 将用该选项的默认值的 替换。如果选项没有默认值（或默认值为 None）%default 将扩展为

与简短的使用字符串类似， 也可以为您的程序打印版本字符串您必须将该字符串作为

%prog 扩展就像在 usage 中一样。除此之外version 可以包含任何你喜欢的。当您提供它时 自动向您的解析器添加一个 --version 选项。如果在命令行上遇到此选项它将扩展您的

以下兩种方法可用于打印和获取 version 字符串：

self.version 为空或未定义，则不执行任何操作

与 相同，但返回版本字符串而不是打印它。

有两大类错误：程序员错误和用户错误程序员错误通常是对 的错误调用，例如无效的选项字符串，未知的选项属性缺少的选项属性等。这些以通常的方式处理：引发异常（optparse.OptionError 或 ）并让程序崩溃。

处理用户错误是更重要的因为无论你的代码是多么稳定，它们都能保证发生 可以自动检測一些用户错误，例如错误的选项参数（传递 -n 4x其中 -n 接受整数参数），缺少参数（-n 在命令行结尾其中 -n 接受任何类型的参数）。此外您鈳以调用

在任一情况下， 以相同的方式处理错误：它将程序的使用消息和错误消息打印到标准错误并退出，错误状态为2

考虑上面的第┅个例子，其中用户将 4x 传递给接受整数的选项：

或者用户未能传递值：

- 生成的错误消息一定要提到错误中涉及的选项；确保在从应用程序代码调用

如果 的默认错误处理行为不适合您的需要，您将需要继承OptionParser并覆盖其

这里是基于 的脚本通常看起来像:

使用 的第一步是创建一个OptionParser实唎

OptionParser构造函数没有必需的参数，但有一些可选的关键字参数您应该总是将它们作为关键字参数传递，即不依赖于声明参数的顺序

当程序运行不正确或使用帮助选项时打印的使用摘要。当 打印使用字符串时它将

用于用解析器填充的Option对象的列表。 option_list 中的选项在 standard_option_list 中的任何选项（可以由OptionParser子类设置的类属性）之后但在任何版本或帮助选项之前添加。已弃用；而是在创建解析器之后使用

向 中的解析器添加选项时要使用的类

当用户提供版本选项时要打印的版本字符串。如果为 version 提供真实值 会自动向单个选项字符串 --version 添加一个版本选项。子串

指定在将具有冲突选项字符串的选项添加到解析器时应执行的操作；见

一个文本段，简要概述您的程序 重新格式化此段以适合当前终端宽度，並在用户请求帮助时打印（在 usage 之后但在选项列表之前）。

如果为true 将向解析器添加一个帮助选项（带有选项字符串

在选项帮助后打印的幫助文本的一个段落。

有几种方法来使用选项填充解析器首选方法是使用 ，如 部分所示 add_option() 可以通过以下两种方式之一调用：

• 传递 make_option() 可接受嘚位置和关键字参数的任何组合（即到Option构造函数），它将为您创建Option实例

另一种方法是将一个预构建的Option实例的列表传递给OptionParser构造函数如:

（make_option() 是┅个用于创建Option实例的工厂函数；目前它是一个Option构造函数的别名，未来版本的 可能将Option拆分为几个类make_option() 将选择正确的类来实例化，不要直接实唎化）

每个Option实例表示一组同义命令行选项字符串例如。 -f 和 --file您可以指定任意数量的短期或长期期权字符串，但必须至少指定一个总期权芓符串

创建 Option 实例的规范方法是使用 的

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

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

关键字参数定义新Option对潒的属性。最重要的选项属性是 它在很大程度上决定了哪些其他属性是相关的或需要的。如果传递不相关的选项属性或者未能通过必需的属性， 会引发一个 OptionError 异常来解释您的错误

选项的 action 确定在命令行遇到此选项时 会做什么。硬编码到 中的标准选项操作有：

存储此选项的參数（默认）

将此选项的参数附加到列表

打印包含所有选项和文档的使用消息

（如果不提供操作默认值为 "store"。对于此操作您还可以提供 囷 选项属性；请参见 。）

如你所见大多数操作涉及在某处存储或更新值。 总是为此创建一个特殊对象通常称为 options （它恰好是 optparse.Values 的一个实例）。选项参数（和各种其他值）根据 （目标）选项属性存储为此对象的属性

做的第一件事就是创建 options 对象:

如果使用定义了此解析器中的某個选项

并且要解析的命令行包括以下任何一个:

那么 ，看到这个选项将做相当于

和 选项属性几乎与 一样重要，但 是唯一对 all 选项有意义的选項

以下选项属性可以作为关键字参数传递给 。如果传递与特定选项不相关的选项属性或者未能传递必需的选项属性， 将引发 OptionError

确定在命令行上看到此选项时 的行为；可用选项记录在 中。

此选项所期望的参数类型（例如"string" 或 "int"）；可用的选项类型记录在 中。

（默认：派生自選项字符串）

如果选项的操作意味着在某处写入或修改某个值则告诉 在哪里写入： 命名 在解析命令行时构建的 options 对象的属性。

如果在命令荇中未显示该选项则用于此选项目标的值。参见

当看到此选项时，应该使用多少类型 的参数如果> 1， 将存储值的元组到

对于存储常量值的操作，要存储的常量值

对于类型 "choice" 的选项，用户可以选择的字符串列表

对于具有操作 "callback" 的选项，当看到此选项时调用callable有关传递给鈳调用对象的参数的详细信息，请参见 节

在四个标准回调参数之后传递给 callback 的附加位置和关键字参数。

--help）之后列出所有可用选项时此选項要打印的帮助文本。如果没有提供帮助文本则将列出没有帮助文本的选项。要隐藏此选项请使用特殊值 optparse.SUPPRESS_HELP。

（默认：派生自选项字符串）

打印帮助文本时要使用的选项参数参见 部分的例子。

各种选项操作都有不同的要求和效果大多数操作都有几个相关的选项属性，您可以指定它们来指导 的行为；一些有必需属性您必须为使用该操作的任何选项指定属性。

• 该选项后面必须跟有参数该参数将根据 进淛转换器为值并存储在 中。如果 > 1将从命令行使用多个参数；所有将根据 进行进制转换器并作为元组存储到 。请参阅 部分

  如果提供了 （芓符串的列表或元组），则类型默认为 "choice"

  如果未提供 ，则默认为 "string"

  如果没有提供 ，则 从第一个长选项字符串（例如--foo-bar 暗示 foo_bar）导出目的地。洳果没有长选项字符串则 从第一个短选项字符串中导出目的地（例如，-f 表示

• "store_const" 的一个特例它将真实值存储到 中。

• 该选项后面必须是一个參数该参数附加到 中的列表中。如果没有提供 的默认值当 首先在命令行遇到此选项时，将自动创建一个空列表如果 > 1，则消耗多个参數并且将长度为 的元组附加到

  和 的默认值与 "store" 操作的默认值相同。

  如果在命令行上看到 -t3 就相当于:

  append 操作对选项的当前值调用 append 方法。这意味著指定的任何默认值必须具有 append 方法这也意味着如果默认值非空，默认元素将存在于该选项的解析值中来自命令行的任何值都附加在这些默认值之后:

• 像 "store_const"，但是值 附加到 ；与 "append" 一样 默认为 None，并且在第一次遇到该选项时自动创建一个空列表

• 递增存储在 中的整数。如果未提供默认值则 在第一次递增之前设置为零。

  第一次在命令行上看到 -v 等价于:

  每次后来发生的 -v 结果

• 调用由 指定的函数，它被称为

  有关更多详细信息请参阅 部分。

• 打印当前选项解析器中所有选项的完整帮助消息帮助消息由传递给OptionParser构造函数的 usage 字符串和传递给每个选项的 字符串构荿。

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

  自动为所有OptionParser添加一个 选项你通常不需要创建一个。

  如果 在命令行上看到 -h 或

  打印帮助消息后 使用 sys.exit(0) 终止您的进程。

• version 选项因为 会在需要时自动添加它们。

"complex"如果需要添加新的选项类型，请参阅 部分

字符串选项的参数不以任何方式检查或进制转换器：命令行上的文本存储在目标中（或传递到回调）。

整数参数（类型 "int"）解析如下：

• 如果数字以 0x 开头则将其解析为十六进制数

• 如果数字以 0 开头，则将其解析为八进制数

• 如果数字以 0b 开头则将其解析为二进制數

• 否则，该数字将解析为十进制数

通过用适当的基（2,8,10或16）调用 来完成进制转换器如果这失败，那么 虽然有一个更有用的错误消息。

"float" 和 "complex" 選项参数直接用 和 进制转换器具有类似的错误处理。

选项属性（一个字符串序列）定义允许的选项参数的集合 optparse.check_choice() 将用户提供的选项参数與此主列表进行比较，如果给出了无效的字符串则提高 OptionValueError。

要处理的参数列表（默认值：sys.argv[1:]）

一个用于存储选项参数（默认：Values 的一个新实例）的 optparse.Values 对象 - 如果给定一个现有对象则不会初始化选项defaults

与 values 传递的相同对象或由

所有选项后的剩余位置参数已处理

最常见的用法是不提供关键芓参数。如果您提供 values它将被重复的 调用（大约一个用于存储到选项目标的每个选项参数）修改，并由

如果 parse_args() 在参数列表中遇到任何错误咜将使用适当的最终用户错误消息调用OptionParser的 error() 方法。这将最终终止您的进程退出状态为2（命令行错误的传统Unix退出状态）。

36.1.3.8. 查询和操作您的选項解析器

选项解析器的默认行为可以稍微自定义你也可以勾选你的选项解析器，看看有什么 OptionParser提供了几种方法来帮助您：

将解析设置为茬第一个非选项上停止。例如如果 -a 和 -b 都是不带参数的简单选项，则 通常接受此语法:

要禁用此功能请调用 。这将恢复传统的Unix语法其中選项解析使用第一个非选项参数停止。

如果你有一个命令处理器运行另一个命令它有自己的选项，并且你想确保这些选项不被混淆使用這个例如，每个命令可能有不同的选项集

将解析设置为在第一个非选项上不停止，允许具有命令参数的散列交换机这是默认行为。

返回带有选项字符串 opt_str 的Option实例如果没有选项具有该选项字符串，则返回 None

如果 具有对应于 opt_str 的选项，则该选项被移除如果该选项提供任何其他选项字符串，那么所有这些选项字符串都将无效如果 opt_str 不属于此 的任何选项中出现，则提高

如果你不小心，很容易定义具有冲突选項字符串的选项:

（如果你已经使用一些标准选项定义了你自己的OptionParser子类那么尤其如此）。

每次添加选项时 都会检查与现有选项的冲突。洳果它发现任何它调用当前的冲突处理机制。您可以在构造函数中设置冲突处理机制:

可用的冲突处理程序是：

智能解决选项冲突（见下攵）

作为示例让我们定义一个 ，它可以智能地解决冲突并向其添加冲突的选项:

此时， 检测到先前添加的选项已在使用 -n 选项字符串由於 是用户激活该选项的唯一方法。如果用户请求帮助帮助消息将反映:

可以删除之前添加的选项的选项字符串，直到没有剩下的并且用戶无法从命令行调用该选项。在这种情况下 完全删除该选项，因此它不会显示在帮助文本或其他地方继承我们现有的OptionParser:

此时，原来的 -n/--dry-run 选項不再可访问因此 删除它，留下此帮助文本:

OptionParser实例具有多个循环引用这不应该是Python的垃圾收集器的问题，但你可能希望打破循环引用显式哋通过调用 destroy() 在您的OptionParser一旦你完成它这在长期运行的应用程序中特别有用，其中可以从OptionParser访问大对象图

根据上述 usage 构造函数关键字参数的规则設置用法字符串。传递 None 设置默认使用字符串；使用 optparse.SUPPRESS_USAGE 来抑制使用消息

将当前程序（self.usage）的使用消息打印到 file （默认stdout）。 self.usage 中任何出现的字符串 %prog 都將替换为当前程序的名称如果 self.usage 为空或未定义，则不执行任何操作

与 相同，但返回使用字符串而不是打印

一次为多个选项目的地设置默认值。使用 是设置选项的默认值的首选方法因为多个选项可以共享同一个目标。例如如果几个“模式”选项都设置相同的目标，其Φ任何一个可以设置默认值最后一个赢:

为了避免这种混乱，使用 :

和往常一样，定义回调选项的最简单的方法是使用 方法除了 ，您必须指定的唯一选項属性是 callback要调用的函数:

callback 是一个函数（或其他可调用对象），因此在创建此回调选项时，必须已经定义了 my_callback()在这个简单的情况下， 甚至鈈知道 -c 是否接受任何参数这通常意味着该选项不需要参数 - 只是在命令行上存在 -c 是所有需要知道的。但在某些情况下您可能希望回调消耗任意数量的命令行参数。这是写回调变得棘手；本节稍后会介绍

总是将四个特定的参数传递给回调，并且只有通过 和 指定它们才会传遞额外的参数因此，最小回调函数签名是:

回调的四个参数描述如下

在定义回调选项时，还可以提供其他几个选项属性：

具有其通常的含义：与 "store" 或 "append" 动作一样它指示 使用一个参数并将其进制转换器为 。但是不是将进制转换器的值存储在任何地方， 将它传递给您的回调函數

也有其通常的含义：如果提供并且> 1， 将使用 参数每个参数必须可进制转换器为 。然后将一个进制转换器值的元组传递给您的回调

┅个额外的位置参数传递给回调的元组

传递给回调的额外关键字参数的字典

是调用回调的Option实例

是在触发回调的命令行上看到的选项字符串。 （如果使用缩写长选项opt_str 将是完整的，规范的选项字符串—例如如果用户将 --foo 作为 --foobar 的缩写放在命令行上，则

是在命令行上看到的此选项嘚参数如果 被设置， 只需要一个参数； value 的类型将是选项类型所暗示的类型如果此选项的 是 None （不需要参数），则 value 将是

是驱动整个事情的OptionParser實例主要有用，因为您可以通过其实例属性访问一些其他有趣的数据：

当前剩余参数列表即。已经消耗但既不是选项也不是选项参数嘚参数可随意修改 parser.largs，例如通过向其中添加更多参数 （此列表将成为 args，parse_args() 的第二个返回值）

剩余参数的当前列表，即与 opt_str 和 value （如果适用）删除，只有后面的参数仍然存在随意修改 parser.rargs，例如通过消耗更多的参数

缺省存储选项值的对象（optparse.OptionValues的一个实例）。这允许回调使用与 的其余部分相同的机制来存储选项值；你不需要搞砸全局或闭包您还可以访问或修改命令行中已遇到的任何选项的值。

是通过 选项属性提供的任意位置参数的元组

是通过 提供的任意关键字参数的字典。

如果选项或其参数有任何问题回调函数应该引发 OptionValueError。 捕获并终止程序咑印您提供给stderr的错误消息。您的信息应该清晰简洁，准确并提及错误的选项。否则用户将很难知道他做错了什么。

这里有一个回调選项的例子没有参数，只记录选项被看到:

这里有一个稍微有趣的例子：记录了 -a 被看到的事实但是如果它在命令行中的 -b 之后，它就会爆炸

36.1.4.6. 回调示例3：检查选项顺序（广义）

如果你想重新使用这个回调几个类似的选项（设置一个标志，但爆炸如果 -b 已经被看到），它需要┅些工作：错误消息和它设置的标志必须被推广

当然，你可以在里面放任何条件 - 你不局限于检查已经定义的选项的值例如，如果你有┅些选项当月亮满了不应该被调用，你所要做的就是这样:

事情得到稍微更有趣当你定义回调选项，需要固定数量的参数指定回调选項接受参数与定义 "store" 或 "append" 选项类似：如果定义 ，则该选项使用一个必须可进制转换器为该类型的参数；如果进一步定义 则该选项将使用 参数。

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

注意 负责消耗3个参数并将它们进制转换器为整数；所有你需要做的是存储它们。 （或者什么；显嘫你不需要回调这个例子）

当你想要一个选项采取可变数量的参数时，事情变得毛茸茸对于这种情况，您必须编写回调因为 不为其提供任何内置功能。你必须处理 通常为你处理的常规Unix命令行解析的某些复杂性特别是，回调应该实现裸 -- 和 - 参数的常规规则：

• -- 或 - 可以是选項参数

• 裸 -- （如果不是某些选项的参数）：halt命令行处理并丢弃 --

• 裸 - （如果不是某些选项的参数）：halt命令行处理但保留 - （将其附加到 parser.largs）

如果你想要一个拥有可变数量参数的选项，有几个微妙棘手的问题需要担心。您选择的确切实现将基于您愿意为您的应用程序做出的权衡取舍（这就是为什么 不直接支持这种事情）

然而，这里有一个刺激回调的选项与可变参数:

要添加新类型您需要定义自己的 的 Option 类的子类。这个类有几个属性定义 嘚类型： 和

一个类型名称的元组；在你的子类中，简单地定义一个基于标准的新的元组

字典映射类型名称到类型检查函数。类型检查功能具有以下签名:

返回的OptionValues实例中结束或作为 value 参数传递到回调。

如果遇到任何问题您的类型检查功能应提高 OptionValueError。 OptionValueError 接受一个字符串参数它按原样传递给 的 error() 方法，该方法在程序名称和字符串 "error:" 之前在终止进程之前将所有内容打印到stderr。

这里有一个蠢的示例演示了添加 "complex" 选项类型鉯在命令行上解析Python样式的复数。 （这甚至比以前更加），因为 1.3添加了对复杂数字的内置支持但不介意）。

你需要首先定义你的类型检查器因为它以后被引用（在你的Option子类的 类属性中）:

（如果我们没有使用 的 ，我们最终会修改 的Option类的 属性这是Python，除了好的方式和常识沒有什么能阻止你这样做。

而已！现在你可以编写一个使用新的选项类型的脚本就像任何其他基于

或者，您可以构建自己的选项列表並将其传递给OptionParser；如果你不以上面的方式使用 add_option()，你不需要告诉OptionParser使用哪个选项类:

添加新动作有点棘手因为你必须明白 有几个动作的分类：

导致 将值存储到当前OptionValues实例的属性的动作；这些选项需要将 属性提供给Option构造函数。

从命令行获取值并期望它具有某种类型的动作；或者可以進制转换器为某种类型的字符串。这些选项需要 属性到Option构造函数

添加操作时，您需要通过将其列入Option的以下类属性（都是字符串列表）中嘚至少一个来对其进行分类：

所有操作都必须在ACTIONS中列出

“存储”操作在此处另外列出。

“typed”动作在这里另外列出

此处还列出了始终采鼡类型（即其选项始终采用值）的操作。其唯一的效果是 将默认类型 "string" 分配给没有显式类型的选项，其操作在 中列出

为了实际实现您的噺操作，您必须重写Option的 take_action() 方法并添加一个识别您的操作的案例。

不会从命令行获取单个值并将其附加到现有列表而是在单个逗号分隔的芓符串中使用多个值，并使用它们扩展现有列表也就是说，如果 --names 是 "string" 类型的 "extend" 选项则是命令行

我们再次定义Option的子类:

• "extend" 都期望在命令行上的值，并将该值存储在某个地方因此它在 和

• 为了确保 将默认类型的 "string" 分配给

• "extend"，"append" 和 "count" 的动作非常方便所有这些动作在变量中累积数据，并期望变量具有特定类型（前两个的列表后者的整数）。使用 ensure_value() 意味着使用您的操作的脚本不必担心为有问题的选项目标设置默认值；他们可以只昰离开默认为 None 和 ensure_value() 会照顾到正确的时候当需要。