hyperpy/hrpc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Rename to straight hrpc package side and reset

Browse Source
This commit is contained in:
Luke Murphy
2020-08-13 19:29:14 +02:00
parent 3f690fefa1
commit f7f283cf89
12 changed files with 16 additions and 1089 deletions
Download Patch File Download Diff File Expand all files Collapse all files

123
README.md
View File

@ -1,132 +1,21 @@
# hyper-rpc
# hrpc
[![Build Status](https://drone.autonomic.zone/api/badges/hyperpy/hyper-rpc/status.svg)](https://drone.autonomic.zone/hyperpy/hyper-rpc)
[![Build Status](https://drone.autonomic.zone/api/badges/hyperpy/hrpc/status.svg)](https://drone.autonomic.zone/hyperpy/hrpc)
## Simple RPC with Protobuf Services
Uses [grpcio_tools](https://pypi.org/project/grpc-tools) and [purerpc](https://github.com/standy66/purerpc) under the hood.
## Install
Unfortunately, the [hrpc](https://pypi.org/project/hrpc/) package name is already taken on PyPI.
```sh
$ pip install hyper-rpc
```
## Known Issues
- wontfix: generated service/stub files which import other `.proto` files will
not have correct Python 3 import syntax (see [grpc/grpc#9575](https://github.com/grpc/grpc/issues/9575)). One work-around
for this is to translate `import foo_pb2 as foo__pb2` to `from . import foo_pb2 as foo__pb2` manually. See this [makefile
target](https://github.com/hyperpy/hyperspace-rpc/blob/5f1f88106c56ac48d0d1414f63616ba2d8af5f5d/makefile#L3)
for some `sed` inspiration.
## Example
> **TLDR; See the [example](https://github.com/hyperpy/hyper-rpc/tree/master/example) directory**
> **TLDR; See the [example](https://github.com/hyperpy/hrpc/tree/master/example) directory**
Define an RPC service in a `greeter.proto`.
```protobuf
syntax = "proto3";
service Greeter {
rpc SayHello (HelloRequest) returns (HelloReply) {}
rpc SayHelloGoodbye (HelloRequest) returns (stream HelloReply) {}
rpc SayHelloToMany (stream HelloRequest) returns (stream HelloReply) {}
rpc SayHelloToManyAtOnce (stream HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
}
```
Then generate the services and stubs with `hyper-rpc`.
```sh
$ hrpc greeter.proto
```
This creates `greeter_gprc.py` (services) and `greeter_pb2.py` (stubs) files.
You can then write an async-ready server.
```python
"""Greeter server."""
from greeter_grpc import GreeterServicer
from greeter_pb2 import HelloReply, HelloRequest
from purerpc import Server
class Greeter(GreeterServicer):
async def SayHello(self, message):
return HelloReply(message=f"Hello {message.name}")
async def SayHelloToMany(self, input_messages):
async for message in input_messages:
yield HelloReply(message=f"Hello, {message.name}")
if __name__ == "__main__":
server = Server(50055)
server.add_service(Greeter().service)
server.serve(backend="trio")
```
And a client.
```python
"""Greeter client."""
import anyio
import purerpc
from greeter_grpc import GreeterStub
from greeter_pb2 import HelloReply, HelloRequest
async def gen():
for i in range(5):
yield HelloRequest(name=str(i))
async def main():
async with purerpc.insecure_channel("localhost", 50055) as channel:
stub = GreeterStub(channel)
reply = await stub.SayHello(HelloRequest(name="World"))
print(reply.message)
async for reply in stub.SayHelloToMany(gen()):
print(reply.message)
if __name__ == "__main__":
anyio.run(main, backend="trio")
```
And run them in separate terminals to see the output.
```
$ python server.py # terminal 1
$ python client.py # terminal 2
```
Output:
```
Hello, World
Hello, 0
Hello, 1
Hello, 2
Hello, 3
Hello, 4
```
Go forth and [Remote Procedure Call](https://en.wikipedia.org/wiki/Remote_procedure_call).
## Acknowledgements
![The person who invented the term RPC](https://upload.wikimedia.org/wikipedia/en/9/90/BruceJayNelson.JPG)