這篇文章主要介紹了Python的Flask框架中實(shí)現(xiàn)分頁功能的教程,文中的示例基于一個(gè)博客來實(shí)現(xiàn),需要的朋友可以參考下

Blog Posts的提交

讓我們從簡單的開始。首頁上必須有一張用戶提交新的post的表單。

首先我們定義一個(gè)單域表單對(duì)象(fileapp/forms.py)：

class PostForm(Form):

post = TextField('post', validators = [Required()])

下面，我們把這個(gè)表單添加到template中(fileapp/templates/index.html)：

<!-- extend base layout -->

{% extends "base.html" %}

{% block content %}

<h1>Hi, {{g.user.nickname}}!</h1>

<form action="" method="post" name="post">

{{form.hidden_tag()}}

<table>

<tr>

<td>Say something:</td>

<td>{{ form.post(size = 30, maxlength = 140) }}</td>

<td>

{% for error in form.errors.post %}

<span style="color: red;">[{{error}}]</span><br>

{% endfor %}

</td>

</tr>

<tr>

<td></td>

<td><input type="submit" value="Post!"></td>

<td></td>

</tr>

</table>

</form>

{% for post in posts %}

<p>

{{post.author.nickname}} says: <b>{{post.body}}</b>

</p>

{% endfor %}

{% endblock %}

到目前為止沒啥新的東西，你可以看到，我們僅僅添加了另一表單，就像我們上一次做的那樣。

最后，功能試圖把所有東西都聯(lián)系在一起，并被擴(kuò)展來處理這個(gè)表單(fileapp/views.py):

from forms import LoginForm, EditForm, PostForm

from models import User, ROLE_USER, ROLE_ADMIN, Post

@app.route('/', methods = ['GET', 'POST'])

@app.route('/index', methods = ['GET', 'POST'])

@login_required

def index():

form = PostForm()

if form.validate_on_submit():

post = Post(body = form.post.data, timestamp = datetime.utcnow(), author = g.user)

db.session.add(post)

db.session.commit()

flash('Your post is now live!')

return redirect(url_for('index'))

posts = [

{

'author': { 'nickname': 'John' },

'body': 'Beautiful day in Portland!'

},

{

'author': { 'nickname': 'Susan' },

'body': 'The Avengers movie was so cool!'

}

]

return render_template('index.html',

title = 'Home',

form = form,

posts = posts)

下面讓我們逐一回顧一下這個(gè)功能中的變動(dòng)：

我們導(dǎo)入了Post和PostForm類

我們接收了來自兩個(gè)路徑下的index和視圖的POST請(qǐng)求，因?yàn)槟蔷褪俏覀內(nèi)绾谓邮仗峤坏恼?qǐng)求。

當(dāng)我們通過表單提交到功能視圖后，我們會(huì)把新的Post記錄錄入數(shù)據(jù)庫。然后就像之前做的一樣，通過常規(guī)的GET請(qǐng)求來訪問它。

Templat會(huì)收到一條額外的內(nèi)容--表單，所以它會(huì)提交給文本域。

在我們繼續(xù)之前還有最后一點(diǎn)提醒：注意下面我們?nèi)绾翁砑右粭l新的Post請(qǐng)求到數(shù)據(jù)庫中：

return redirect(url_for('index'))

我們可以很容易的跳過重定向，并且允許它跳到模板渲染部分，而且效率更高。因?yàn)樗龅乃兄囟ㄏ蛟诮?jīng)過web瀏覽器之后，都返回到這個(gè)相同的功能視圖中來。

所以，為什么選擇重定向?考慮到當(dāng)用戶寫下一個(gè)blog post請(qǐng)求之后，它只需提交然后點(diǎn)擊瀏覽器刷新按鈕?！癛efresh”命令能做什么呢?瀏覽器會(huì)重新發(fā)送最后發(fā)布的請(qǐng)求作為一個(gè)“Refresh”命令的結(jié)果。(譯者注：由于個(gè)人水平有限，如果您發(fā)現(xiàn)譯處與原文有出入敬請(qǐng)指正。謝謝!)

如果沒有重定向，那么最后提交給表單的就是POST請(qǐng)求，所以一個(gè)“Refresh Action”會(huì)重新提交那個(gè)表單，將會(huì)導(dǎo)致第二次提交的post記錄和第一次寫入數(shù)據(jù)庫中的是相同的。這樣的行為Not so good.

