piecrust2: piecrust/routing.py annotate

annotate piecrust/routing.py @ 1001:112ff1ab110c

cm: Only commit admin assets if they have changed.

author	Ludovic Chabant <ludovic@chabant.com>
date	Tue, 21 Nov 2017 10:59:47 -0800
parents	58ebf50235a5
children	4850f8c21b6e

rev	line source
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1 import re
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	2 import os.path
369 4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages. Ludovic Chabant <ludovic@chabant.com> parents: 344 diff changeset	3 import copy
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4 import logging
520 bab91fcef741 bake/serve: Improve support for unicode, add slugification options. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	5 import urllib.parse
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	6 from werkzeug.utils import cached_property
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	7
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	8
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 logger = logging.getLogger(__name__)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	12 route_re = re.compile(r'%((?P<qual>[\w\d]+):)?(?P<var>\+)?(?P<name>\w+)%')
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	13 route_esc_re = re.compile(r'\\%((?P<qual>[\w\d]+)\\:)?(?P<var>\\\+)?(?P<name>\w+)\\%')
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	14 ugly_url_cleaner = re.compile(r'\.html$')
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16
555 daf8df5ade7d serve: Refactor the server to make pieces usable by the debugging middleware. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	17 class RouteNotFoundError(Exception):
daf8df5ade7d serve: Refactor the server to make pieces usable by the debugging middleware. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	18 pass
daf8df5ade7d serve: Refactor the server to make pieces usable by the debugging middleware. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	19
daf8df5ade7d serve: Refactor the server to make pieces usable by the debugging middleware. Ludovic Chabant <ludovic@chabant.com> parents: 520 diff changeset	20
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	21 class InvalidRouteError(Exception):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	22 pass
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	23
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	24
430 21e26ed867b6 internal: Create full route metadata in one place. Ludovic Chabant <ludovic@chabant.com> parents: 396 diff changeset	25 def create_route_metadata(page):
21e26ed867b6 internal: Create full route metadata in one place. Ludovic Chabant <ludovic@chabant.com> parents: 396 diff changeset	26 route_metadata = copy.deepcopy(page.source_metadata)
21e26ed867b6 internal: Create full route metadata in one place. Ludovic Chabant <ludovic@chabant.com> parents: 396 diff changeset	27 return route_metadata
21e26ed867b6 internal: Create full route metadata in one place. Ludovic Chabant <ludovic@chabant.com> parents: 396 diff changeset	28
21e26ed867b6 internal: Create full route metadata in one place. Ludovic Chabant <ludovic@chabant.com> parents: 396 diff changeset	29
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	30 ROUTE_TYPE_SOURCE = 0
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	31 ROUTE_TYPE_GENERATOR = 1
520 bab91fcef741 bake/serve: Improve support for unicode, add slugification options. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	32
bab91fcef741 bake/serve: Improve support for unicode, add slugification options. Ludovic Chabant <ludovic@chabant.com> parents: 515 diff changeset	33
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	34 class RouteParameter(object):
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	35 TYPE_STRING = 0
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	36 TYPE_PATH = 1
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	37 TYPE_INT2 = 2
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	38 TYPE_INT4 = 3
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	39
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	40 def __init__(self, param_name, param_type=TYPE_STRING, *, variadic=False):
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	41 self.param_name = param_name
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	42 self.param_type = param_type
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	43 self.variadic = variadic
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	44
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	45
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	46 class Route(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	47 """ Information about a route for a PieCrust application.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48 Each route defines the "shape" of an URL and how it maps to
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	49 sources and generators.
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	50 """
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51 def __init__(self, app, cfg):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 self.app = app
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	53
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	54 self.source_name = cfg.get('source')
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	55 self.generator_name = cfg.get('generator')
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	56 if not self.source_name and not self.generator_name:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	57 raise InvalidRouteError(
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	58 "Both `source` and `generator` are specified.")
334 b034f6f15e22 bake: Several bug taxonomy-related fixes for incorrect incremental bakes. Ludovic Chabant <ludovic@chabant.com> parents: 329 diff changeset	59
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	60 self.uri_pattern = cfg['url'].lstrip('/')
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	61
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	62 if self.is_source_route:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	63 self.supported_params = self.source.getSupportedRouteParameters()
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	64 else:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	65 self.supported_params = self.generator.getSupportedRouteParameters()
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	66
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	67 self.pretty_urls = app.config.get('site/pretty_urls')
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	68 self.trailing_slash = app.config.get('site/trailing_slash')
396 dc0988d937b3 serve: Fix bug where `?!debug` doesn't get appending correctly. Ludovic Chabant <ludovic@chabant.com> parents: 380 diff changeset	69 self.show_debug_info = app.config.get('site/show_debug_info')
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	70 self.pagination_suffix_format = app.config.get(
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	71 '__cache/pagination_suffix_format')
329 422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	72 self.uri_root = app.config.get('site/root')
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	73
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	74 self.uri_params = []
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	75 self.uri_format = route_re.sub(self._uriFormatRepl, self.uri_pattern)
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	76
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	77 # Get the straight-forward regex for matching this URI pattern.
329 422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	78 p = route_esc_re.sub(self._uriPatternRepl,
422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	79 re.escape(self.uri_pattern)) + '$'
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	80 self.uri_re = re.compile(p)
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	81
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	82 # If the URI pattern has a 'path'-type component, we'll need to match
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	83 # the versions for which that component is empty. So for instance if
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	84 # we have `/foo/%path:bar%`, we may need to match `/foo` (note the
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	85 # lack of a trailing slash). We have to build a special pattern (in
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	86 # this case without that trailing slash) to match those situations.
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	87 # (maybe there's a better way to do it but I can't think of any
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	88 # right now)
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	89 uri_pattern_no_path = (
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	90 route_re.sub(self._uriNoPathRepl, self.uri_pattern)
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	91 .replace('//', '/')
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	92 .rstrip('/'))
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	93 if uri_pattern_no_path != self.uri_pattern:
329 422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	94 p = route_esc_re.sub(self._uriPatternRepl,
422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	95 re.escape(uri_pattern_no_path)) + '$'
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	96 self.uri_re_no_path = re.compile(p)
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	97 else:
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	98 self.uri_re_no_path = None
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	99
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	100 self.func_name = self._validateFuncName(cfg.get('func'))
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	101 self.func_has_variadic_parameter = False
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	102 for p in self.uri_params[:-1]:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	103 param = self.getParameter(p)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	104 if param.variadic:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	105 raise Exception(
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	106 "Only the last route URL parameter can be variadic. "
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	107 "Got: %s" % self.uri_pattern)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	108 if len(self.uri_params) > 0:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	109 last_param = self.getParameter(self.uri_params[-1])
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	110 self.func_has_variadic_parameter = last_param.variadic
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	111
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	112 @property
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	113 def route_type(self):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	114 if self.source_name:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	115 return ROUTE_TYPE_SOURCE
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	116 elif self.generator_name:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	117 return ROUTE_TYPE_GENERATOR
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	118 else:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	119 raise InvalidRouteError()
483 64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 482 diff changeset	120
64e1cd71b30b serve: Try to serve taxonomy pages after all normal pages have failed. Ludovic Chabant <ludovic@chabant.com> parents: 482 diff changeset	121 @property
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	122 def is_source_route(self):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	123 return self.route_type == ROUTE_TYPE_SOURCE
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	124
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	125 @property
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	126 def is_generator_route(self):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	127 return self.route_type == ROUTE_TYPE_GENERATOR
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	128
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	129 @cached_property
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	130 def source(self):
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	131 if not self.is_source_route:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	132 return InvalidRouteError("This is not a source route.")
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	133 for src in self.app.sources:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134 if src.name == self.source_name:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135 return src
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	136 raise Exception("Can't find source '%s' for route '%s'." % (
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	137 self.source_name, self.uri_pattern))
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	138
711 ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	139 @cached_property
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	140 def generator(self):
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	141 if not self.is_generator_route:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	142 return InvalidRouteError("This is not a generator route.")
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	143 for gen in self.app.generators:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	144 if gen.name == self.generator_name:
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	145 return gen
ab5c6a8ae90a bake: Replace hard-coded taxonomy support with "generator" system. Ludovic Chabant <ludovic@chabant.com> parents: 661 diff changeset	146 raise Exception("Can't find generator '%s' for route '%s'." % (
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	147 self.generator_name, self.uri_pattern))
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	148
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	149 def hasParameter(self, name):
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	150 return any(lambda p: p.param_name == name, self.supported_params)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	151
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	152 def getParameter(self, name):
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	153 for p in self.supported_params:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	154 if p.param_name == name:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	155 return p
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	156 raise Exception("No such supported route parameter '%s' in: %s" %
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	157 (name, self.uri_pattern))
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	158
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	159 def getParameterType(self, name):
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	160 return self.getParameter(name).param_type
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	161
369 4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages. Ludovic Chabant <ludovic@chabant.com> parents: 344 diff changeset	162 def matchesMetadata(self, route_metadata):
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	163 return set(self.uri_params).issubset(route_metadata.keys())
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	164
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	165 def matchUri(self, uri, strict=False):
329 422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	166 if not uri.startswith(self.uri_root):
422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	167 raise Exception("The given URI is not absolute: %s" % uri)
422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	168 uri = uri[len(self.uri_root):]
422052d2e978 internal: Try handling URLs in a consistent way. Ludovic Chabant <ludovic@chabant.com> parents: 262 diff changeset	169
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	170 if not self.pretty_urls:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	171 uri = ugly_url_cleaner.sub('', uri)
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	172 elif self.trailing_slash:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	173 uri = uri.rstrip('/')
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	174
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	175 route_metadata = None
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	176 m = self.uri_re.match(uri)
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	177 if m:
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	178 route_metadata = m.groupdict()
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	179 if self.uri_re_no_path:
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	180 m = self.uri_re_no_path.match(uri)
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	181 if m:
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	182 route_metadata = m.groupdict()
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	183 if route_metadata is None:
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	184 return None
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	185
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	186 if not strict:
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	187 # When matching URIs, if the URI is a match but is missing some
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	188 # metadata, fill those up with empty strings. This can happen if,
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	189 # say, a route's pattern is `/foo/%slug%`, and we're matching an
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	190 # URL like `/foo`.
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	191 matched_keys = set(route_metadata.keys())
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	192 missing_keys = set(self.uri_params) - matched_keys
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	193 for k in missing_keys:
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	194 if self.getParameterType(k) != RouteParameter.TYPE_PATH:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	195 return None
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	196 route_metadata[k] = ''
f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	197
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	198 for k in route_metadata:
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	199 route_metadata[k] = self._coerceRouteParameter(
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	200 k, route_metadata[k])
448 a17774094db8 serve: Fix bug with creating routing metadata from the URL. Ludovic Chabant <ludovic@chabant.com> parents: 438 diff changeset	201
380 f33712c4cfab routing: Fix bugs with matching URLs with correct route but missing metadata. Ludovic Chabant <ludovic@chabant.com> parents: 369 diff changeset	202 return route_metadata
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	203
430 21e26ed867b6 internal: Create full route metadata in one place. Ludovic Chabant <ludovic@chabant.com> parents: 396 diff changeset	204 def getUri(self, route_metadata, *, sub_num=1):
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	205 route_metadata = dict(route_metadata)
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	206 for k in route_metadata:
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	207 route_metadata[k] = self._coerceRouteParameter(
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	208 k, route_metadata[k])
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	209
369 4b1019bb2533 serve: Giant refactor to change how we handle data when serving pages. Ludovic Chabant <ludovic@chabant.com> parents: 344 diff changeset	210 uri = self.uri_format % route_metadata
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	211 suffix = None
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	212 if sub_num > 1:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	213 # Note that we know the pagination suffix starts with a slash.
262 61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	214 suffix = self.pagination_suffix_format % {'num': sub_num}
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	215
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	216 if self.pretty_urls:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	217 # Output will be:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	218 # - `subdir/name`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	219 # - `subdir/name/2`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	220 # - `subdir/name.ext`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	221 # - `subdir/name.ext/2`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	222 if suffix:
262 61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	223 if uri == '':
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	224 uri = suffix.lstrip('/')
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	225 else:
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	226 uri = uri.rstrip('/') + suffix
337 49408002798e internal: Fix stupid routing bug. Ludovic Chabant <ludovic@chabant.com> parents: 334 diff changeset	227 if self.trailing_slash and uri != '':
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	228 uri = uri.rstrip('/') + '/'
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	229 else:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	230 # Output will be:
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	231 # - `subdir/name.html`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	232 # - `subdir/name/2.html`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	233 # - `subdir/name.ext`
da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	234 # - `subdir/name/2.ext`
262 61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	235 if uri == '':
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	236 if suffix:
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	237 uri = suffix.lstrip('/') + '.html'
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	238 else:
262 61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	239 base_uri, ext = os.path.splitext(uri)
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	240 if not ext:
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	241 ext = '.html'
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	242 if suffix:
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	243 uri = base_uri + suffix + ext
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	244 else:
61145dcd56e0 routing: Better generate URLs according to the site configuration. Ludovic Chabant <ludovic@chabant.com> parents: 256 diff changeset	245 uri = base_uri + ext
256 da5e6e00fb41 bake/serve: Make previewed and baked URLs consistent. Ludovic Chabant <ludovic@chabant.com> parents: 235 diff changeset	246
568 6b6c5442c790 bug: Correctly handle root URLs with special characters. Ludovic Chabant <ludovic@chabant.com> parents: 561 diff changeset	247 uri = self.uri_root + urllib.parse.quote(uri)
396 dc0988d937b3 serve: Fix bug where `?!debug` doesn't get appending correctly. Ludovic Chabant <ludovic@chabant.com> parents: 380 diff changeset	248
dc0988d937b3 serve: Fix bug where `?!debug` doesn't get appending correctly. Ludovic Chabant <ludovic@chabant.com> parents: 380 diff changeset	249 if self.show_debug_info:
dc0988d937b3 serve: Fix bug where `?!debug` doesn't get appending correctly. Ludovic Chabant <ludovic@chabant.com> parents: 380 diff changeset	250 uri += '?!debug'
dc0988d937b3 serve: Fix bug where `?!debug` doesn't get appending correctly. Ludovic Chabant <ludovic@chabant.com> parents: 380 diff changeset	251
235 55087da9a72e bake: Don't include the site root when building output paths. Ludovic Chabant <ludovic@chabant.com> parents: 225 diff changeset	252 return uri
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	253
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	254 def execTemplateFunc(self, *args):
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	255 fixed_param_count = len(self.uri_params)
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	256 if self.func_has_variadic_parameter:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	257 fixed_param_count -= 1
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	258
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	259 if len(args) < fixed_param_count:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	260 raise Exception(
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	261 "Route function '%s' expected %d arguments, "
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	262 "got %d: %s" %
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	263 (self.func_name, fixed_param_count, len(args), args))
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	264
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	265 if self.func_has_variadic_parameter:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	266 coerced_args = list(args[:fixed_param_count])
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	267 if len(args) > fixed_param_count:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	268 var_arg = tuple(args[fixed_param_count:])
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	269 coerced_args.append(var_arg)
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	270 else:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	271 coerced_args = args
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	272
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	273 metadata = {}
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	274 for arg_name, arg_val in zip(self.uri_params, coerced_args):
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	275 metadata[arg_name] = self._coerceRouteParameter(
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	276 arg_name, arg_val)
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	277
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	278 if self.is_generator_route:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	279 self.generator.onRouteFunctionUsed(self, metadata)
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	280
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	281 return self.getUri(metadata)
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	282
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	283 def _uriFormatRepl(self, m):
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	284 if m.group('qual') or m.group('var'):
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	285 # Print a warning only if we're not in a worker process.
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	286 print_warning = not self.app.config.has('baker/worker_id')
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	287 if print_warning:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	288 logger.warning("Route '%s' specified parameter types -- "
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	289 "they're not needed anymore." %
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	290 self.uri_pattern)
790 4cbe057a8b6a routing: Add some backwards compatibility support for parameter types. Ludovic Chabant <ludovic@chabant.com> parents: 787 diff changeset	291
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	292 name = m.group('name')
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	293 self.uri_params.append(name)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	294 try:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	295 param_type = self.getParameterType(name)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	296 if param_type == RouteParameter.TYPE_INT4:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	297 return '%%(%s)04d' % name
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	298 elif param_type == RouteParameter.TYPE_INT2:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	299 return '%%(%s)02d' % name
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	300 return '%%(%s)s' % name
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	301 except:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	302 known = [p.name for p in self.supported_params]
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	303 raise Exception("Unknown route parameter '%s' for route '%s'. "
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	304 "Must be one of: %s'" %
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	305 (name, self.uri_pattern, known))
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	306
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	307 def _uriPatternRepl(self, m):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	308 name = m.group('name')
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	309 param_type = self.getParameterType(name)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	310 if param_type == RouteParameter.TYPE_PATH:
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	311 return r'(?P<%s>[^\?]*)' % name
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	312 elif param_type == RouteParameter.TYPE_INT4:
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	313 return r'(?P<%s>\d{4})' % name
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	314 elif param_type == RouteParameter.TYPE_INT2:
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	315 return r'(?P<%s>\d{2})' % name
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	316 return r'(?P<%s>[^/\?]+)' % name
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	317
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	318 def _uriNoPathRepl(self, m):
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	319 name = m.group('name')
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	320 param_type = self.getParameterType(name)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	321 if param_type == RouteParameter.TYPE_PATH:
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	322 return ''
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	323 return r'(?P<%s>[^/\?]+)' % name
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	324
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	325 def _coerceRouteParameter(self, name, val):
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	326 try:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	327 param_type = self.getParameterType(name)
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	328 except:
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	329 # Unknown parameter... just leave it.
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	330 return val
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	331
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	332 if param_type in [RouteParameter.TYPE_INT2, RouteParameter.TYPE_INT4]:
723 606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	333 try:
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	334 return int(val)
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	335 except ValueError:
606f6d57b5df routing: Cleanup URL routing and improve page matching. Ludovic Chabant <ludovic@chabant.com> parents: 711 diff changeset	336 raise Exception(
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	337 "Expected route parameter '%s' to be an integer, "
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	338 "but was: %s" % (name, param_type, val))
58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	339 return val
790 4cbe057a8b6a routing: Add some backwards compatibility support for parameter types. Ludovic Chabant <ludovic@chabant.com> parents: 787 diff changeset	340
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	341 def _validateFuncName(self, name):
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	342 if not name:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	343 return None
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	344 i = name.find('(')
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	345 if i >= 0:
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	346 name = name[:i]
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	347 logger.warning(
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	348 "Route function names shouldn't contain the list of arguments "
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	349 "anymore -- just specify '%s'." % name)
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	350 return name
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	352
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 class CompositeRouteFunction(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354 def __init__(self):
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	355 self._routes = []
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	356 self._arg_names = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	357
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	358 def addFunc(self, route):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	359 if self._arg_names is None:
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	360 self._arg_names = list(route.uri_params)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	361
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	362 if route.uri_params != self._arg_names:
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	363 raise Exception("Cannot merge route function with arguments '%s' "
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	364 "with route function with arguments '%s'." %
792 58ebf50235a5 routing: Simplify how routes are defined. Ludovic Chabant <ludovic@chabant.com> parents: 791 diff changeset	365 (route.uri_params, self._arg_names))
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	366 self._routes.append(route)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	367
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	368 def __call__(self, args, *kwargs):
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	369 if len(self._routes) == 1 or len(args) == len(self._arg_names):
f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	370 return self._routes[0].execTemplateFunc(args, *kwargs)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	371
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	372 if len(args) == len(self._arg_names) + 1:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	373 f_args = args[:-1]
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	374 for r in self._routes:
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	375 if r.source_name == args[-1]:
787 f6f9a284a5f3 routing: Simplify how route functions are declared and handled. Ludovic Chabant <ludovic@chabant.com> parents: 734 diff changeset	376 return r.execTemplateFunc(f_args, *kwargs)
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	377 raise Exception("No such source: %s" % args[-1])
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	378
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	379 raise Exception("Incorrect number of arguments for route function. "
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	380 "Expected '%s', got '%s'" % (self._arg_names, args))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	381

Mercurial > piecrust2

annotate piecrust/routing.py @ 1001:112ff1ab110c