你好开发社区！介绍PydanticRPC：构建GRPC并连接RPC服务，而无需手动编写Protobuf文件-Python教程-PHP中文网

你好开发社区！介绍PydanticRPC：构建GRPC并连接RPC服务，而无需手动编写Protobuf文件

DDD

发布： 2025-01-30 13:34:05

原创

1020人浏览过

pydanticrpc：无需protobuf文件即可构建grpc和连接rpc服务

你好开发社区！介绍PydanticRPC：构建GRPC并连接RPC服务，而无需手动编写Protobuf文件

本文介绍一个名为PydanticRPC的Python库，它能够自动生成gRPC或连接RPC服务，而无需手动编写Protobuf文件。该库简化了RPC服务的创建流程，提高了开发效率。

概述

在Python中构建REST API时，开发者通常会选择FastAPI或Flask等框架。然而，当需要更高效的数据通信或模式优先的方法时，gRPC或连接RPC是更理想的选择。传统的RPC系统开发流程通常包括：

定义.proto文件（Protocol Buffer）。
使用protoc或buf生成代码。
将生成的代码集成到应用程序中。

这个过程既繁琐又需要一定的学习成本。PydanticRPC旨在解决这个问题。

什么是PydanticRPC？

PydanticRPC是一个Python库，其核心功能包括：

自动生成Protobuf文件: 从Python类和Pydantic模型的签名中自动创建.proto文件。
动态代码生成: 内部使用grpcio-tools生成服务器/客户端存根，并将您的Python类绑定到这些存根。
支持gRPC、gRPC-Web、连接RPC和异步操作: 支持标准gRPC、gRPC-Web（由Sonora驱动）和连接RPC（由ConnecPy驱动），并支持异步（asyncio）用法，包括服务器流式方法。

简单来说，只需使用Pydantic模型编写Python类，即可立即获得RPC服务，无需手动处理.proto文件。

安装

PydanticRPC可通过pip安装：

<code class="bash">pip install pydantic-rpc</code>

登录后复制

用法：创建gRPC服务

可以使用pydantic_rpc.server创建gRPC服务器。

同步示例:

<code class="python"># server.py
from pydantic_rpc import server, message

class HelloRequest(message):
    name: str

class HelloReply(message):
    message: str

class Greeter:
    def say_hello(self, request: HelloRequest) -> HelloReply:
        return HelloReply(message=f"Hello, {request.name}!")

if __name__ == "__main__":
    server = server()
    server.run(Greeter())</code>

登录后复制

message是pydantic.BaseModel的别名。Greeter类包含要公开的方法。say_hello方法遵循(HelloRequest) -> HelloReply的签名。server.run(Greeter())会在运行时自动生成.proto文件并在localhost上启动gRPC服务器。

异步示例:

魔乐社区

天翼云和华为联合打造的AI开发者社区，支持AI模型评测训练、全流程开发应用

102

查看详情

对于异步服务器，使用asyncioserver，并使用async def定义方法：

<code class="python">import asyncio
from pydantic_rpc import asyncioserver, message

# ... (HelloRequest and HelloReply definitions remain the same) ...

class Greeter:
    async def say_hello(self, request: HelloRequest) -> HelloReply:
        return HelloReply(message=f"Hello, {request.name}!")

if __name__ == "__main__":
    server = asyncioserver()
    loop = asyncio.get_event_loop()
    loop.run_until_complete(server.run(Greeter()))</code>

登录后复制

server.run(Greeter())是一个协程，需要在事件循环中运行。

用法：使用PydanticRPC进行服务器流式响应

PydanticRPC支持服务器流式响应（目前仅在异步gRPC中支持）。

(示例代码略，与原文相同，此处省略为避免重复)

用法：创建连接RPC服务

PydanticRPC与ConnecPy集成，支持在ASGI应用程序中使用连接RPC。

(示例代码略，与原文相同，此处省略为避免重复)

用法：创建gRPC-Web服务

PydanticRPC也支持在WSGI或ASGI应用程序中使用gRPC-Web。

(示例代码略，与原文相同，此处省略为避免重复)

结论