Skip to main content

Aduib RPC - A Python library for Aduib AI RPC framework.

Project description

Aduib RPC

项目简介

Aduib RPC 是一个基于 Python 的远程过程调用(RPC)框架,支持 gRPC、JSON-RPC 和 REST 协议。该框架提供了客户端和服务端的完整实现,支持服务发现、负载均衡和认证等功能,特别适用于 AI 服务集成场景。

核心功能

  • 多协议支持:支持 gRPC、JSON-RPC 和 REST API
  • 服务发现:集成服务注册与发现机制
  • 负载均衡:支持多种负载均衡策略
  • 认证机制:提供客户端认证拦截器
  • 中间件支持:可扩展的中间件架构
  • 错误处理:统一的错误处理机制

目录结构

aduib_rpc/
├── src/aduib_rpc/
│   ├── client/            # 客户端实现
│   │   ├── auth/          # 认证相关
│   │   └── transports/    # 传输层实现
│   ├── discover/          # 服务发现
│   │   ├── entities/      # 实体定义
│   │   ├── load_balance/  # 负载均衡
│   │   ├── registry/      # 服务注册
│   │   └── service/       # 服务工厂
│   ├── grpc/              # gRPC 协议相关
│   ├── proto/             # 协议定义文件
│   ├── server/            # 服务端实现
│   └── utils/             # 工具函数
├── scripts/               # 辅助脚本
└── tests/                 # 测试用例

使用方法

  • 安装依赖:

     pip install aduib_rpc aduib_rpc[nacos]
    
  • 或者使用 uv 安装(推荐):

    uv add aduib_rpc aduib_rpc[nacos]
    

使用示例

客户端示例

import asyncio
import logging

import grpc

from aduib_rpc.client.auth import InMemoryCredentialsProvider
from aduib_rpc.client.auth.interceptor import AuthInterceptor
from aduib_rpc.client.base_client import ClientConfig, AduibRpcClient
from aduib_rpc.client.client_factory import AduibRpcClientFactory
from aduib_rpc.discover.registry.nacos.nacos import NacosServiceRegistry
from aduib_rpc.utils.constant import TransportSchemes

logging.basicConfig(level=logging.DEBUG)


async def main():
    registry = NacosServiceRegistry(server_addresses='10.0.0.96:8848',
                                    namespace='eeb6433f-d68c-4b3b-a4a7-eeff19110e', group_name='DEFAULT_GROUP',
                                    username='nacos', password='nacos')
    service_name = 'test_grpc_app'
    discover_service = await registry.discover_service(service_name)
    logging.debug(f'Service: {discover_service}')
    logging.debug(f'Service URL: {discover_service.url}')

    def create_channel(url: str) -> grpc.aio.Channel:
        logging.debug(f'Channel URL: {url}')
        return grpc.aio.insecure_channel(url)

    client_factory = AduibRpcClientFactory(
        config=ClientConfig(streaming=True, grpc_channel_factory=create_channel,
                            supported_transports=[TransportSchemes.GRPC]))
    aduib_rpc_client: AduibRpcClient = client_factory.create(discover_service.url,
                                                             server_preferred=TransportSchemes.GRPC, interceptors=[
            AuthInterceptor(credentialProvider=InMemoryCredentialsProvider())])
    resp = aduib_rpc_client.completion(method="chat.completions",
                                       data={"model": "gpt-3.5-turbo",
                                             "messages": [{"role": "user", "content": "Hello!"}]},
                                       meta={"model": "gpt-3.5-turbo",
                                             "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Safari/537.36 Edg/139.0.0.0"} | discover_service.get_service_info())
    async for r in resp:
        logging.debug(f'Response: {r}')


if __name__ == '__main__':
    asyncio.run(main())

服务端示例

import asyncio
import logging
from typing import Any

from aduib_rpc.discover.entities import ServiceInstance
from aduib_rpc.discover.registry.nacos.nacos import NacosServiceRegistry
from aduib_rpc.discover.service import AduibServiceFactory
from aduib_rpc.server.request_excution import RequestExecutor, RequestContext
from aduib_rpc.server.request_excution.request_executor import request_execution
from aduib_rpc.types import ChatCompletionResponse
from aduib_rpc.utils.constant import AIProtocols, TransportSchemes

logging.basicConfig(level=logging.DEBUG)


@request_execution(method="chat.completions")
class TestRequestExecutor(RequestExecutor):
    def execute(self, context: RequestContext) -> Any:
        print(f"Received prompt: {context}")
        response = ChatCompletionResponse(id="chatcmpl-123", object="chat.completion", created=1677652288,
                                          model="gpt-3.5-turbo-0301", choices=[
                {"index": 0, "message": {"role": "assistant", "content": "Hello! How can I assist you today?"},
                 "finish_reason": "stop"}], usage={"prompt_tokens": 9, "completion_tokens": 12, "total_tokens": 21})
        if context.stream:
            async def stream_response():
                for i in range(1, 4):
                    chunk = response
                    yield chunk

            return stream_response()
        else:
            return response


async def main():
    service = ServiceInstance(service_name='test_grpc_app', host='10.0.0.124', port=5001,
                              protocol=AIProtocols.AduibRpc, weight=1, scheme=TransportSchemes.GRPC)
    registry = NacosServiceRegistry(server_addresses='10.0.0.96:8848',
                                    namespace='eeb6433f-d68c-4b3b-a4a7-eeff19110', group_name='DEFAULT_GROUP',
                                    username='nacos', password='nacos')
    factory = AduibServiceFactory(service_instance=service)
    await registry.register_service(service)
    await factory.run_server()


if __name__ == '__main__':
    asyncio.run(main())

开发

  1. 克隆仓库:

    git clone https://github.com/chaorenex1/aduib_rpc.git
    cd aduib_rpc
    
  2. 安装开发依赖:

    uv sync  --all-extras --dev
    
  3. 运行测试:

    pytest tests/
    
  4. 编译 proto 文件(如需更新):

    python scripts/compile_protos.py
    

协议支持

框架支持以下协议与数据格式:

  • gRPC (Protocol Buffers)
  • JSON-RPC
  • REST API

许可证

Apache License 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aduib_rpc-1.0.7.tar.gz (132.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aduib_rpc-1.0.7-py3-none-any.whl (84.8 kB view details)

Uploaded Python 3

File details

Details for the file aduib_rpc-1.0.7.tar.gz.

File metadata

  • Download URL: aduib_rpc-1.0.7.tar.gz
  • Upload date:
  • Size: 132.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for aduib_rpc-1.0.7.tar.gz
Algorithm Hash digest
SHA256 8e8a1e0ec4fedb4a920c2b196d85952e6c3a91d5f0da44da4d1089972374e14a
MD5 1e21666200f0d75946f926813c2f22cd
BLAKE2b-256 9f50199112964c5e0de614c88877ffba4694b3eddaec3cabda8a6a51979b2618

See more details on using hashes here.

File details

Details for the file aduib_rpc-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: aduib_rpc-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 84.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for aduib_rpc-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f771e56555f90c203ef10f8779c2681701b12a4301a441f8226fdd95b7fae319
MD5 98353c89b3420d142dba819582d277f7
BLAKE2b-256 bdbe3307ae693a30f3a924cd33fa48ce47dd38f009ea9484e84f3d6673bd1fc6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page