Skip to main content

A Simple Python Library for RPC

Project description

RPC 项目

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

项目结构

  • src/

    • rpc/

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

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

安装

使用

pip install ksj-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-1.0.0rc37.post1.tar.gz (341.3 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-1.0.0rc37.post1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file ksj_rpc-1.0.0rc37.post1.tar.gz.

File metadata

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

File hashes

Hashes for ksj_rpc-1.0.0rc37.post1.tar.gz
Algorithm Hash digest
SHA256 59e2b9b178e7816f7da0cb2a3ad2a7cdb445fd508a1df2f3d7cc18fc77c99309
MD5 f9576b799af69e4bf1de04d8d7e8a672
BLAKE2b-256 23863e8ec815dfa943ea1eadf7680aebb635decaa6c655de820bfc2b859fe57b

See more details on using hashes here.

File details

Details for the file ksj_rpc-1.0.0rc37.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for ksj_rpc-1.0.0rc37.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 e9e4b3d1257d935689a748e1a8b309643f48957c430aa1b04fbf440cb79f3aad
MD5 e093d4b8544ac1d1c0f4c55e0713f5b3
BLAKE2b-256 5fadbf7f8f29df1c3b0bf6857b5e595994c17973021afdaf57a8390a0074b2a9

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