comparison piecrust/rendering.py @ 369:4b1019bb2533

serve: Giant refactor to change how we handle data when serving pages. * We need a distinction between source metadata and route metadata. In most cases they're the same, but in cases like taxonomy pages, route metadata contains more things that can't be in source metadata if we want to re-use cached pages. * Create a new `QualifiedPage` type which is a page with a specific route and route metadata. Pass this around in many places. * Instead of passing an URL around, use the route in the `QualifiedPage` to generate URLs. This is better since it removes the guess-work from trying to generate URLs for sub-pages. * Deep-copy app and page configurations before passing them around to things that could modify them, like data builders and such. * Exclude taxonomy pages from iterator data providers. * Properly nest iterator data providers for when the theme and user page sources are merged inside `site.pages`.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 03 May 2015 18:47:10 -0700
parents 938be93215cb
children e7b865f8f335
comparison
equal deleted inserted replaced
368:2408eb6f4da8 369:4b1019bb2533
1 import re 1 import re
2 import os.path 2 import os.path
3 import logging 3 import logging
4 from werkzeug.utils import cached_property
4 from piecrust.data.builder import (DataBuildingContext, build_page_data, 5 from piecrust.data.builder import (DataBuildingContext, build_page_data,
5 build_layout_data) 6 build_layout_data)
6 from piecrust.data.filters import ( 7 from piecrust.data.filters import (
7 PaginationFilter, HasFilterClause, IsFilterClause, AndBooleanClause, 8 PaginationFilter, HasFilterClause, IsFilterClause, AndBooleanClause,
8 page_value_accessor) 9 page_value_accessor)
23 24
24 class TemplateEngineNotFound(Exception): 25 class TemplateEngineNotFound(Exception):
25 pass 26 pass
26 27
27 28
29 class QualifiedPage(object):
30 def __init__(self, page, route, route_metadata):
31 self.page = page
32 self.route = route
33 self.route_metadata = route_metadata
34
35 def getUri(self, sub_num=1):
36 return self.route.getUri(self.route_metadata, provider=self.page,
37 sub_num=sub_num)
38
39 def __getattr__(self, name):
40 return getattr(self.page, name)
41
42
28 class RenderedPage(object): 43 class RenderedPage(object):
29 def __init__(self, page, uri, num=1): 44 def __init__(self, page, uri, num=1):
30 self.page = page 45 self.page = page
31 self.uri = uri 46 self.uri = uri
32 self.num = num 47 self.num = num
51 self.used_source_names = set() 66 self.used_source_names = set()
52 self.used_taxonomy_terms = set() 67 self.used_taxonomy_terms = set()
53 68
54 69
55 class PageRenderingContext(object): 70 class PageRenderingContext(object):
56 def __init__(self, page, uri, page_num=1, force_render=False): 71 def __init__(self, qualified_page, page_num=1, force_render=False):
57 self.page = page 72 self.page = qualified_page
58 self.uri = uri
59 self.page_num = page_num 73 self.page_num = page_num
60 self.force_render = force_render 74 self.force_render = force_render
61 self.pagination_source = None 75 self.pagination_source = None
62 self.pagination_filter = None 76 self.pagination_filter = None
63 self.custom_data = None 77 self.custom_data = None
72 return self.page.app 86 return self.page.app
73 87
74 @property 88 @property
75 def source_metadata(self): 89 def source_metadata(self):
76 return self.page.source_metadata 90 return self.page.source_metadata
91
92 @cached_property
93 def uri(self):
94 return self.page.getUri(self.page_num)
77 95
78 @property 96 @property
79 def current_pass_info(self): 97 def current_pass_info(self):
80 return self.render_passes.get(self._current_pass) 98 return self.render_passes.get(self._current_pass)
81 99
127 eis.pushPage(ctx.page, ctx) 145 eis.pushPage(ctx.page, ctx)
128 try: 146 try:
129 page = ctx.page 147 page = ctx.page
130 148
131 # Build the data for both segment and layout rendering. 149 # Build the data for both segment and layout rendering.
132 data_ctx = DataBuildingContext(page, ctx.uri, ctx.page_num) 150 data_ctx = DataBuildingContext(page, page_num=ctx.page_num)
133 data_ctx.pagination_source = ctx.pagination_source 151 data_ctx.pagination_source = ctx.pagination_source
134 data_ctx.pagination_filter = ctx.pagination_filter 152 data_ctx.pagination_filter = ctx.pagination_filter
135 page_data = build_page_data(data_ctx) 153 page_data = build_page_data(data_ctx)
136 if ctx.custom_data: 154 if ctx.custom_data:
137 page_data.update(ctx.custom_data) 155 page_data.update(ctx.custom_data)
154 layout_name = page.config.get('layout') 172 layout_name = page.config.get('layout')
155 if layout_name is None: 173 if layout_name is None:
156 layout_name = page.source.config.get('default_layout', 'default') 174 layout_name = page.source.config.get('default_layout', 'default')
157 null_names = ['', 'none', 'nil'] 175 null_names = ['', 'none', 'nil']
158 if layout_name not in null_names: 176 if layout_name not in null_names:
159 layout_data = build_layout_data(page, page_data, contents) 177 build_layout_data(page, page_data, contents)
160 output = render_layout(layout_name, page, layout_data) 178 output = render_layout(layout_name, page, page_data)
161 else: 179 else:
162 output = contents['content'] 180 output = contents['content']
163 181
164 rp = RenderedPage(page, ctx.uri, ctx.page_num) 182 rp = RenderedPage(page, ctx.uri, ctx.page_num)
165 rp.data = page_data 183 rp.data = page_data
171 189
172 190
173 def render_page_segments(ctx): 191 def render_page_segments(ctx):
174 repo = ctx.app.env.rendered_segments_repository 192 repo = ctx.app.env.rendered_segments_repository
175 if repo: 193 if repo:
176 cache_key = '%s:%s' % (ctx.uri, ctx.page_num) 194 cache_key = ctx.uri
177 return repo.get(cache_key, 195 return repo.get(
196 cache_key,
178 lambda: _do_render_page_segments_from_ctx(ctx), 197 lambda: _do_render_page_segments_from_ctx(ctx),
179 fs_cache_time=ctx.page.path_mtime) 198 fs_cache_time=ctx.page.path_mtime)
180 199
181 return _do_render_page_segments_from_ctx(ctx) 200 return _do_render_page_segments_from_ctx(ctx)
182 201
184 def _do_render_page_segments_from_ctx(ctx): 203 def _do_render_page_segments_from_ctx(ctx):
185 eis = ctx.app.env.exec_info_stack 204 eis = ctx.app.env.exec_info_stack
186 eis.pushPage(ctx.page, ctx) 205 eis.pushPage(ctx.page, ctx)
187 ctx.setCurrentPass(PASS_FORMATTING) 206 ctx.setCurrentPass(PASS_FORMATTING)
188 try: 207 try:
189 data_ctx = DataBuildingContext(ctx.page, ctx.uri, ctx.page_num) 208 data_ctx = DataBuildingContext(ctx.page, page_num=ctx.page_num)
190 page_data = build_page_data(data_ctx) 209 page_data = build_page_data(data_ctx)
191 return _do_render_page_segments(ctx.page, page_data) 210 return _do_render_page_segments(ctx.page, page_data)
192 finally: 211 finally:
193 ctx.setCurrentPass(PASS_NONE) 212 ctx.setCurrentPass(PASS_NONE)
194 eis.popPage() 213 eis.popPage()