Flask Web Development —— 模板(中)

作者 | ipython

2、集成Twitter Bootstrap的Flask-Bootstrap

Bootstrap是Twitter的一個(gè)開(kāi)源框架,提供用戶交互組件來(lái)創(chuàng)建一個(gè)清新且有吸引力的web頁(yè)面,并兼容所有現(xiàn)代web瀏覽器。

Bootstrap是一個(gè)客戶端框架,服務(wù)端不直接參與。服務(wù)端需要做的就是提供HTML響應(yīng),引用層疊樣式表(CSS)和JavaScript文件并通過(guò)HTML、CSS、和JavaScript代碼來(lái)實(shí)例化需要的組件。模板是做這些的理想地方。

集成Bootstrap到應(yīng)用程序最好的方式是在模板中做一些必要的改變。一個(gè)簡(jiǎn)單點(diǎn)的途徑就是使用Flask-Bootstrap擴(kuò)展去簡(jiǎn)化集成工作。可以通過(guò)pip來(lái)安裝Flask-Bootstrap:

(venv) $ pip install flask-bootstrap

Flask擴(kuò)展通常在應(yīng)用程序?qū)嵗粍?chuàng)建的時(shí)候初始化。示例3-4展示Flask-Bootstrap的初始化。

示例3-4. hello.py:Flask-Bootstrap初始化

from flask.ext.bootstrap import Bootstrap
# ...
bootstrap = Bootstrap(app)

和第二章的Flask-Script一樣,F(xiàn)lask-Bootstrap從flask.ext命名空間導(dǎo)入并通過(guò)傳遞應(yīng)用程序?qū)嵗綐?gòu)造函數(shù)來(lái)初始化。

一旦Flask-Bootstrap被初始化,一個(gè)包含所有Bootstrap文件的基礎(chǔ)模板就可供應(yīng)用程序使用了。這個(gè)模板利用Jinja2的模板繼承,應(yīng)用程序則可以擴(kuò)展一個(gè)擁有通用頁(yè)面結(jié)構(gòu),且包含Bootstrap導(dǎo)入的元素的基礎(chǔ)模板。示例3-5展示作為派生模板的新版user.html。

_示例3-5. templates/user.html: 使用Flask-Bootstrap的模板

{% extends "bootstrap/base.html" %}
{% block title %}Flasky{% endblock %}
{% block navbar %}

<div class="navbar navbar-inverse" role="navigation"> 
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle" 
        data-toggle="collapse" data-target=".navbar-collapse"> 
        <span class="sr-only">Toggle navigation</span> 
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="/">Flasky</a> 
    </div>
    <div class="navbar-collapse collapse"> 
      <ul class="nav navbar-nav">
        <li><a href="/">Home</a></li> 
      </ul>
    </div>
  </div>
</div>

{% endblock %}

{% block content %}

<div class="container">
  <div class="page-header">
    <h1>Hello, {{ name }}!</h1> 
  </div>
</div>

{% endblock %}

Jinja2的extends指令通過(guò)從Flask-Bootstrap引用bootstrap/base.html來(lái)實(shí)現(xiàn)模板的繼承。Flask-Bootstrap的基礎(chǔ)模板提供一個(gè)包含Bootstrap CSS和JavaScript文件的web頁(yè)面骨架。

基礎(chǔ)模板定義了一些可以被派生模板重寫(xiě)的block。block和endblock指令定義了被添加到基礎(chǔ)模板中block的內(nèi)容。

上面的user.html模板定義了三個(gè)block,分別命名為title、navbar和content。基礎(chǔ)模板里的這些block輸出派生模板定義的內(nèi)容。title塊比較簡(jiǎn)單;它的內(nèi)容將出現(xiàn)在<title>標(biāo)簽內(nèi),然后被渲染在HTML文檔的頭部 。navbar和content塊則是為頁(yè)面保留的導(dǎo)航欄和主內(nèi)容。

在這個(gè)模板中,navbar塊使用Bootstrap組件定義了一個(gè)簡(jiǎn)單的導(dǎo)航欄。content塊有個(gè)名為container的<div>,里面嵌套了名為page-header的<div>。圖3-1展示這些操作后應(yīng)用程序長(zhǎng)成啥樣了。

