什么是 optparse？

optparse 是 Python 标准库中的一个模块，用于解析命令行选项和参数，它提供了一种强大、灵活且易于使用的方式来为你的脚本添加命令行接口。

重要提示： optparse 从 Python 3.2 开始被弃用，并在 Python 3.11 中被移除，官方推荐使用更现代、更灵活的 argparse 模块。新项目应该优先使用 argparse。

理解 optparse 仍然有价值，原因如下：

1. 维护旧代码：你可能需要维护或阅读使用 optparse 的旧项目。
2. 学习基础：optparse 的概念相对简单，理解它有助于快速掌握 argparse 中的核心思想（如选项、参数、动作等）。
3. 对比学习：通过对比 optparse 和 argparse，可以更好地理解后者在功能和易用性上的进步。

optparse 的基本用法

使用 optparse 通常遵循以下四个步骤：

1. 创建 OptionParser 实例：这是解析器对象。
2. 添加选项：使用 add_option() 方法向解析器添加你希望脚本接受的命令行选项。
3. 解析参数：使用 parse_args() 方法解析命令行传入的参数。
4. 使用解析结果：从解析结果中获取选项的值和位置参数。

示例 1：一个简单的脚本

我们从一个最简单的例子开始,创建一个名为 greet.py 的脚本。

# greet.py
from optparse import OptionParser
# 1. 创建 OptionParser 实例
parser = OptionParser()
# 2. 添加选项
# --name: 选项名，后跟一个等号表示需要一个值
# action="store": 表示将选项的值存储到某个变量中
# dest="name": 指定存储值的属性名
# help="...": 显示的帮助信息
parser.add_option("-n", "--name", dest="name", action="store", help="Your name to greet")
# 3. 解析参数
# parse_args() 会返回两个值：
#   - options: 一个对象，包含所有选项的值
#   - args: 一个列表，包含所有没有被识别为选项的位置参数
(options, args) = parser.parse_args()
# 4. 使用解析结果
if options.name:
    print(f"Hello, {options.name}!")
else:
    # 如果用户没有提供 --name 选项，打印帮助信息并退出
    parser.print_help()
    # sys.exit(1) # 通常会这样退出，但这里为了演示只打印帮助

如何运行：

# 提供选项
$ python greet.py --name Alice
Hello, Alice!
# 使用短选项
$ python greet.py -n Bob
Hello, Bob!
# 不提供选项，会打印帮助信息
$ python greet.py
Usage: greet.py [options]
Options:
  -h, --help  show this help message and exit
  -n NAME, --name=NAME
                Your name to greet

optparse 核心组件详解

OptionParser 类

这是解析器的核心,当你创建它时，它会自动为你添加 -h 或 --help 选项，用于显示帮助信息。

parser = OptionParser()

add_option() 方法

这是添加选项的主要方法,非常灵活。

语法： parser.add_option(option_string1, option_string2, ..., keyword=value, ...)

常用参数：

• 选项字符串：如 -f, --file，短选项用一个短横线，长选项用两个短横线。
• action: 定义当解析器遇到该选项时应该执行的操作，这是最重要的参数。
  • "store" (默认): 将选项的值存储到 options 对象的指定属性中。
  • "store_true" / "store_false": 将值设置为 True 或 False，通常用于开关型选项。
  • "append": 将选项的值追加到一个列表中，可以多次使用该选项。
  • "count": 计算选项出现的次数，常用于增加详细级别，如 -v, -vv。
  • "callback": 调用一个自定义的函数来处理该选项。
  • "help" (默认): 显示帮助信息并退出。
  • "version": 显示版本信息并退出。
• dest: 指定将选项值存储在 options 对象中的属性名。action 是 "store_true" 或 "store_false"，dest 是必需的。
• type: 指定期望的参数类型，如 "string" (默认), "int", "float", "choice"，如果类型不匹配，optparse 会报错。
• default: 如果用户没有提供该选项，使用的默认值。
• help: 选项的帮助文本。-h 或 --help 会显示这些信息。
• metavar: 在帮助信息中显示的参数名称，它不影响解析，只用于美化输出。--name 的 metavar 可以是 USERNAME。
• choices: 一个列表，限制选项的值必须是列表中的某个元素。

示例 2：更复杂的选项

让我们创建一个更复杂的脚本 download.py，来演示更多 add_option 的用法。

