Flask-Paginate：分页功能的Python Flask扩展

2025-04-29 10:46:15作者：吴年前Myrtle

1. 项目介绍

Flask-Paginate 是一个为 Flask 应用程序提供分页功能的扩展。它基于 Flask，通过简单的配置和代码即可实现分页逻辑，帮助开发者快速地在其 Flask 应用中实现数据的分页显示。

2. 项目快速启动

首先，确保你已经安装了 Flask 环境。接下来，通过以下步骤快速启动 Flask-Paginate。

安装 Flask-Paginate

pip install Flask-Paginate

创建一个基本的 Flask 应用

from flask import Flask, render_template, request
from flask_paginate import Pagination, get_page_args

app = Flask(__name__)

# 假设有一个数据列表
items = ['item' + str(i) for i in range(1, 101)]

@app.route('/')
def index():
    page, per_page, offset = get_page_args(page_parameter='page',
                                           per_page_parameter='per_page')
    pagination = Pagination(page=page, per_page=per_page, offset=offset,
                            total=len(items), items=items)
    return render_template('index.html', items=items[offset:offset + per_page],
                           pagination=pagination)

if __name__ == '__main__':
    app.run(debug=True)

创建一个简单的 HTML 模板 `index.html`

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Flask-Paginate Example</title>
</head>
<body>
    <ul>
        {% for item in items %}
            <li>{{ item }}</li>
        {% else %}
            <li>没有数据。</li>
        {% endfor %}
    </ul>
    <div>
        {{ pagination.links }}
    </div>
</body>
</html>

这样就创建了一个简单的带有分页的 Flask 应用。

3. 应用案例和最佳实践

最佳实践：自定义分页参数

你可以在 Pagination 类中自定义分页参数，如 pageParameter 和 perPageParameter，这样就可以根据你的 URL 参数名来传递分页信息。

案例扩展：添加分页样式

在 HTML 中，你可以添加 CSS 来美化分页链接的显示样式。

<style>
    .pagination {
        display: inline-block;
        padding-left: 0;
        margin: 20px 0;
        border-radius: 4px;
    }
    .pagination li {
        display: inline;
        padding: 5px 10px;
        border: 1px solid #ddd;
        margin-right: -1px;
        cursor: pointer;
    }
    .pagination li.active {
        background-color: #007bff;
        color: white;
    }
    .pagination li a {
        text-decoration: none;
        color: #337ab7;
    }
</style>

4. 典型生态项目

Flask-Paginate 作为 Flask 的一个扩展，可以与 Flask 的其他扩展如 Flask-SQLAlchemy、Flask-MongoEngine 等数据库工具结合使用，实现复杂的分页需求。此外，它也可以与前端框架如 Bootstrap、Jinja2 等结合，创建更加丰富的分页界面和交互。

登录后查看全文