Flask入门教程实例:搭建一个静态博客


Posted in Python onMarch 27, 2015

现在流行的静态博客/网站生成工具有很多,比如 Jekyll, Pelican, Middleman, Hyde 等等,StaticGen 列出了目前最流行的一些静态网站生成工具。

我们的内部工具由 Python/Flask/MongoDB 搭建,现在需要加上文档功能,写作格式是 Markdown,不想把文档放到数据库里,也不想再弄一套静态博客工具来管理文档,于是找到了 Flask-FlatPages 这个好用的 Flask 模块。熟悉 Flask 的同学花几分钟的时间就可以用搭建一个简单博客,加上 Bootstrap 的帮助,不到一小时内就可以用 Flask-Flatpages 弄个像模像样的网站出来。

创建开发环境

首先我们需要 pip,在 Mac 上最简单的安装办法是:

$ sudo easy_install pip

$ sudo easy_install virtualenv

如果你在 Mac 上用 Homebrew 包管理工具的话的话,也可以用 brew 升级 Python 和安装 pip:
$ brew update

$ brew install python

创建一个 blog 目录、生成 Python 独立虚拟环境并在这个环境里安装需要的 Flask, Flask-FlatPages 模块:
$ mkdir blog

$ cd blog
$ virtualenv flask

New python executable in flask/bin/python

Installing setuptools, pip...done.
$ flask/bin/pip install flask

$ flask/bin/pip install flask-flatpages

在 blog 目录下我们分别新建几个目录:static 用来存放 css/js 等文件,templates 用来存放 flask 要用的 Jinja2 模版,pages 用来存放我们静态博客(Markdown 格式):
$ mkdir -p app/static app/templates app/pages

程序

主程序 blog.py 的功能是,导入必要的模块、配置 Flask-FlatPages 模块需要的参数、创建 Flask 应用、写几个 URL 路由函数,最后运行这个应用:

$ vi app/blog.py

#!flask/bin/python

from flask import Flask, render_template

from flask_flatpages import FlatPages
DEBUG = True

FLATPAGES_AUTO_RELOAD = DEBUG

FLATPAGES_EXTENSION = '.md'
app = Flask(__name__)

app.config.from_object(__name__)

flatpages = FlatPages(app)
@app.route('/')

def index():

    pages = (p for p in flatpages if 'date' in p.meta)

    return render_template('index.html', pages=pages)
@app.route('/pages/<path:path>/')

def page(path):

    page = flatpages.get_or_404(path)

    return render_template('page.html', page=page)
if __name__ == '__main__':

    app.run(port=8000)

模版

在 Python 中直接生成 HTML 很繁琐并不好玩(那是上个世纪90年代的 PHP 搞的事情),在现代社会,我们使用模版引擎,Flask 已经自动配置好了 Jinja2 模版,使用方法 render_template() 来渲染模版就可以了。Flask 会默认在 templates 目录里中寻找模版,我们只需要创建几个模版文件就可以了,这里我们创建 base.html, index.html 和 page.html.

$ vi app/templates/base.html

<!doctype html>

<html>

<head>

    <meta charset="utf-8">

    <title>vpsee.com static blog</title>

</head>
<body>

    <h1><a href="{{ url_for("index") }}">vpsee.com blog</a></h1>

    {% block content %}

    {% endblock content %}

</body>

</html>

代码里 extends “base.html” 的意思是从 base.html 里继承基本的 “骨架”。
$ vi app/templates/index.html

{% extends "base.html" %}
{% block content %}

    <h2>List of pages

    <ul>

        {% for page in pages %}

        <li>

            <a href="{{ url_for("page", path=page.path) }}">{{ page.title }}</a>

        </li>

        {% else %}

        <li>No post.</li>

        {% endfor %}

    </ul>

{% endblock content %}

$ vi app/templates/page.html

{% extends "base.html" %}
{% block content %}

    <h2>{{ page.title }}</h2>

    {{ page.html|safe }}

{% endblock content %}

Flask-FlatPages 模块会默认从 pages 目录里寻找 .md 结尾的 Markdown 文档,所以我们把静态博客的内容都放在这个目录里:
$ vi app/pages/hello-world.md

title: Hello World

date: 2014-10-14

tags: [general, blog]
**Hello World**!
$ vi app/pages/test-flatpages.md

title: Test Flask FlatPages

date: 2014-10-15