# download.py
from optparse import OptionParser
parser = OptionParser()
# 1. store_true 选项，用于开关
parser.add_option("-v", "--verbose", dest="verbose", action="store_true",
                  default=False, help="Enable verbose output")
# 2. store_false 选项
parser.add_option("-q", "--quiet", dest="quiet", action="store_true",
                  default=False, help="Disable all output")
# 3. store 选项，带有类型和默认值
parser.add_option("-u", "--url", dest="url", type="string", default="http://example.com",
                  help="The URL to download from")
# 4. store 选项，限制选择范围
parser.add_option("-f", "--format", dest="format", type="choice", choices=["json", "xml", "csv"],
                  default="json", help="Output format (json, xml, or csv)")
# 5. append 选项，可以多次使用
parser.add_option("-H", "--header", dest="headers", action="append", default=[],
                  help="Add a custom HTTP header (e.g., 'Authorization: Bearer token')")
# 6. count 选项，用于控制详细级别
parser.add_option("-d", "--debug", dest="debug_level", action="count", default=0,
                  help="Increase debug level (e.g., -d, -dd, -ddd)")
(options, args) = parser.parse_args()
print("--- Options Parsed ---")
print(f"Verbose: {options.verbose}")
print(f"Quiet: {options.quiet}")
print(f"URL: {options.url}")
print(f"Format: {options.format}")
print(f"Headers: {options.headers}")
print(f"Debug Level: {options.debug_level}")
print("----------------------")

如何运行：

# 运行默认值
$ python download.py
--- Options Parsed ---
Verbose: False
Quiet: False
URL: http://example.com
Format: json
Headers: []
Debug Level: 0
----------------------
# 使用多种选项
$ python download.py -u http://api.test.com -f xml -H "X-API-Key: 123" -H "X-Client: MyApp" -vv
--- Options Parsed ---
Verbose: False
Quiet: False
URL: http://api.test.com
Format: xml
Headers: ['X-API-Key: 123', 'X-Client: MyApp']
Debug Level: 2
----------------------
# 尝试无效的 choice
$ python download.py -f yaml
Usage: download.py [options]
Options:
  -h, --help            show this help message and exit
  -v, --verbose         Enable verbose output
  -q, --quiet           Disable all output
  -u URL, --url=URL     The URL to download from
  -f {json,xml,csv}, --format={json,xml,csv}
                        Output format (json, xml, or csv)
  -H HEADER, --header=HEADER
                        Add a custom HTTP header (e.g., 'Authorization:
                        Bearer token')
  -d, --debug           Increase debug level (e.g., -d, -dd, -ddd)
download.py: error: option -f: invalid choice: 'yaml' (choose from 'json', 'xml', 'csv')

为什么 argparse 更好？（optparse 的局限性）

了解 argparse 的优势，能让你明白为什么它取代了 optparse。

1. 子命令支持：argparse 内置了对子命令（如 git commit, git push）的优雅支持，而 optparse 处理起来非常笨拙。
2. 更好的帮助信息：argparse 的帮助信息格式更清晰、更美观，并且可以更好地组织。
3. 更丰富的动作：argparse 有更多内置的动作，如 store_const, append_const, extend 等，提供了更大的灵活性。
4. 更自然的 API：argparse 的 API 设计更符合直觉，位置参数可以直接定义，而不需要通过 args 列表手动处理。
5. 类型转换更强大：argparse 的 type 参数可以接受任何可调用对象，你可以轻松实现自定义的类型检查和转换逻辑。
6. 互斥组：argparse 提供了 add_mutually_exclusive_group()，可以轻松定义互斥的选项（如 --input 和 --output 不能同时使用），这在 optparse 中需要手动检查。

optparse vs argparse 快速对比

optparse 是一个曾经非常强大和流行的命令行解析工具，它的核心思想——定义选项、解析参数、获取结果——至今仍然有效。

由于 argparse 在功能、易用性和可扩展性上的全面超越，optparse 已经完成了它的历史使命，作为 Python 开发者，你应该：

• 对于新项目：毫不犹豫地选择 argparse。
• 对于维护旧项目：理解 optparse 的工作原理，能够读懂和修改相关代码。
• 作为学习：将 optparse 作为学习命令行参数解析的入门工具，然后平滑过渡到 argparse。