若是有了重定向，我們可以強(qiáng)制瀏覽器在表單提交之后發(fā)出另一個(gè)請(qǐng)求，它抓取了重定向的頁面。這是一個(gè)簡單的“GET”請(qǐng)求，所以“Refresh”動(dòng)作會(huì)重復(fù)“GET”請(qǐng)求而不是再次提交表單。

這個(gè)簡單的小技巧避免用戶在提交一個(gè)blog post請(qǐng)求之后，不小心刷新頁面導(dǎo)致重復(fù)寫入post請(qǐng)求。

展現(xiàn)blog post請(qǐng)求

下面我們來說點(diǎn)有意思的東西。我們要從數(shù)據(jù)庫中抓取blog post請(qǐng)求并失之顯示。

如果你回憶一下之前部分文章，我們?cè)鴦?chuàng)建了許多所謂“虛假的”的請(qǐng)求并且在首頁上面顯示了很長時(shí)間。這些“虛假的”對(duì)象是作為Python list在索引視圖中創(chuàng)建的。

posts = [

{

'author': { 'nickname': 'John' },

'body': 'Beautiful day in Portland!'

},

{

'author': { 'nickname': 'Susan' },

'body': 'The Avengers movie was so cool!'

}

]

但是在上一篇文章中，我們創(chuàng)建的查詢語句允許我們從“關(guān)注的人”當(dāng)中獲取所有的請(qǐng)求，所以我們可以用下面的這個(gè)語句來替換上文(fileapp/views.py):

posts = g.user.followed_posts().all()

然后當(dāng)你運(yùn)行這個(gè)應(yīng)用的時(shí)候，你將會(huì)看到?jīng)_數(shù)據(jù)庫中抓取到的bolg post請(qǐng)求。

User類的followed_posts方法返回了一條抓取我們感興趣請(qǐng)求的SQL查詢語句。在這個(gè)查詢語句中，Callingall()檢索所有的請(qǐng)求到一個(gè)list當(dāng)中，所以我們以這個(gè)很像我們一直沿用至今的“虛假”請(qǐng)求的結(jié)構(gòu)結(jié)束。他們?nèi)绱说南嘞裆踔羣emplate都沒有注意到。

此時(shí)您可以在此應(yīng)用上自由發(fā)揮。你可以創(chuàng)建多個(gè)用戶，讓他們follow其他人，然后發(fā)布一些信息來看每一個(gè)用戶是如何看到它的bolg post請(qǐng)求數(shù)據(jù)流的。

分頁

我們的程序是越來越像樣了，但是我們面臨另外一個(gè)問題。我們?cè)谑醉擄@示了所有的followed post。如果一個(gè)用戶有上千篇followed post將會(huì)發(fā)生什么情況?或者一百萬篇?就像我們可以想象到的，抓取并處理這么龐大的對(duì)象列表是十分低效率的。

我們可以顯示把這么大量的post分組來顯示，或者分頁。

Flask-SQLAlchemy可以很好的支持分頁。例如，我們可以通過如下方法，輕松獲取某個(gè)用戶的前3篇的followed posts：

posts = g.user.followed_posts().paginate(1, 3, False).items

分頁方法可以被任何query對(duì)象調(diào)用。它接受3個(gè)參數(shù)：

頁碼，從1開始

每頁顯示的記錄數(shù)

錯(cuò)誤標(biāo)記。如果是True,如果接收到超出記錄范圍的頁面請(qǐng)求，那么404錯(cuò)誤請(qǐng)求將會(huì)自動(dòng)反饋到客戶端瀏覽器。如果是False，那么一個(gè)空列表將會(huì)被返回，而不顯示錯(cuò)誤。

paginate的返回值是一個(gè)Pagination對(duì)象。這個(gè)對(duì)象里面的成員包括了請(qǐng)求頁面中的記錄列表。稍后，我們會(huì)探討Pagination對(duì)象中另外一些有用的東西。

現(xiàn)在讓我們來想想，如何在我們的view函數(shù)中實(shí)現(xiàn)分頁。我們可以先把一些配置信息添加到我們的應(yīng)用中，包括我們每頁需要顯示多少條記錄(fileconfig.py):

