Skip to main content

A Simple Python Library for RPC

Project description

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

代码风格

使用flake8black检查代码风格:

flake8 src/
black src/

类型检查

使用pyright进行类型检查:

pyright src/

贡献

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

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

ksj_rpc-0.0.2rc34.post1.tar.gz (341.2 kB view details)

Uploaded Source

Built Distribution

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

ksj_rpc-0.0.2rc34.post1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file ksj_rpc-0.0.2rc34.post1.tar.gz.

File metadata

  • Download URL: ksj_rpc-0.0.2rc34.post1.tar.gz
  • Upload date:
  • Size: 341.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for ksj_rpc-0.0.2rc34.post1.tar.gz
Algorithm Hash digest
SHA256 7fa3f7ba81a536590bb1d30f59f9a136b0fe15318369b49f98e0038d9c09cbc9
MD5 91519f12029075f5fabf94e42a8e0912
BLAKE2b-256 8ea1b653cd4ab25a28ca18df14f5f4eeb1dd65933d60336a7cee1f4a37962a8e

See more details on using hashes here.

File details

Details for the file ksj_rpc-0.0.2rc34.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for ksj_rpc-0.0.2rc34.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 88fdd4429b2267d0bc1d09106e8bb481a6f173902c5be5075947f0c64c5c677b
MD5 9d4e53ec450e6b96c7ea2a17f536e34d
BLAKE2b-256 392940beafd02965385e797e613eb54c8bf4768b42dcdffdbf4caadfb5943a33

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