简单易懂的docopt()使用教程（附带实例）

docopt是一个用于命令行解析的Python库，它可以帮助我们快速、简单地解析命令行参数，并生成帮助文档。

使用docopt非常简单，只需三个步骤：

1. 定义命令行参数和帮助文档字符串

2. 解析命令行参数

3. 使用解析后的参数进行相应的操作

下面我们以一个简单的例子说明如何使用docopt。

假设我们需要开发一个命令行工具，用于提取一篇文章中的单词，并统计每个单词的出现次数。

首先，在脚本文件的顶部，我们需要定义命令行参数和帮助文档字符串。命令行参数的格式如下：

wordcount.py FILE
wordcount.py (-h | --help)

其中FILE表示要提取单词的文章文件，(-h | --help)表示打印帮助文档。

对应的帮助文档字符串如下：

"""
Usage:
  wordcount.py FILE
  wordcount.py (-h | --help)

Options:
  -h --help     Show this screen.
"""

接下来，我们需要解析命令行参数。在main函数中，添加以下代码：

from docopt import docopt

def main():
    args = docopt(__doc__)
    print(args)

在这段代码中，docopt(__doc__)会根据帮助文档字符串解析命令行参数，并返回一个包含解析结果的字典。

最后，我们可以根据解析后的参数进行相应的操作。在main函数中，添加以下代码：

from docopt import docopt
from collections import Counter

def main():
    args = docopt(__doc__)
    # 打开文章文件，并读取内容
    with open(args['FILE'], 'r') as f:
        content = f.read()
    # 提取单词，并统计频率
    words = content.split()
    word_count = Counter(words)
    # 输出结果
    for word, count in word_count.items():
        print(f'{word}: {count}')

在这段代码中，我们首先使用open()函数打开文章文件，并读取其内容。然后，使用split()函数将文章内容分割成单词列表。接下来，使用Counter()函数统计每个单词的出现次数，并将结果存储在word_count中。最后，使用一个循环遍历word_count字典，输出每个单词及其出现次数。

现在我们已经完成了整个脚本的编写。接下来，我们可以在命令行中运行脚本，并传入合适的参数进行测试。

例如，我们可以使用以下命令行参数运行脚本：

python wordcount.py example.txt

这个命令将会打开名为example.txt的文件，并统计其中的单词出现次数。

使用docopt可以帮助我们快速、简单地解析命令行参数，并生成帮助文档。通过以上步骤，我们可以很容易地使用docopt解析命令行参数，并完成我们想要的操作。