建議:如果你有克隆在GitHub上的應(yīng)用程序,你現(xiàn)在可以運(yùn)行g(shù)it checkout 3b來(lái)切換到這個(gè)版本的應(yīng)用程序。Bootstrap官方文檔 是一個(gè)非常強(qiáng)大的學(xué)習(xí)資料,完全可以復(fù)制粘貼使用那些示例。

圖片3-1. Twitter Bootstrap模板

Flask-Bootstrap的base.html模板定義了一些其他可供派生模板使用的block。表格3-2展示了完整的可用block列表。

表格3-2. Flask-Bootstrap基礎(chǔ)模板中的block

表格3-2中的許多塊用于Flask-Bootstrap自身,所以直接重寫(xiě)它們會(huì)引發(fā)問(wèn)題。例如,styles和scripts塊是Bootstrap定義文件的地方。如果應(yīng)用程序需要新增自己的內(nèi)容到已經(jīng)有一些內(nèi)容的塊中,則必須使用Jinja2的super()。例如,如何在派生模板中寫(xiě)scripts塊,來(lái)給文檔增加新的JavaScript文件:

{% block scripts %}
{{ super() }}
<script type="text/javascript" src="my-script.js"></script> 
{% endblock %}

3、自定義錯(cuò)誤頁(yè)面

當(dāng)你輸入錯(cuò)誤路徑在你的瀏覽器地址欄,你會(huì)得到404錯(cuò)誤代碼頁(yè)面。目前的錯(cuò)誤頁(yè)面很普通也沒(méi)有吸引力,且沒(méi)有一致的使用Bootstrap頁(yè)面。

Flask允許應(yīng)用程序自定義基于模板的錯(cuò)誤頁(yè)面,就像常規(guī)的路由。兩個(gè)最常見(jiàn)的錯(cuò)誤代碼,404是在客戶端請(qǐng)求的頁(yè)面或路徑不存在的時(shí)候觸發(fā);500是當(dāng)存在未處理的異常時(shí)觸發(fā)。示例3-6展示如何為這兩個(gè)錯(cuò)誤提供自定義處理。

示例3-6. hello.py:自定義錯(cuò)誤頁(yè)面

@app.errorhandler(404) 
def page_not_found(e):
    return render_template('404.html'), 404

@app.errorhandler(500)
def internal_server_error(e):
    return render_template('500.html'), 500

錯(cuò)誤處理返回響應(yīng),和視圖函數(shù)一樣。同時(shí)返回相應(yīng)錯(cuò)誤的數(shù)字狀態(tài)碼。

在錯(cuò)誤處理中引用的模板需要自己去寫(xiě)。這些模板需要和常規(guī)的頁(yè)面一樣的布局,所以在這個(gè)示例中需要導(dǎo)航欄和頁(yè)面頭部顯示錯(cuò)誤信息。

編寫(xiě)這些模板的簡(jiǎn)單方式是復(fù)制templates/user.html到templates/404.html和templates/500.html,然后改變這兩個(gè)新文件的頁(yè)面頭部元素來(lái)給出相應(yīng)的錯(cuò)誤信息,但這會(huì)產(chǎn)生很多副本。

Jinja2的模板繼承可以幫助我們解決這個(gè)問(wèn)題。Flask-Bootstrap提供了一個(gè)帶有基本布局頁(yè)面的基礎(chǔ)模板,應(yīng)用程序可以定義自己的、帶有完整頁(yè)面布局的基礎(chǔ)模板,包括導(dǎo)航欄和定義在派生模板中的頁(yè)面內(nèi)容。示例3-7展示了templates/base.html,它是一個(gè)繼承自bootstrap/base.html的新模板且定義了導(dǎo)航欄,但對(duì)于其他模板則是一個(gè)基礎(chǔ)模板,例如templates/user.html、templates/404.html和templates/500.html。

_示例3-7. templates/base.html:帶有導(dǎo)航欄的基礎(chǔ)應(yīng)用程序模板

{% extends "bootstrap/base.html" %}
{% block title %}Flasky{% endblock %}
{% block navbar %}


