gracy：Python 最优雅的 API 客户端框架

gracy：Python 最优雅的 API 客户端框架

项目介绍

在当今的软件开发中，API 交互是构建应用程序不可或缺的一部分。然而，处理 HTTP 请求的失败、日志、重试、限流、解析和报告往往是一件繁琐且容易出错的工作。Gracy 是一个 Python 的 API 客户端框架，旨在简化这些复杂的任务，让你能够专注于你的应用程序的核心逻辑。

Gracy 使用 httpx 作为底层库，提供了丰富的功能，如自动重试请求、请求限流、自动解析响应内容等，同时支持异步操作，使得处理 HTTP 请求变得更加高效和优雅。

项目技术分析

Gracy 的设计理念是简单、灵活和可扩展。以下是项目的一些技术亮点：

• 自动重试：Gracy 可以根据预设的策略自动重试失败的请求。
• 请求限流：通过内置的限流机制，Gracy 可以避免过多的并发请求压垮服务器。
• 响应解析：自动解析 JSON 响应，并支持自定义解析器。
• 日志记录：提供详细的日志记录功能，帮助开发者追踪请求过程。
• 类型注解：利用 Python 的类型注解，Gracy 提供了更安全、更可读的代码。
• 配置自定义：Gracy 允许开发者自定义各种配置，如重试策略、限流设置等。

项目技术应用场景

Gracy 适用于任何需要与 RESTful API 交互的场景，以下是一些典型的应用案例：

• Web 应用程序：构建与后端服务的交互逻辑。
• 微服务架构：在微服务之间进行数据同步和通信。
• 数据抓取：从第三方 API 抓取数据进行分析或展示。
• 自动化测试：在自动化测试中模拟 API 请求。

项目特点

1. 易于使用：Gracy 的 API 设计简洁直观，易于上手。
2. 性能卓越：基于异步 I/O，提供高效的请求处理能力。
3. 灵活配置：提供丰富的配置选项，满足不同场景的需求。
4. 自定义扩展：支持自定义解析器、验证器和重试逻辑。
5. 类型安全：通过类型注解提供代码的可读性和安全性。

下面是一个简单的使用例子：

import asyncio
from gracy import BaseEndpoint, Gracy, GracyConfig

class PokeApiEndpoint(BaseEndpoint):
    GET_POKEMON = "/pokemon/{NAME}"

class GracefulPokeAPI(Gracy[str]):
    class Config:
        BASE_URL = "https://pokeapi.co/api/v2/"
        SETTINGS = GracyConfig(
            log_request=LogEvent(LogLevel.DEBUG),
            log_response=LogEvent(LogLevel.INFO, "{URL} took {ELAPSED}"),
            parser={"default": lambda r: r.json()}
        )

    async def get_pokemon(self, name: str) -> dict:
        return await self.get(PokeApiEndpoint.GET_POKEMON, {"NAME": name})

async def main():
    pokeapi = GracefulPokeAPI()
    try:
        pokemon = await pokeapi.get_pokemon("pikachu")
        print(pokemon)
    finally:
        pokeapi.report_status("rich")

asyncio.run(main())

在上述代码中，我们定义了一个简单的 GracefulPokeAPI 类，它使用 Gracy 框架与 PokeAPI 进行交互。通过配置日志记录和默认的响应解析器，我们能够轻松地获取和打印出一个 Pokemon 的信息。

如果你正在寻找一个简单、强大且灵活的 Python API 客户端框架，Gracy 可能是你的理想选择。它的设计和功能可以极大地提高你处理 HTTP 请求的效率，让你的开发过程更加顺畅。立即尝试 Gracy，体验 Python API 开发的优雅之道！