flask_sqlalchemy: 重写查询方法例子(重写filter_by)

http://blog.wktadmin.com
1. 引出

比如某个项目中, status是逻辑删除的标志, 每次查询都需要加上status=1,

Gifts.query.filter_by(uid=current_user.id, isbn=isbn, launched=False, status=1)

非常的不方便, 重写filter_by是一个不错的选择

1. 重写

filter_by等查询函数定义在sqlalchemy.orm.Query中, flask_sqlalchemy.BaseQuery继承了orm的Query, 因此我们重写的时候可是直接继承BaseQuery.

自定义filter_by的代码为:

class Query(BaseQuery):
    def filter_by(self, **kwargs):
        if 'status' not in kwargs.keys():
            kwargs['status'] = 1
        return super(Query, self).filter_by(**kwargs)

1. 指定query类

但是这时候, 系统并不知道要使用我们重写的filter_by.
SQLAlchemy类的构造函数中为我们提供了可指定的query_class参数:

def __init__(self, app=None, use_native_unicode=True, session_options=None,
                 metadata=None, query_class=BaseQuery, model_class=Model):
    ...

因此可以在实例化SQLALchemy对象时候直接使用参数:

db = SQLALchemy(query_class=Query)