tags: [python, flask]
Test [Flask-FlatPages](https://pythonhosted.org/Flask-FlatPages/)

运行

基本搞定,运行看看效果吧:

$ flask/bin/python app/blog.py

 * Running on http://127.0.0.1:8000/

 * Restarting with reloader

Flask入门教程实例:搭建一个静态博客

静态化

到目前为止,上面的博客运行良好,但是有个问题,这个博客还不是 “静态” 的,没有生成任何 html 文件,不能直接放到 nginx/apache 这样的 web 服务器下用。所以我们需要另一个 Flask 模块 Frozen-Flask 的帮助。

安装 Frozen-Flask:

$ flask/bin/pip install frozen-flask

修改 blog.py,导入 Flask-Frozen 模块,初始化 Freezer,使用 freezer.freeze() 生成静态 HTML:
$ vi app/blog.py

...

from flask_flatpages import FlatPages

from flask_frozen import Freezer

import sys

...

flatpages = FlatPages(app)

freezer = Freezer(app)

...

if __name__ == '__main__':

    if len(sys.argv) > 1 and sys.argv[1] == "build":

        freezer.freeze()

    else:

        app.run(port=8000)

运行 blog.py build 后就在 app 目录下生成 build 目录,build 目录里面就是我们要的 HTML 静态文件:
$ flask/bin/python app/blog.py build
$ ls app/

blog.py   build     pages     static    templates

更清晰的目录结构如下:
$ tree app

app

├── blog.py

├── build

│   ├── index.html

│   └── pages

│       ├── hello-world

│       │   └── index.html

│       └── test-flatpages

│           └── index.html

├── pages

│   ├── hello-world.md

│   └── test-flatpages.md

├── static

└── templates

    ├── base.html

    ├── index.html

    └── page.html
Python 相关文章推荐
python中使用smtplib和email模块发送邮件实例
Apr 22 Python
Python中除法使用的注意事项
Aug 21 Python
Python中logging模块的用法实例
Sep 29 Python
修改Python的pyxmpp2中的主循环使其提高性能
Apr 24 Python
如何优雅地改进Django中的模板碎片缓存详解
Jul 04 Python
Python实现的批量修改文件后缀名操作示例
Dec 07 Python
Python openpyxl 遍历所有sheet 查找特定字符串的方法
Dec 10 Python
python图像处理模块Pillow的学习详解
Oct 09 Python
python实现while循环打印星星的四种形状
Nov 23 Python
在django项目中导出数据到excel文件并实现下载的功能
Mar 13 Python
Python使用Selenium实现淘宝抢单的流程分析
Jun 23 Python
python爬虫调度器用法及实例代码
Nov 30 Python
Python中的高级数据结构详解
Mar 27 #Python
python中反射用法实例
Mar 27 #Python
Python中使用摄像头实现简单的延时摄影技术
Mar 27 #Python
python根据出生日期返回年龄的方法
Mar 26 #Python
python获取远程图片大小和尺寸的方法
Mar 26 #Python
python使用cStringIO实现临时内存文件访问的方法
Mar 26 #Python
python使用pil生成缩略图的方法
Mar 26 #Python
You might like
php判断是否为ajax请求的方法
2016/11/29 PHP
JavaScript delete操作符应用实例
2009/01/13 Javascript
基于jquery的二级联动菜单实现代码
2011/04/25 Javascript
Javascript开发之三数组对象实例介绍
2012/11/12 Javascript
JS+CSS实现一个气泡提示框
2013/08/18 Javascript
正则表达式中特殊符号及正则表达式的几种方法总结(replace,test,search)
2013/11/26 Javascript
利用js(jquery)操作Cookie的方法说明
2013/12/19 Javascript
Array栈方法和队列方法的特点说明
2014/01/24 Javascript
jquery实现无限分级横向导航菜单的方法
2015/03/12 Javascript
浅谈jquery中使用canvas的问题
2016/10/10 Javascript
servlet+jquery实现文件上传进度条示例代码
2017/01/25 Javascript
微信小程序 出现错误:{&quot;baseresponse&quot;:{&quot;errcode&quot;:-80002,&quot;errmsg&quot;:&quot;&quot;}}解决办法
2017/02/23 Javascript
关于vuex的学习实践笔记
2017/04/05 Javascript
jQuery remove()过滤被删除的元素(推荐)
2017/07/18 jQuery
小程序获取周围IBeacon设备的方法
2018/10/31 Javascript
Vue.js上传图片到阿里云OSS存储的方法示例
2018/12/13 Javascript
快速对接payjq的个人微信支付接口过程解析
2019/08/15 Javascript
如何基于jQuery实现五角星评分
2020/09/02 jQuery
python多进程中的内存复制(实例讲解)
2018/01/05 Python
PyQt5 文本输入框自动补全QLineEdit的实现示例
2020/05/13 Python
Python自动巡检H3C交换机实现过程解析
2020/08/14 Python
实例讲解HTML5的meta标签的一些应用
2015/12/08 HTML / CSS
详解html5 postMessage解决跨域通信的问题
2018/08/17 HTML / CSS
应用艺术专业个人的自我评价
2014/01/03 职场文书
《雕塑之美》教学反思
2014/04/24 职场文书
国际贸易毕业生求职信
2014/07/20 职场文书
我的中国梦演讲稿400字
2014/08/19 职场文书
领导干部对照检查材料
2014/08/24 职场文书
干部对照检查材料范文
2014/08/26 职场文书
个人买房协议书范本
2014/10/06 职场文书
店铺转让协议书
2015/01/29 职场文书
企业愿景口号
2015/12/25 职场文书
《我的伯父鲁迅先生》教学反思
2016/02/16 职场文书
Django实现翻页的示例代码
2021/05/24 Python
php修改word的实例方法
2021/11/17 PHP
浅谈Redis变慢的原因及排查方法
2022/06/21 Redis