Django Pure Pagination 技术文档

1. 安装指南

1.1 从 PYPI 安装

你可以通过 pip 命令从 PYPI 安装 django-pure-pagination：

pip install django-pure-pagination

1.2 从 GitHub 仓库安装

你也可以从 GitHub 仓库克隆并安装：

git clone [e-mail]:jamespacileo/django-pure-pagination.git
cd django-pure-pagination
python setup.py install

1.3 配置 INSTALLED_APPS

安装完成后，将 pure_pagination 添加到 Django 项目的 INSTALLED_APPS 中：

INSTALLED_APPS = (
    ...
    'pure_pagination',
)

1.4 替换 Paginator

在项目中，将 from django.core.paginator import Paginator 替换为 from pure_pagination import Paginator。

2. 项目的使用说明

2.1 基本用法

django-pure-pagination 提供了与 Django 核心分页模块相同的 API，因此你可以轻松地将现有代码迁移到使用该库。以下是一个简单的示例，展示了如何在函数视图中使用分页功能。

2.1.1 视图文件 (views.py)

from django.shortcuts import render_to_response
from pure_pagination import Paginator, EmptyPage, PageNotAnInteger

def index(request):
    try:
        page = request.GET.get('page', 1)
    except PageNotAnInteger:
        page = 1

    objects = ['john', 'edward', 'josh', 'frank']

    p = Paginator(objects, request=request)
    people = p.page(page)

    return render_to_response('index.html', {
        'people': people,
    })

2.1.2 模板文件 (index.html)

{% extends 'base.html' %}

{% block content %}
    {% for person in people.object_list %}
        <div>
            First name: {{ person }}
        </div>
    {% endfor %}

    <div id="pagination">
        {{ people.render }}
    </div>
{% endblock %}

2.2 高级用法

你可以通过调用 render 方法来渲染分页，例如 {{ page.render }}。此外，你还可以直接访问 Page 对象的低级方法来自定义分页的显示。

{% load i18n %}
<div class="pagination">
    {% if page_obj.has_previous %}
        <a href="?{{ page_obj.previous_page_number.querystring }}" class="prev">&lsaquo;&lsaquo; {% trans "previous" %}</a>
    {% else %}
        <span class="disabled prev">&lsaquo;&lsaquo; {% trans "previous" %}</span>
    {% endif %}
    {% for page in page_obj.pages %}
        {% if page %}
            {% ifequal page page_obj.number %}
                <span class="current page">{{ page }}</span>
            {% else %}
                <a href="?{{ page.querystring }}" class="page">{{ page }}</a>
            {% endifequal %}
        {% else %}
            ...
        {% endif %}
    {% endfor %}
    {% if page_obj.has_next %}
        <a href="?{{ page_obj.next_page_number.querystring }}" class="next">{% trans "next" %} &rsaquo;&rsaquo;</a>
    {% else %}
        <span class="disabled next">{% trans "next" %} &rsaquo;&rsaquo;</span>
    {% endif %}
</div>

3. 项目 API 使用文档

3.1 Paginator 类

Paginator 类是 django-pure-pagination 的核心类，它继承自 Django 的 Paginator 类，并提供了额外的功能。

3.1.1 初始化

Paginator(object_list, per_page, request=None, orphans=0, allow_empty_first_page=True)

• object_list: 需要分页的对象列表。
• per_page: 每页显示的对象数量。
• request: 当前的 HTTP 请求对象，用于生成完整的查询字符串。
• orphans: 最后一页允许的最少对象数量。
• allow_empty_first_page: 是否允许第一页为空。

3.1.2 方法

• page(number): 返回指定页码的 Page 对象。
• count(): 返回对象的总数。
• num_pages(): 返回总页数。

3.2 Page 类

Page 类表示分页中的某一页，包含当前页的对象列表以及分页的相关信息。

3.2.1 属性

• object_list: 当前页的对象列表。
• number: 当前页的页码。
• paginator: 关联的 Paginator 对象。

3.2.2 方法

• has_next(): 是否有下一页。
• has_previous(): 是否有上一页。
• next_page_number(): 下一页的页码。
• previous_page_number(): 上一页的页码。
• render(): 渲染分页的 HTML 代码。

4. 项目安装方式

4.1 通过 pip 安装

pip install django-pure-pagination

4.2 通过 GitHub 仓库安装

git clone [e-mail]:jamespacileo/django-pure-pagination.git
cd django-pure-pagination
python setup.py install

4.3 配置 INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'pure_pagination',
)

4.4 替换 Paginator

from pure_pagination import Paginator

通过以上步骤，你可以成功安装并使用 django-pure-pagination 来增强你的 Django 项目分页功能。