首页 > 后端开发 > Python教程 > 如何创建Wikipedia CLI

如何创建Wikipedia CLI

DDD
发布: 2025-01-25 00:13:09
原创
998 人浏览过

How to Create a Wikipedia CLI

使用Python和维基百科API构建维基百科命令行工具

创建一个维基百科命令行界面 (CLI) 工具是一个很有成就感项目,它结合了Python的简洁性和维基百科庞大的知识库。本教程将逐步指导您如何构建一个使用其API从维基百科获取信息的CLI工具。


先决条件

开始之前,请确保您拥有以下内容:

  • 系统上安装了Python 3.7或更高版本。
  • Python的基础知识和API的使用经验。
  • 用于访问维基百科API的互联网连接。

第一步:了解维基百科API

维基百科在 https://www.php.cn/link/27bf6226213cf288dfbf62ffc02bad4f 提供了一个RESTful API。此API允许开发人员查询维基百科的内容、元数据等等。我们将使用的关键端点包括:

  • action=query:从维基百科获取一般内容。
  • list=search:按关键字搜索文章。
  • prop=extracts:检索文章摘要。

所有API请求的基本URL为:

<code>https://www.php.cn/link/27bf6226213cf288dfbf62ffc02bad4f</code>
登录后复制

第二步:设置Python环境

首先创建一个Python虚拟环境并安装所需的库。我们将使用requests进行HTTP请求,使用argparse处理CLI参数。

<code># 创建虚拟环境
python -m venv wikipedia-cli-env

# 激活环境
# 在Windows上:
wikipedia-cli-env\Scripts\activate
# 在Mac/Linux上:
source wikipedia-cli-env/bin/activate

# 安装依赖项
pip install requests argparse</code>
登录后复制

第三步:规划CLI功能

我们的CLI工具将包括以下功能:

  1. 搜索维基百科文章:允许用户按关键字搜索文章。
  2. 获取文章摘要:检索特定文章的简短摘要。
  3. 查看CLI帮助:显示使用说明。

第四步:实现CLI工具

以下是CLI工具的Python代码:

<code class="language-python">import argparse
import requests

# 定义维基百科API的基本URL
WIKIPEDIA_API_URL = "https://www.php.cn/link/27bf6226213cf288dfbf62ffc02bad4f"

def search_articles(query):
    """搜索与查询匹配的维基百科文章。"""
    params = {
        'action': 'query',
        'list': 'search',
        'srsearch': query,
        'format': 'json',
    }
    response = requests.get(WIKIPEDIA_API_URL, params=params)
    response.raise_for_status()  # 对错误的响应引发错误
    data = response.json()

    if 'query' in data:
        return data['query']['search']
    else:
        return []

def get_article_summary(title):
    """获取维基百科文章的摘要。"""
    params = {
        'action': 'query',
        'prop': 'extracts',
        'exintro': True,
        'titles': title,
        'format': 'json',
    }
    response = requests.get(WIKIPEDIA_API_URL, params=params)
    response.raise_for_status()
    data = response.json()

    pages = data.get('query', {}).get('pages', {})
    for page_id, page in pages.items():
        if 'extract' in page:
            return page['extract']
    return "No summary available."

def main():
    parser = argparse.ArgumentParser(description="一个与维基百科交互的CLI工具。")
    subparsers = parser.add_subparsers(dest="command")

    # 子命令:search
    search_parser = subparsers.add_parser("search", help="在维基百科上搜索文章。")
    search_parser.add_argument("query", help="搜索查询。")

    # 子命令:summary
    summary_parser = subparsers.add_parser("summary", help="获取特定维基百科文章的摘要。")
    summary_parser.add_argument("title", help="维基百科文章的标题。")

    args = parser.parse_args()

    if args.command == "search":
        results = search_articles(args.query)
        if results:
            print("搜索结果:")
            for result in results:
                print(f"- {result['title']}: {result['snippet']}")
        else:
            print("未找到结果。")

    elif args.command == "summary":
        summary = get_article_summary(args.title)
        print(summary)

    else:
        parser.print_help()

if __name__ == "__main__":
    main()</code>
登录后复制

第五步:测试CLI工具

将脚本保存为wikipedia_cli.py。您现在可以从终端运行该工具:

  1. 搜索文章:
<code>python wikipedia_cli.py search "Python programming"</code>
登录后复制
  1. 获取文章摘要:
<code>python wikipedia_cli.py summary "Python (programming language)"</code>
登录后复制

第六步:增强工具

为了使工具更强大和用户友好,请考虑添加以下内容:

  1. 错误处理:为失败的API请求提供详细的错误消息。
  2. 格式化:使用诸如rich之类的库来获得更漂亮的输出。
  3. 缓存:实现缓存以避免对相同查询的重复API调用。
  4. 附加功能:添加对获取相关文章、类别或图像的支持。

结论

您已成功使用Python及其API构建了一个维基百科CLI工具!此工具可以作为更高级项目的良好起点,例如将其集成到其他应用程序中或创建GUI版本。祝您编码愉快!

以上是如何创建Wikipedia CLI的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:php.cn
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板