一、需求描述
在用flask开发项目的时候,我们经常需要分页。在query对象上调用paginate方法来分页是我们非常熟悉的一种实现方式。但是,如果出于某种原因,我们需要分页的数据不是query对象,而是普通的列表,那该怎么办呢?这时候,我们可以用flask_sqlalchemy的Pagination类来完成这项工作。
二、代码示例
from flask import Flask,request
from flask_sqlalchemy import Pagination
app = Flask(__name__)
@app.route('/')
def index():
mylist=['dog','cat','monkey','panda','zebra']
page = request.args.get('page',1,type=int)
#为了处理用户输入的超出页码范围的数字,添加以下代码
if page>len(mylist) or page<1:
page = 1
#下面就是得到的某一页的分页对象
current_page = Pagination(mylist,page,1,len(mylist),mylist[page-1])
#我们向浏览器返回一些分页对象的属性,来检查它是否像我们预期的一样正常工作
return '<h1>下一页的页码是:%s,是否有上一页:%s,共有%s条数据,共有%s页</h1>'%(current_page.next_num,current_page.has_prev,current_page.total,current_page.pages)
if __name__ == '__main__':
app.run(debug=True)
三、进一步说明
上面的代码大部分都很好理解,最关键的一行就是
current_page = Pagination(mylist,page,1,len(mylist),mylist[page-1])
Pagination一共接收5个参数,下面我来逐个说明这些参数:
- query: 我们要分页的集合对象,在上述案例中,mylist就是我要分页的对象
- page:当前请求的页码
- per_page:每页的数据个数,我的列表里有5个数据,我把per_page设为1,就是每页显示一条数据
- total:数据总量,我的列表有六个元素,也就是共有6条数据
- items:当前页需要显示的数据,因为页码是从1开始的,而列表的索引是从0开始的,所以要处理好这种转化关系。我们的例子是每页只显示一条数据,还比较好计算,如果是多条数据,计算的时候要细心一些
从上面的参数可以看出,用Pagination给一个列表分页,不是完全自动的,有些数据需要我们手动计算,一旦计算失误,就不能得到我们想要的结果。但是,一旦我们构造出了一个正确的Pagination对象,就可以使用它提供的各种属性了,在模板里使用的时候还是很方便的。
四、效果展示
在cmd中输入启动服务器后,在浏览器中输入127.0.0.1:5000会看到如下页面:
我们可以手动填写page参数的值,比如:
可以看到,符合我们的预期。