Python implementation of Twirp RPC framework.
This repo contains a protoc plugin that generates sever and client code and a pypi package with common implementation details.
For details about the twirp project, check https://github.com/twitchtv/twirp
Grab the protoc plugin to generate files with
go get -u github.com/verloop/twirpy/protoc-gen-twirpy
Add the twirp package to your project
pip install twirp
You'll also need uvicorn to run the server.
Use the protoc plugin to generate twirp server and client code.
We'll assume familiarity with the example from the docs. https://twitchtv.github.io/twirp/docs/example.html
protoc --python_out=./ --twirpy_out=./ ./haberdasher.proto
# server.py
import random
from twirp.asgi import TwirpASGIApp
from twirp.exceptions import InvalidArgument
from . import haberdasher_twirp, haberdasher_pb2
class HaberdasherService(object):
def MakeHat(self, context, size):
if size.inches <= 0:
raise InvalidArgument(argument="inches", error="I can't make a hat that small!")
return haberdasher_pb2.Hat(
size=size.inches,
color= random.choice(["white", "black", "brown", "red", "blue"]),
name=random.choice(["bowler", "baseball cap", "top hat", "derby"])
)
service = haberdasher_twirp.HaberdasherServer(service=HaberdasherService())
app = TwirpASGIApp()
app.add_service(service)Run the server with
uvicorn twirp_server:app --port=3000
# client.py
from twirp.context import Context
from twirp.exceptions import TwirpServerException
from . import haberdasher_twirp, haberdasher_pb2
client = haberdasher_twirp.HaberdasherClient("http://localhost:3000")
try:
response = client.MakeHat(ctx=Context(), request=haberdasher_pb2.Size(inches=12))
print(response)
except TwirpServerException as e:
print(e.code, e.message, e.meta, e.to_dict())Python: #twirp. Join Python community slack here
Go: #twirp. Join Gophers community slack here
- The initial version of twirpy was made from an internal copy of https://github.com/daroot/protoc-gen-twirp_python_srv
- The
run_in_threadpoolmethod comes from https://github.com/encode/starlette
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent