-
Notifications
You must be signed in to change notification settings - Fork 53
/
__init__.py
239 lines (191 loc) · 7.33 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# coding: utf8
"""
flas_flatpages
~~~~~~~~~~~~~~~~~~
Flask-FlatPages provides a collections of pages to your Flask application.
Pages are built from “flat” text files as opposed to a relational database.
:copyright: (c) 2010 by Simon Sapin.
:license: BSD, see LICENSE for more details.
"""
from __future__ import with_statement
import os.path
import itertools
import yaml
import markdown
import werkzeug
import flask
def pygmented_markdown(text):
"""Render Markdown text to HTML. Uses the `Codehilite`_ extension
if `Pygments`_ is available.
.. _Codehilite: http://www.freewisdom.org/projects/python-markdown/CodeHilite
.. _Pygments: http://pygments.org/
"""
try:
import pygments
except ImportError:
extensions = []
else:
extensions = ['codehilite']
return markdown.markdown(text, extensions)
def pygments_style_defs(style='default'):
""":return: the CSS definitions for the `Codehilite`_ Markdown plugin.
:param style: The Pygments `style`_ to use.
Only available if `Pygments`_ is.
.. _Codehilite: http://www.freewisdom.org/projects/python-markdown/CodeHilite
.. _Pygments: http://pygments.org/
.. _style: http://pygments.org/docs/styles/
"""
import pygments.formatters
formater = pygments.formatters.HtmlFormatter(style=style)
return formater.get_style_defs('.codehilite')
class Page(object):
def __init__(self, path, meta_yaml, body, html_renderer):
#: Path this pages was obtained from, as in ``pages.get(path)``.
self.path = path
#: Content of the pages.
self.body = body
self._meta_yaml = meta_yaml
self.html_renderer = html_renderer
def __repr__(self):
return '<Page %r>' % self.path
@werkzeug.cached_property
def html(self):
"""The content of the page, rendered as HTML by the configured renderer.
"""
return self.html_renderer(self.body)
def __html__(self):
"""In a template, ``{{ page }}`` is equivalent to
``{{ page.html|safe }}``.
"""
return self.html
@werkzeug.cached_property
def meta(self):
"""A dict of metadata parsed as YAML from the header of the file."""
meta = yaml.safe_load(self._meta_yaml)
# YAML documents can be any type but we want a dict
# eg. yaml.safe_load('') -> None
# yaml.safe_load('- 1\n- a') -> [1, 'a']
if not meta:
return {}
assert isinstance(meta, dict)
return meta
def __getitem__(self, name):
"""Shortcut for accessing metadata.
``page['title']`` or, in a template, ``{{ page.title }}`` are
equivalent to ``page.meta['title']``.
"""
return self.meta[name]
class FlatPages(object):
"""
A collections of :class:`Page` objects.
:param app: your application. Can be omited if you call
:meth:`init_app` later.
:type app: Flask instance
"""
def __init__(self, app=None):
#: dict of filename: (page object, mtime when loaded)
self._file_cache = {}
if app:
self.init_app(app)
def init_app(self, app):
""" Used to initialize an application, useful for
passing an app later and app factory patterns.
:param app: your application
:type app: Flask instance
"""
app.config.setdefault('FLATPAGES_ROOT', 'pages')
app.config.setdefault('FLATPAGES_EXTENSION', '.html')
app.config.setdefault('FLATPAGES_ENCODING', 'utf8')
app.config.setdefault('FLATPAGES_HTML_RENDERER', pygmented_markdown)
app.config.setdefault('FLATPAGES_AUTO_RELOAD', 'if debug')
self.app = app
app.before_request(self._conditional_auto_reset)
def _conditional_auto_reset(self):
"""Reset if configured to do so on new requests."""
auto = self.app.config['FLATPAGES_AUTO_RELOAD']
if auto == 'if debug':
auto = self.app.debug
if auto:
self.reload()
def reload(self):
"""Forget all pages.
All pages will be reloaded next time they're accessed"""
try:
# This will "unshadow" the cached_property.
# The property will be re-executed on next access.
del self.__dict__['_pages']
except KeyError:
pass
def __iter__(self):
"""Iterate on all :class:`Page` objects."""
return self._pages.itervalues()
def get(self, path, default=None):
"""
:Return: the :class:`Page` object at ``path``, or ``default``
if there is none.
"""
# This may trigger the property. Do it outside of the try block.
pages = self._pages
try:
return pages[path]
except KeyError:
return default
def get_or_404(self, path):
""":Return: the :class:`Page` object at ``path``.
:raises: :class:`NotFound` if the pages does not exist.
This is caught by Flask and triggers a 404 error.
"""
page = self.get(path)
if not page:
flask.abort(404)
return page
@property
def root(self):
"""Full path to the directory where pages are looked for.
It is the `FLATPAGES_ROOT` config value, interpreted as relative to
the app root directory.
"""
return os.path.join(self.app.root_path,
self.app.config['FLATPAGES_ROOT'])
@werkzeug.cached_property
def _pages(self):
"""Walk the page root directory an return a dict of
unicode path: page object.
"""
def _walk(directory, path_prefix=()):
for name in os.listdir(directory):
full_name = os.path.join(directory, name)
if os.path.isdir(full_name):
_walk(full_name, path_prefix + (name,))
elif name.endswith(extension):
name_without_extension = name[:-len(extension)]
path = u'/'.join(path_prefix + (name_without_extension,))
pages[path] = self._load_file(path, full_name)
extension = self.app.config['FLATPAGES_EXTENSION']
pages = {}
_walk(self.root)
return pages
def _load_file(self, path, filename):
mtime = os.path.getmtime(filename)
cached = self._file_cache.get(filename)
if cached and cached[1] == mtime:
# cached == (page, old_mtime)
page = cached[0]
else:
with open(filename) as fd:
content = fd.read().decode(
self.app.config['FLATPAGES_ENCODING'])
page = self._parse(content, path)
self._file_cache[filename] = page, mtime
return page
def _parse(self, string, path):
lines = iter(string.split(u'\n'))
# Read lines until an empty line is encountered.
meta = u'\n'.join(itertools.takewhile(unicode.strip, lines))
# The rest is the content. `lines` is an iterator so it continues
# where `itertools.takewhile` left it.
content = u'\n'.join(lines)
html_renderer = self.app.config['FLATPAGES_HTML_RENDERER']
if not callable(html_renderer):
html_renderer = werkzeug.import_string(html_renderer)
return Page(path, meta, content, html_renderer)