/greentor

Patch pymysql to support tornado asynchronous

Primary LanguagePythonMIT LicenseMIT

greentor

greentor is a fork of gTornado

greentor通过给pymysql打补丁,使pymysql在Tornado中的运行过程变为异步IO,相比于其它支持Tornado的mysql驱动,greentor有以下不同

  1. 同步pymysql的写法
  2. 理论上可以支持各种ORM的调用异步

感谢@alex8224和他的gTornado

感谢@snower，参考他的TorMySQL优化了IOStream的读写性能

安装

pip install git+https://github.com/1260228859/greentor.git

使用

# coding: utf-8

from greentor import green
green.enable_debug()
from greentor import mysql
mysql.patch_pymysql()
  1. green.enable_debug() 非必须,开启greenlet调试模式,可以打印greenlet switch过程
  2. mysql.patch_pymysql() 给pymysql打异步补丁,异步的pymysql依赖于Tornado,在Tornado的IOLoop start后才能正常使用

在RequestHandler中使用

涉及到pymysql的调用都需要运行在greenlet中,提供了3种方式实现同步代码转异步

from greentor import green
from greentor import mysql
mysql.patch_pymysql()
import tornado.web

class MainHandler(tornado.web.RequestHandler):
    @green.green
    def get(self):
        connect = MySQLdb.connect(user='root',
                                  passwd='',
                                  db='test',
                                  host='localhost',
                                  port=3306)
        cursor = connect.cursor()
        cursor.execute('SELECT * FROM app_blog LIMIT 1')
        result = cursor.fetchone()
        cursor.close()
        connect.close()
        self.finish(result[2])

通过green.green装饰器使整个get方法都运行在greenlet中,这样是最方便的使用pymysql的方式

from greentor import green
from greentor import mysql
mysql.patch_pymysql()
import tornado.web
import tornado.gen

@green.green
def test_mysql():
    connect = MySQLdb.connect(user='root',
                              passwd='',
                              db='test',
                              host='localhost',
                              port=3306)
    cursor = connect.cursor()
    cursor.execute('SELECT * FROM app_blog LIMIT 1')
    result = cursor.fetchone()
    cursor.close()
    connect.close()
    return result


class MainHandler(tornado.web.RequestHandler):
    @tornado.gen.coroutine
    def get(self):
        result = yield test_mysql()
        self.finish(result[2])

通过green.green装饰器包装的函数会返回Future对象,可以在Tornado的协程中使用

from greentor import green
from greentor import mysql
mysql.patch_pymysql()
import tornado.web
import tornado.gen

def test_mysql():
    connect = MySQLdb.connect(user='root',
                              passwd='',
                              db='test',
                              host='localhost',
                              port=3306)
    cursor = connect.cursor()
    cursor.execute('SELECT * FROM app_blog LIMIT 1')
    result = cursor.fetchone()
    cursor.close()
    connect.close()
    return result


class MainHandler(tornado.web.RequestHandler):
    @tornado.gen.coroutine
    def get(self):
        result = yield green.spawn(test_mysql)
        self.finish(result[2])

green.spawn(callable_obj, *arg, **kwargs)的调用与green.green一致

实例

在tests目录下有一个使用纯pymysql调用的实例

demo目录下有一个完整的 Tornado + Django ORM 的环境,具体可以查看demo目录下的README