Skip to content
This repository has been archived by the owner. It is now read-only.
Thriftpy has been deprecated, please migrate to https://github.com/Thriftpy/thriftpy2
Branch: develop
Clone or download
Latest commit 0e606f8 Sep 29, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark update docs with new benchmark results Jul 17, 2014
docs fix docs typo. Nov 30, 2017
examples stay same to upstream Apr 15, 2015
tests Improve exception message spelling and spacing Dec 18, 2017
thriftpy Improve exception message spelling and spacing Dec 18, 2017
.gitignore refine TScoket and TServerSocket implementation Dec 22, 2015
.travis.yml Drop support for EOL Python 3.3 Nov 13, 2017
CHANGES.rst add changelog, version bumps to v0.3.9 Aug 26, 2016
LICENSE add LICENSE file, fixes #67 Dec 12, 2014
MANIFEST.in add tracking support Mar 9, 2015
Makefile another fix for compat issues. Dec 29, 2015
README.rst Update README.rst Sep 29, 2018
setup.cfg try add wheel support Apr 21, 2015
setup.py Add python_requires Nov 30, 2017
tox.ini

README.rst

ThriftPy

Thriftpy has been deprecated, please migrate to thriftpy2

http://img.shields.io/travis/eleme/thriftpy/develop.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 implementation 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
pingpong_thrift = thriftpy.load("pingpong.thrift", module_name="pingpong_thrift")

from thriftpy.rpc import make_server

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

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

And a client:

import thriftpy
pingpong_thrift = thriftpy.load("pingpong.thrift", module_name="pingpong_thrift")

from thriftpy.rpc import make_client

client = make_client(pingpong_thrift.PingPong, '127.0.0.1', 6000)
print(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 Python 2.7, Python 3.4+, PyPy and PyPy3.

  • Pure python implementation. No longer need to compile & install the 'thrift' package. All you need is thriftpy and thrift file.

  • Compatible with Apache Thrift. You can use ThriftPy together with the official implementation 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)
    • compact protocol (python and cython)
    • json protocol
    • buffered transport (python & cython)
    • framed transport
    • tornado server and client (with tornado 4.0)
    • http server and client
  • Can directly load thrift file as module, the sdk code will be generated on the fly.

    For example, pingpong_thrift = thriftpy.load("pingpong.thrift", module_name="pingpong_thrift") will load 'pingpong.thrift' as 'pingpong_thrift' module.

    Or, when import hook enabled by thriftpy.install_import_hook(), you can directly use import pingpong_thrift to import the 'pingpong.thrift' file as module, you may also use from pingpong_thrift import PingService to import specific object from the thrift module.

  • Easy RPC server/client setup.

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 or tox tests succeed.
  4. Send pull request.

Contributors

https://github.com/eleme/thriftpy/graphs/contributors

Changelog

https://github.com/eleme/thriftpy/blob/master/CHANGES.rst

You can’t perform that action at this time.