# pagination

POSTS_PER_PAGE = 3

使用全局配置文件去改變我們應(yīng)用是一個(gè)很好的構(gòu)思，因?yàn)槲覀冎恍枰ヒ粋€(gè)地方就可以修改所有的配置。

在最后的應(yīng)用中，我們當(dāng)然會(huì)使用比3更大的數(shù)字，但是作為測試，使用小的數(shù)字會(huì)更有效。

之后，讓我們來看看URLs是如何判斷請(qǐng)求不同的頁面的。我們之前已知道，F(xiàn)lask的routes可以接受參數(shù)的，所以我們可以在URL添加后綴，來指明我們想要的頁面：

<-- page #1 (default)

<-- page #1 (default)

<-- page #1

<-- page #2

我們可以輕易地實(shí)現(xiàn)URLs格式，并添加新的route到我們的view函數(shù)當(dāng)中(fileapp/views.py)：

from config import POSTS_PER_PAGE

@app.route('/', methods = ['GET', 'POST'])

@app.route('/index', methods = ['GET', 'POST'])

@app.route('/index/<int:page>', methods = ['GET', 'POST'])

@login_required

def index(page = 1):

form = PostForm()

if form.validate_on_submit():

post = Post(body = form.post.data, timestamp = datetime.utcnow(), author = g.user)

db.session.add(post)

db.session.commit()

flash('Your post is now live!')

return redirect(url_for('index'))

posts = g.user.followed_posts().paginate(page, POSTS_PER_PAGE, False).items

return render_template('index.html',

title = 'Home',

form = form,

posts = posts)

我們的新route接受分頁參數(shù)，并把參數(shù)定義為整數(shù)。我們還需要添加分頁參數(shù)到index函數(shù)當(dāng)中，并給它們一個(gè)默認(rèn)值，因?yàn)槟侨齻€(gè)route當(dāng)中有兩個(gè)route沒有分頁參數(shù)，所以這些route就必須用到默認(rèn)值。

現(xiàn)在我們已經(jīng)得到了一個(gè)頁碼參數(shù)，并且可以輕易的應(yīng)用到我們的followed_post查詢當(dāng)中，而且還有一個(gè)我們之前以定義好的配置常量：POSTS_PER_PAGE。

我們可以注意到，這些更改是如何的簡單，并且當(dāng)我們更改一個(gè)頁面的時(shí)候，很少代碼會(huì)被影響。我們嘗試在寫應(yīng)用中的每個(gè)部分的時(shí)候，不去假設(shè)其他部分是如何的工作，這樣就會(huì)讓我們寫出模塊化的和健壯的應(yīng)用，使得測試更簡單，而且更少的出錯(cuò)機(jī)會(huì)，或者缺陷。

現(xiàn)在你可以嘗試在你的瀏覽器地址欄中，在URLs中輸入頁碼。請(qǐng)確保你的pots超過3個(gè)，這樣你就可以看到多個(gè)頁面。

頁面導(dǎo)航

現(xiàn)在我們需要添加鏈接，好讓我們的用戶可以查看上一個(gè)/下一個(gè)頁面，很幸運(yùn)，這個(gè)功能很容易實(shí)現(xiàn)，F(xiàn)lask-SQLAlchemy給我們完成了大部分的工作。

我們現(xiàn)在給view函數(shù)更改一小部分代碼。我們?cè)趐aginate方法中修改：

posts = g.user.followed_posts().paginate(page, POSTS_PER_PAGE, False).items

我們只保留了paginate方法返回的Pagination對(duì)象的item成員。但是這個(gè)對(duì)象包含一些非常有用的信息在里面，所以我們更改為保留Pagination對(duì)象(fileapp/views.py)：

posts = g.user.followed_posts().paginate(page, POSTS_PER_PAGE, False)

為了完成這個(gè)修改，我們還需要修改模板(fileapp/templates/index.html):

<!-- posts is a Paginate object -->

{% for post in posts.items %}

<p>

{{post.author.nickname}} says: <b>{{post.body}}</b>

</p>

{% endfor %}

我們所做的這些是為了把全套分頁對(duì)象應(yīng)用到我們的模板當(dāng)中。分頁對(duì)象會(huì)用到如下成員：

