ksj-rpc 1.0.0

A Simple Python Library for RPC

RPC 项目

这是一个基于TCP协议的RPC（远程过程调用）项目，包含客户端和服务器端的实现。该项目允许客户端通过网络调用服务器上的函数。

项目结构

• src/

  • rpc/

    • __init__.py: 包含RPC客户端和服务器端的初始化代码。
    • client.py: 包含RPC客户端的实现。
    • server.py: 包含RPC服务器端的实现。
    • tcp.py: 包含TCP客户端和服务器端的实现。

  • tests/

    • test_rpc.py: 包含针对RPC客户端和服务器端的测试代码。

安装

1. 克隆代码库：

```sh
git clone https://github.com/King-sj/krpc.git
cd krpc
```

1. 安装依赖项：

pip install -r requirements.txt

使用方法

启动服务器

在服务器端，创建一个RPC服务器并注册要暴露的函数：

from rpc.server import RPCServer

def test_function(*args, **kwargs):
    return f"function test called with args: {args} and kwargs: {kwargs}"

server = RPCServer()
server.register(test_function)
server.loop('127.0.0.1', 8000)

启动客户端

在客户端，创建一个RPC客户端并连接到服务器：

from rpc.client import RPCClient

client = RPCClient()
client.connect('127.0.0.1', 8000)
result = client.test_function('测试项', kw1="1")
print(result)  # 输出: function test called with args: ('测试项',) and kwargs: {'kw1': '1'}

测试

使用pytest运行测试：

pytest tests/test_rpc.py

开发

依赖项

项目依赖项在pyproject.toml文件中定义。使用以下命令安装开发依赖项：

pip install flit
flit install --deps develop

代码风格

使用flake8和black检查代码风格：

flake8 src/
black src/

类型检查

使用pyright进行类型检查：

pyright src/

贡献

欢迎贡献和建议！请提交拉取请求或报告问题。