<div class="navbar navbar-inverse" role="navigation"> 
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle" 
        data-toggle="collapse" data-target=".navbar-collapse"> 
        <span class="sr-only">Toggle navigation</span> 
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="/">Flasky</a>
    </div>
    <div class="navbar-collapse collapse"> 
      <ul class="nav navbar-nav">
        <li><a href="/">Home</a></li> 
      </ul>
    </div>
  </div>
</div>

{% endblock %}

{% block content %}

<div class="container">
  {% block page_content %}{% endblock %}
</div>

{% endblock %}

這個(gè)模板中的content塊中只是一個(gè)名為container的<div>元素,它包含了在派生模板中定義的名為page_content的空block。

應(yīng)用程序的模板將從該模板繼承而不是直接從Flask-Bootstrap繼承。示例3-8展示了從templates/base.html繼承來(lái)構(gòu)造一個(gè)自定義404錯(cuò)誤頁(yè)面是如此的簡(jiǎn)單。

示例3-8. templates/404.html:使用模板繼承自定義404錯(cuò)誤頁(yè)面

{% extends "base.html" %}
{% block title %}Flasky - Page Not Found{% endblock %}
{% block page_content %}
<div class="page-header"> 
  <h1>Not Found</h1>
</div>
{% endblock %}

圖片3-2展示在瀏覽器中錯(cuò)誤頁(yè)面是怎樣的。

圖片3-2. 自定義404錯(cuò)誤頁(yè)面

現(xiàn)在templates/user.html模板可以通過(guò)繼承基礎(chǔ)模板來(lái)簡(jiǎn)化它,就像示例3-9展示的這樣。

示例3-9. templates/user.html:使用模板繼承簡(jiǎn)化頁(yè)面模板

{% extends "base.html" %}
{% block title %}Flasky{% endblock %}
{% block page_content %}
<div class="page-header"> 
  <h1>Hello, {{ name }}!</h1>
</div>
{% endblock %}

建議:如果你有克隆在GitHub上的應(yīng)用程序,你現(xiàn)在可以運(yùn)行g(shù)it checkout 3c來(lái)切換到這個(gè)版本的應(yīng)用程序。

原文轉(zhuǎn)載:https://segmentfault.com/a/1190000000755204

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,702評(píng)論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,143評(píng)論 3 415
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 175,553評(píng)論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 62,620評(píng)論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,416評(píng)論 6 405
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 54,940評(píng)論 1 321
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,024評(píng)論 3 440
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 42,170評(píng)論 0 287
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,709評(píng)論 1 333
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,597評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,784評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,291評(píng)論 5 357
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,029評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 34,407評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 35,663評(píng)論 1 280
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,403評(píng)論 3 390
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,746評(píng)論 2 370

推薦閱讀更多精彩內(nèi)容

  • 22年12月更新:個(gè)人網(wǎng)站關(guān)停,如果仍舊對(duì)舊教程有興趣參考 Github 的markdown內(nèi)容[https://...
    tangyefei閱讀 35,199評(píng)論 22 257
  • 第三章 模板 序 為什么要分離 易于維護(hù)的代碼,關(guān)鍵在于保持簡(jiǎn)單的結(jié)構(gòu)。而我們之前編寫(xiě)的hello.py雖然簡(jiǎn)單,...
    科幻經(jīng)典閱讀 1,543評(píng)論 0 6
  • 第三章 模板(Templates) 編寫(xiě)易于維護(hù)的程序的要點(diǎn)在于書(shū)寫(xiě)干凈、良好結(jié)構(gòu)的代碼。你以前所見(jiàn)的代碼都過(guò)于...
    易木成華閱讀 1,147評(píng)論 0 2
  • 渲染模板 模板文件后綴名是 .html, 這些文件就是普通的 html 文件加上一些占位符變量, 它們都默認(rèn)存放在...
    焉知非魚(yú)閱讀 698評(píng)論 0 1
  • View Function有兩個(gè)任務(wù):(1)處理業(yè)務(wù)邏輯 (2)返回響應(yīng)內(nèi)容。將兩者分開(kāi)管理能夠使代碼更好容易維護(hù)...
    tangyefei閱讀 2,808評(píng)論 1 8