has_next: 如果本頁之后還有超過一個(gè)分頁，則返回True

has_prev: 如果本頁之前還有超過一個(gè)分頁，則返回True

next_num: 返回下一頁的頁碼

prev_num: 返回上一頁的頁碼

應(yīng)用這些成員，我們可以生成如下代碼(app/templates/index.html)：

<!-- posts is a Paginate object -->

{% for post in posts.items %}

<p>

{{post.author.nickname}} says: <b>{{post.body}}</b>

</p>

{% endfor %}

{% if posts.has_prev %}<a href="{{ url_for('index', page = posts.prev_num) }}"><< Newer posts</a>{% else %}<< Newer posts{% endif %} |

{% if posts.has_next %}<a href="{{ url_for('index', page = posts.next_num) }}">Older posts >></a>{% else %}Older posts >>{% endif %}

現(xiàn)在我們有兩個(gè)超鏈接。第一個(gè)是叫做"Newer posts"，可以鏈接到上一頁(請(qǐng)記住，我們是把最新的post排在最前面，所以上一頁的post是更加新的post)。相反，"Older posts"指向的是下一頁。

當(dāng)我們?cè)诘谝豁摰臅r(shí)候，我們不想顯示上一頁的鏈接，因?yàn)楦静淮嬖凇Ｎ覀兛梢暂p易的檢測得到，因?yàn)閜osts.has_prev返回False。針對(duì)這種情況，我們可以只顯示"上一頁"的文本而不帶鏈接屬性。而下一頁也是如此。

實(shí)現(xiàn)Post子模板

回到我們添加了阿凡達(dá)圖片的文章，我們使用HTML給一個(gè)單獨(dú)的post定義了一個(gè)子模板。原因是我們只需創(chuàng)建一次就可以多個(gè)地方使用，避免重復(fù)代碼?，F(xiàn)在我們就把這個(gè)子模板應(yīng)用到我們的index頁面中。就如我們今天做的事情一樣，這是非常簡單的事情(app/templates/index.html)：

<!-- posts is a Paginate object -->

{% for post in posts.items %}

{% include 'post.html' %}

{% endfor %}

神奇吧?我們只是把子模板替換舊的渲染代碼?，F(xiàn)在我們得到了包含了用戶的阿凡達(dá)圖片的post頁面。

用戶個(gè)人頁面

我們已完成了index頁面的開發(fā)。但是我們?cè)谟脩魝€(gè)人頁面中也引入了posts，該頁面只列出用戶自己所發(fā)表的post。相應(yīng)的，用戶個(gè)人頁面也需要按照index的設(shè)計(jì)去更改。

和index頁面的更改相似，以下是我們要做的幾點(diǎn)：

增加一個(gè)接受頁碼的route

為view函數(shù)增加一個(gè)頁碼參數(shù)，默認(rèn)值為1

使用合適的數(shù)據(jù)庫查詢與分頁代碼，替換post列表

使用分頁對(duì)象更新模板

下面是更新后的view函數(shù)(app/views.py)：

@app.route('/user/<nickname>')

@app.route('/user/<nickname>/<int:page>')

@login_required

def user(nickname, page = 1):

user = User.query.filter_by(nickname = nickname).first()

if user == None:

flash('User ' + nickname + ' not found.')

return redirect(url_for('index'))

posts = user.posts.paginate(page, POSTS_PER_PAGE, False)

return render_template('user.html',

user = user,

posts = posts)

我們注意到，這個(gè)函數(shù)已經(jīng)包含了一個(gè)參數(shù)(用戶的昵稱)，所以我們把頁碼添加到第二個(gè)參數(shù)。

更改模板也是相當(dāng)簡單(app/templates/user.html)：

<!-- posts is a Paginate object -->

{% for post in posts.items %}

{% include 'post.html' %}

{% endfor %}

{% if posts.has_prev %}<a href="{{ url_for('user', nickname = user.nickname, page = posts.prev_num) }}"><< Newer posts</a>{% else %}<< Newer posts{% endif %} |

{% if posts.has_next %}<a href="{{ url_for('user', nickname = user.nickname, page = posts.next_num) }}">Older posts >></a>{% else %}Older posts >>{% endif %}

更多信息請(qǐng)查看IT技術(shù)專欄