Flask-FlatPages

Flask-FlatPages为Flask应用提供一组页面。页面是由一些“平滑的”文本文件而非关系数据库构建。

• 工作于Python 2.6, 2.7 和 3.3+
• BSD licensed
• 最新文档on Read the Docs
• Source, issues and pull requestson Github
• 发布管理 on PyPI

安装

使用pip安装扩展：

$ pip install Flask-FlatPages

或者从Github上获取源码。

配置

开始使用，仅需要在配置好Flask application后，实例化一个FlatPages对象：

from flask import Flask
from flask_flatpages import FlatPages

app = Flask(__name__)
app.config.from_pyfile('mysettings.cfg')
pages = FlatPages(app)

你也可以通过init_app()，迟点传递Flask application:

pages = FlatPages()

def create_app(config='mysettings.cfg'): 
  app = Flask(__name__) 
  app.config.from_pyfile(config) 
  pages.init_app(app) 
  return app

Flask-FlatPages可接受下列配置值。所有值都是可选的：

• FLATPAGES_ROOT:
  页面文件的目录路径。如果relative，解释为相对于应用根路径，在static和templates目录旁边。默认为pages。

• FLATPAGES_EXTENSION:
  页面的文件拓展名。在FLATPAGES_ROOT目录内的文件，如果没有该后缀将被忽略。默认值位.html。
  0.6版起的变化：通过序列支持多个文件扩展名，如:['.htm','.html'] 或者 通过逗号分隔字符串：.htm,.html。

• FLATPAGES_ENCODING:
  页面文件的编码。默认为utf8。

• FLATPAGES_HTML_RENDERER:
  调用或导入至少一个可调用的页面body的Unicode字符串，并以Unicode字符串的形式返回其HTML。默认为pygmented_markdown()
  。
  0.5版的变化：支持将FlatPages实例作为第二个参数传递。
  0.6版的变化：支持将Page实例作为第三个参数传递。
  渲染函数至少需要一个参数，Unicode body。第二、第三个参数是可选的，允许更高级的渲染器。

• FLATPAGES_MARKDOWN_EXTENSIONS:
  0.4版新增。
  Markdown扩展列表使用默认的HTML渲染器。默认为['codehilite']。

---

---

API

FlatPages

classflask_flatpages.FlatPages(*app=None*,*name=None*)

一组页面对象。
使用示例：

pages = FlatPages(app)

@app.route('/')
def index():
  # Articles are pages with a publication date 
  articles = (p for p in pages if 'published' in p.meta) 
  # Show the 10 most recent articles, most recent first. 
  latest = sorted(articles, reverse=True, key=lambda p: p.meta['published']) 
  return render_template('articles.html', articles=latest[:10])

@app.route('/<path:path>/')
def page(path): 
  page = pages.get_or_404(path) 
  template = page.meta.get('template', 'flatpage.html') 
  return render_template(template, page=page)

__iter__()

迭代所有的页面对象。

get(path,default=None)

返回指定地址的页面，若无则返回默认页面

get_or_404(path)

返回指定地址的页面，若无则抛出Flask的404错误。

init_app(app)

用于初始化应用，有助于延后传递app和app工厂模式。
参数：app（一个Flask实例）——你的应用

reload()

忘掉所有页面。
所有页面将在其下一次访问是重载。

Page

classflask_flatpages.Page

一个简单的类，用来存储flatpages所有必要的信息。

主要目的是用html_renderer函数来渲染页面内容。

使用先前定义的hello.html:

# hello.html
title: Hello
published: 2010-12-22

Hello, *World*!

Lorem ipsum dolor sit amet, …

>>> page = pages.get('hello')
>>> page.meta # PyYAML converts YYYY-MM-DD to a date object
{'title': u'Hello', 'published': datetime.date(2010, 12, 22)}
>>> page['title']u'Hello'
>>> page.bodyu'Hello, *World*!\n\nLorem ipsum dolor sit amet, \u2026'
>>> page.html
u'<p>Hello, <em>World</em>!</p>\n<p>Lorem ipsum dolor sit amet, \u2026</p>'

__getitem__(name)

快捷访问元数据。
page['title'] 或者在模板内，{{ page.title }}，等价于 page.meta['title']

__html__()

模板内，{{ page }} 等价于 {{ page.html|safe }} 。

html

页面内容，使用配置好的渲染器渲染为HTML。

html_renderer = None

渲染函数

meta

文件头的元数据字典解析为YAML。

path = None

页面的路径，获取于pages.get(path)

---

flask_flatpages.pygmented_markdown(text,flatpages=None)

渲染Markdown文档为HTML。
只要Pygments可用，就使用CodeHilite扩展。否则，删掉扩展列表里的“codehilite”。
如果你想用其他扩展，使用FLATPAGES_MARKDOWN_EXTENSIONS，设置其字符串序列。

---

flask_flatpages.pygments_style_defs(style='default')

返回值：CodeHiliteMarkdown插件定义的CSS。
参数：sytle——使用的Pygment风格。
仅当Pygments可用时。

更新日志

Version 0.6

Released on 2015-02-09

• Python 3 support.
• Allow multiple file extensions for FlatPages.
• The renderer function now optionally takes a third argument, namely thePage
  instance.
• It is now possible to instantiate multiple instances ofFlatPages
  with different configurations. This is done by specifying an additional parametername
  to the initializer and adding the same name in uppercase to the respective Flask configuration settings.

Version 0.5

Released on 2013-04-02

• Change behavior of passingFLATPAGES_MARKDOWN_EXTENSIONS
  to renderer function, now theFlatPages
  instance is optionally passed as second argument. This allows more robust renderer functions.

Version 0.4

Released on 2013-04-01

• AddFLATPAGES_MARKDOWN_EXTENSIONS
  config to setup list of Markdown extensions to use with default HTML renderer.
• Fix a bug with non-ASCII filenames.

Version 0.3

Released on 2012-07-03

• AddFlatPages.init_app()
  
• Do not use namespace packages anymore: rename the package from flaskext.flatpages
  toflask_flatpages
• Add configuration files for testing with tox and Travis.

Version 0.2

Released on 2011-06-02
Bugfix and cosmetic release. Tests are now installed alongside the code.

Version 0.1

Released on 2011-02-06.
First public release.