Skip to content

Commit

Permalink
Fix the readme gRPC usage example (danielgtaylor#122)
Browse files Browse the repository at this point in the history
* re-implement README gRPC client example to be a self-contained script
 - fix a syntax error
 - fix a usage error

* asyncio.run() was added in 3.7
 - this lib targets >= 3.6

* Apply suggestions from code review

Optimized imports, store RPC call result before printing

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>

* add entry-point check to example

Co-authored-by: Arun Babu Neelicattu <arun.neelicattu@gmail.com>
  • Loading branch information
2 people authored and Gobot1234 committed Aug 24, 2020
1 parent e192c70 commit 56e7b98
Showing 1 changed file with 27 additions and 13 deletions.
40 changes: 27 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ This project exists because I am unhappy with the state of the official Google p
- Uses `SerializeToString()` rather than the built-in `__bytes__()`
- Special wrapped types don't use Python's `None`
- Timestamp/duration types don't use Python's built-in `datetime` module

This project is a reimplementation from the ground up focused on idiomatic modern Python to help fix some of the above. While it may not be a 1:1 drop-in replacement due to changed method names and call patterns, the wire format is identical.

## Installation
Expand Down Expand Up @@ -126,7 +125,7 @@ Greeting(message="Hey!")

The generated Protobuf `Message` classes are compatible with [grpclib](https://github.com/vmagamedov/grpclib) so you are free to use it if you like. That said, this project also includes support for async gRPC stub generation with better static type checking and code completion support. It is enabled by default.

Given an example like:
Given an example service definition:

```protobuf
syntax = "proto3";
Expand All @@ -153,22 +152,37 @@ service Echo {
}
```

You can use it like so (enable async in the interactive shell first):

A client can be implemented as follows:
```python
>>> import echo
>>> from grpclib.client import Channel
import asyncio
import echo

from grpclib.client import Channel

>>> channel = Channel(host="127.0.0.1", port=1234)
>>> service = echo.EchoStub(channel)
>>> await service.echo(value="hello", extra_times=1)
EchoResponse(values=["hello", "hello"])

>>> async for response in service.echo_stream(value="hello", extra_times=1)
async def main():
channel = Channel(host="127.0.0.1", port=50051)
service = echo.EchoStub(channel)
response = await service.echo(value="hello", extra_times=1)
print(response)

async for response in service.echo_stream(value="hello", extra_times=1):
print(response)

EchoStreamResponse(value="hello")
EchoStreamResponse(value="hello")
# don't forget to close the channel when done!
channel.close()


if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run_until_complete(main())

```
which would output
```python
EchoResponse(values=['hello', 'hello'])
EchoStreamResponse(value='hello')
EchoStreamResponse(value='hello')
```

### JSON
Expand Down

0 comments on commit 56e7b98

Please sign in to comment.