Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Pure python implemention of Apache Thrift.

Project Description

http://img.shields.io/travis/eleme/thriftpy/master.svg?style=flat http://img.shields.io/github/release/eleme/thriftpy.svg?style=flat http://img.shields.io/pypi/v/thriftpy.svg?style=flat http://img.shields.io/pypi/dm/thriftpy.svg?style=flat

ThriftPy is a pure python implemention of Apache Thrift in a pythonic way.

Documentation: https://thriftpy.readthedocs.org/

Installation

Install with pip

$ pip install thriftpy

You may also install cython first to build cython extension locally.

$ pip install cython thriftpy

Code Demo

ThriftPy make it super easy to write server/client code with thrift. Let’s checkout this simple pingpong service demo.

We need a ‘pingpong.thrift’ file:

service PingPong {
    string ping(),
}

Then we can make a server:

import thriftpy
from thriftpy.rpc import make_server

pingpong = thriftpy.load("pingpong.thrift")

class Dispatcher(object):
    def ping(self):
        return "pong"

server = make_server(pingpong.PingPong, Dispatcher(), '127.0.0.1', 6000)
server.serve()

And a client:

import thriftpy
from thriftpy.rpc import make_client

pingpong = thriftpy.load("pingpong.thrift")

client = make_client(pingpong.PingPong, '127.0.0.1', 6000)
client.ping()

See, it’s that easy!

You can refer to ‘examples’ and ‘tests’ directory in source code for more usage examples.

Features

Currently ThriftPy have these features (also advantages over the upstream python lib):

  • Supports python2.7 to python3.4 and pypy.

  • Compatible with Apache Thirft. You can use ThriftPy together with the official implemention servers and clients, such as a upstream server with a thriftpy client or the opposite.

    Currently implemented protocols and transports:

    • binary protocol (python and cython implemention)
    • buffered transport
    • tornado server and client (with tornado 4.0)
    • framed transport
  • Can directly load thrift file as module, the sdk code will be generated on the fly.

    For example, pingpong = thriftpy.load("pingpong.thrift") will load ‘pingpong.thrift’ as ‘pingpong’ module.

    Or, when import hook enabled, directly use import pingpong_thrift to import the ‘pingpong.thrift’ file as module.

  • Pure python, standalone implemention. No longer need to compile & install the ‘thrift’ package. All you need is thrift file.

  • Easy RPC server/client setup.

Benchmarks

Some benchmark results:

# apache thrift py binary
binary protocol struct benchmark for 100000 times:
encode  -> 3.74061203003
decode  -> 5.02829790115

# apache thrift c binary
accelerated protocol struct benchmark for 100000 times:
encode  -> 0.398949146271
decode  -> 0.536000013351

# thriftpy & pypy2.3
binary protocol struct benchmark for 100000 times:
encode  -> 0.413738965988
decode  -> 0.605606079102

# thriftpy & py3.4
binary protocol struct benchmark for 100000 times:
encode  -> 3.291545867919922
decode  -> 4.337666034698486

# thriftpy & py3.4 + cython
cybin protocol struct benchmark for 100000 times:
encode  -> 0.5828649997711182
decode  -> 0.8259570598602295

Checkout the benchmark/benchmark.rst for detailed benchmark scripts and scores.

TODOs

Currently ThriftPy is not fully compatible with thrift, I only implemented the features we need in ele.me.

These todos need to be done, but may not be completed by me in near future, so contributions are very welcome!

  • other protocol and transport except binary and buffered transport.
  • map type const.
  • ‘namespace’, ‘extends’, ‘import’, ‘oneway’ etc keywords.
  • the ‘.thrift’ file parser will skip a section if it has syntax error. A better warning message should be given.

Contribute

  1. Fork the repo and make changes.
  2. Write a test which shows a bug was fixed or the feature works as expected.
  3. Make sure travis-ci test succeed.
  4. Send pull request.

Release history Release notifications

History Node

0.3.9

History Node

0.3.8

History Node

0.3.7

History Node

0.3.6

History Node

0.3.5

History Node

0.3.4

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.1

History Node

0.2.0

History Node

0.1.15

History Node

0.1.14

History Node

0.1.13

History Node

0.1.12

History Node

0.1.11

History Node

0.1.10

This version
History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
thriftpy-0.1.9.tar.gz (100.0 kB) Copy SHA256 hash SHA256 Source None Sep 1, 2014

Supported by

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