docopt库实现的命令行参数解析与自动生成帮助文档

docopt 是一个用于解析命令行参数和自动生成帮助文档的 Python 库。它使用简洁的语法来定义命令行参数，并自动生成帮助文档，从而使命令行参数的解析和文档编写变得非常简单。

下面是一个使用 docopt 的示例：

"""Usage: example.py [-h] [--version] [--name=<name>] [--age=<age>] [--gender=<gender>]

Options:
  -h --help         显示帮助信息
  --version         显示版本号
  --name=<name>     设置姓名
  --age=<age>       设置年龄
  --gender=<gender> 设置性别
"""

from docopt import docopt

if __name__ == '__main__':
    args = docopt(__doc__, version='1.0')

    name = args['--name']
    age = args['--age']
    gender = args['--gender']

    print(f'姓名：{name}')
    print(f'年龄：{age}')
    print(f'性别：{gender}')

在上面的例子中，我们定义了一个简单的命令行参数解析脚本。在脚本的开头，我们使用 docopt 定义了命令行参数的语法和帮助文档。

在脚本的主体部分，我们调用 docopt(__doc__, version='1.0') 来解析命令行参数。__doc__ 是 Python 内置的一个特殊变量，表示当前模块的文档字符串。传递 version='1.0' 参数可以指定版本号。

docopt 函数会返回一个字典，其中包含解析得到的参数值。我们可以通过字典的键来访问这些参数值。

在上面的例子中，我们通过 args['--name']、args['--age'] 和 args['--gender'] 来获取用户传入的姓名、年龄和性别。

最后，我们打印这些参数的值。

当我们运行这个脚本时，我们可以使用帮助选项 -h 或 --help 来显示帮助文档，使用 --version 来显示版本号。

例如，我们可以运行 python example.py --help 来查看帮助文档。

Usage: example.py [-h] [--version] [--name=<name>] [--age=<age>] [--gender=<gender>]

Options:
  -h --help         显示帮助信息
  --version         显示版本号
  --name=<name>     设置姓名
  --age=<age>       设置年龄
  --gender=<gender> 设置性别

我们还可以使用命令行选项来传递参数值。例如，我们可以运行 python example.py --name='Alice' --age=25 --gender='female' 来设置姓名为 "Alice"，年龄为 25，性别为 "female"。然后，脚本会打印这些参数的值：

姓名：Alice
年龄：25
性别：female

通过使用 docopt，我们可以轻松地定义命令行参数的语法和帮助文档，并快速解析命令行参数的值。这大大简化了命令行应用程序的开发和使用。