rpc.py 项目教程

rpc.py 项目教程

rpc.pyA fast and powerful RPC framework based on ASGI/WSGI.项目地址:https://gitcode.com/gh_mirrors/rp/rpc.py

1. 项目的目录结构及介绍

rpc.py/
├── .gitignore
├── LICENSE
├── README.md
├── setup.py
├── rpcpy/
│   ├── __init__.py
│   ├── server.py
│   ├── client.py
│   ├── utils.py
│   └── config.py
└── tests/
    ├── __init__.py
    ├── test_server.py
    └── test_client.py

• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• setup.py: 项目安装脚本。
• rpcpy/: 项目主要代码目录。
  • init.py: 模块初始化文件。
  • server.py: 服务器端代码。
  • client.py: 客户端代码。
  • utils.py: 工具函数。
  • config.py: 配置文件。
• tests/: 测试代码目录。
  • init.py: 测试模块初始化文件。
  • test_server.py: 服务器端测试代码。
  • test_client.py: 客户端测试代码。

2. 项目的启动文件介绍

项目的启动文件是 rpcpy/server.py。该文件包含了服务器端的启动逻辑和主要功能实现。以下是 server.py 的主要内容：

from rpcpy import RPC
import uvicorn

app = RPC(mode="ASGI")

@app.register
async def sayhi(name: str) -> str:
    return f"hi {name}"

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

• RPC: 创建一个 RPC 服务器实例。
• sayhi: 注册一个异步函数，用于处理客户端请求。
• uvicorn.run: 启动 ASGI 服务器。

3. 项目的配置文件介绍

项目的配置文件是 rpcpy/config.py。该文件包含了项目的配置选项，如服务器地址、端口等。以下是 config.py 的主要内容：

class Config:
    HOST = "0.0.0.0"
    PORT = 8000
    DEBUG = False

• HOST: 服务器监听的地址。
• PORT: 服务器监听的端口。
• DEBUG: 是否开启调试模式。

通过修改 config.py 中的配置选项，可以调整项目的运行参数。

rpc.pyA fast and powerful RPC framework based on ASGI/WSGI.项目地址:https://gitcode.com/gh_mirrors/rp/rpc.py