Skip to main content

an(t)thunder is a sofa-bolt protocol lib.

Project description

anthunder(a.k.a. sofa-bolt-python)

anthunder(ant thunder) is a sofa-bolt library written in python. It supports RPC calling via 'sofa-bolt + protobuf' protocol.

requirements

  • python3 >= 3.4 (aio classes needs asyncio support)
  • python2.7 (limited support, needs extra 3rd party libraries)
  • mosn >= 1.3 (to use with version >= 0.6)
  • mosn < 1.3 (to use with version < 0.6)

roadmap

  • [x] bolt client(protobuf serialization)
  • [x] service discover via mosn (sofa servicemesh sidecar)
  • [x] bolt server(protobuf serialization)
  • [ ] hessian2 serialization support

Tutorial

As client (caller)

  1. Acquire .proto file
  2. Execute protoc --python_out=. *.proto to compile protobuf file, and get _pb2.py file.
  3. Import protobuf classes (postfixed with _pb2)
from SampleServicePbResult_pb2 import SampleServicePbResult
from SampleServicePbRequest_pb2 import SampleServicePbRequest

from anthunder import AioClient


spanctx = SpanContext()         # generate a new context, an object of mytracer.SpanContext, stores rpc_trace_context.
# spanctx = ctx                 # or transfered from upstream rpc
client = AioClient(my_app_name) # my_app_name will be send to sidecar as caller name.
                                # will create a thread, and send heartbeat to mesh every 30s

interface = 'com.alipay.rpc.common.service.facade.pb.SampleServicePb:1.0'

# Subscribe interface
client.subscribe(interface)

# Call synchronously
content = client.invoke_sync(interface, "hello",
                             SampleServicePbRequest(name=some_name).SerializeToString(),
                             timeout_ms=500, spanctx=spanctx)
result = SampleServicePbResult()
result.ParseFromString(content)

# Call asynchronously

def client_callback(resp):
    # callback function, accepts bytes as the only argument,
    # then do deserialize and further processes
    result = SampleServicePbResult()
    result.ParseFromString(content)
    # do something

future = client.invoke_async(interface, "hello", 
                             SampleServicePbRequest(name=some_name).SerializeToString(),
                             spanctx=spanctx, callback=client_callback)
)

See project's unittest for runnable demo

As server

from anthunder.listener import aio_listener

class SampleService(object):
    def __init__(self, ctx):
        # service must accept one param as spanctx for rpc tracing support
        self.ctx = ctx
        
    def hello(self, bs: bytes):
        obj = SampleServicePbRequest()
        obj.ParseFromString(bs)
        print("Processing Request", obj)
        return SampleServicePbResult(result=obj.name).SerializeToString()


listener = aio_listener.AioListener(('127.0.0.1', 12200), "test_app")
# register interface and its function, plus its protobuf definition class
listener.handler.register_interface("com.alipay.rpc.common.service.facade.pb.SampleServicePb:1.0",
                                    SampleService)
# start server in a standalone thread
listener.run_threading()
# or start in current thread
listener.run_forever()

# publish interfaces to service mesh
listener.publish()

# shutdown the server
listener.shutdown()

License

Copyright (c) 2018-present, Ant Financial Service Group

Apache License 2.0

See LICENSE file.

Thirdparty

Part of the mysockpool package uses codes from urllib3 project under the term of MIT License. See origin-license.txt under the mysockpool package.

Release History

0.5.6 (2019-03-15)

Bugfixes

  • fix a infinite loop bug when parsing protocol

0.5.4 (2018-11-09)

Bugfixes

  • fix server errors under python2.7

0.5.3 (2018-08-27)

Feature

  • support antsharecloud parameters.

0.5.2 (2018-09-03)

Bugfixes

  • fix various errors under python2.7

0.5.1 (2018-08-31)

Bugfixes

  • sofa trace rpc id may contains str.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for anthunder, version 0.6.2
Filename, size File type Python version Upload date Hashes
Filename, size anthunder-0.6.2-py2.py3-none-any.whl (61.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size anthunder-0.6.2.tar.gz (33.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page