piecrust2: piecrust/routing.py annotate

annotate piecrust/routing.py @ 173:0a86a7a6b284

routes: Actually match metadata when finding routes, fix problems with paths. When we look for a route that matches a given page, we now look at the source metadata that comes with that page, and compare it to the metadata we need to build URIs. Also, when matching URIs, we handle the case where a 'path'-component in our pattern may be completely empty, and thus we may be missing some trailing slashes in the URI.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sat, 03 Jan 2015 21:10:44 -0800
parents	a42469dbdc47
children	d47d9493bb0a

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
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2 import logging
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	5 logger = logging.getLogger(__name__)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6
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 route_re = re.compile(r'%((?P<qual>path):)?(?P<name>\w+)%')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 template_func_re = re.compile(r'^(?P<name>\w+)$(?P<first_arg>\w+)(?P<other_args>.)$\s$')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10 template_func_arg_re = re.compile(r',\s*(?P<arg>\w+)')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	12
147 ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	13 class IRouteMetadataProvider(object):
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	14 def getRouteMetadata(self):
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	15 raise NotImplementedError()
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	16
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	17
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	18 class Route(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	19 """ 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	20 Each route defines the "shape" of an URL and how it maps to
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21 sources and taxonomies.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22 """
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23 def __init__(self, app, cfg):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24 self.app = app
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	25 uri = cfg['url']
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26 self.uri_root = app.config.get('site/root').rstrip('/') + '/'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27 self.uri_pattern = uri.lstrip('/')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	28 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	29
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	30 # Get the straight-forward regex for matching this URI pattern.
154 a42469dbdc47 Match routes completely, not partially. Ludovic Chabant <ludovic@chabant.com> parents: 147 diff changeset	31 p = route_re.sub(self._uriPatternRepl, self.uri_pattern) + '$'
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	32 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	33
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	34 # 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	35 # 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	36 # 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	37 # 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	38 # 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	39 # (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	40 # right now)
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	41 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	42 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	43 .replace('//', '/')
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	44 .rstrip('/'))
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	45 if uri_pattern_no_path != self.uri_pattern:
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	46 p = route_re.sub(self._uriPatternRepl, 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	47 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	48 else:
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	49 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	50
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51 self.source_name = cfg['source']
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 self.taxonomy = cfg.get('taxonomy')
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	53 self.required_source_metadata = set()
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	54 for m in route_re.finditer(uri):
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	55 self.required_source_metadata.add(m.group('name'))
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	56 self.template_func = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57 self.template_func_name = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	58 self.template_func_args = []
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	59 self._createTemplateFunc(cfg.get('func'))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	60
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	61 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	62 def source(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	63 for src in self.app.sources:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	64 if src.name == self.source_name:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	65 return src
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	66 raise Exception("Can't find source '%s' for route '%'." % (
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	67 self.source_name, self.uri))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	68
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	69 @property
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	70 def source_realm(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	71 return self.source.realm
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	72
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	73 def matchesMetadata(self, source_metadata):
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	74 return self.required_source_metadata.issubset(source_metadata.keys())
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	75
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	76 def matchUri(self, uri):
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	77 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	78 if m:
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	79 return m
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	80 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	81 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	82 if m:
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	83 return m
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	84 return None
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	85
147 ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	86 def getUri(self, source_metadata, provider=None):
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	87 if provider:
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	88 source_metadata = dict(source_metadata)
ab6e7e0e9d44 Pass date information to routing when building URLs. Ludovic Chabant <ludovic@chabant.com> parents: 3 diff changeset	89 source_metadata.update(provider.getRouteMetadata())
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90 #TODO: fix this hard-coded shit
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91 for key in ['year', 'month', 'day']:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	92 if key in source_metadata and isinstance(source_metadata[key], str):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	93 source_metadata[key] = int(source_metadata[key])
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	94 return self.uri_root + (self.uri_format % source_metadata)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	95
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	96 def _uriFormatRepl(self, m):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97 name = m.group('name')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	98 #TODO: fix this hard-coded shit
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	99 if name == 'year':
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 return '%(year)04d'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	101 if name == 'month':
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	102 return '%(month)02d'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	103 if name == 'day':
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	104 return '%(day)02d'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	105 return '%(' + name + ')s'
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	106
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	107 def _uriPatternRepl(self, m):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	108 name = m.group('name')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	109 qualifier = m.group('qual')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	110 if qualifier == 'path':
173 0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	111 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	112 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	113
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	114 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	115 name = m.group('name')
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	116 qualifier = m.group('qual')
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	117 if qualifier == 'path':
0a86a7a6b284 routes: Actually match metadata when finding routes, fix problems with paths. Ludovic Chabant <ludovic@chabant.com> parents: 154 diff changeset	118 return ''
3 f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	119 return r'(?P<%s>[^/\?]+)' % name
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	120
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 def _createTemplateFunc(self, func_def):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122 if func_def is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	123 return
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	125 m = template_func_re.match(func_def)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	126 if m is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	127 raise Exception("Template function definition for route '%s' "
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	128 "has invalid syntax: %s" %
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	129 (self.uri_pattern, func_def))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	130
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	131 self.template_func_name = m.group('name')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	132 self.template_func_args.append(m.group('first_arg'))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	133 arg_list = m.group('other_args')
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134 if arg_list:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135 self.template_func_args += template_func_arg_re.findall(arg_list)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137 if self.taxonomy:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	138 # This will be a taxonomy route function... this means we can
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	139 # have a variable number of parameters, but only one parameter
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 # definition, which is the value.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141 if len(self.template_func_args) != 1:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 raise Exception("Route '%s' is a taxonomy route and must have "
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143 "only one argument, which is the term value." %
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 self.uri_pattern)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146 def template_func(*args):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	147 if len(args) == 0:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148 raise Exception(
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149 "Route function '%s' expected at least one "
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	150 "argument." % func_def)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	151
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	152 # Term combinations can be passed as an array, or as multiple
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	153 # arguments.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	154 values = args
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	155 if len(args) == 1 and isinstance(args[0], list):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	156 values = args[0]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	157
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	158 # We need to register this use of a taxonomy term.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	159 if len(values) == 1:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	160 registered_values = values[0]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	161 else:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	162 registered_values = tuple(values)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	163 eis = self.app.env.exec_info_stack
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	164 eis.current_page_info.render_ctx.used_taxonomy_terms.add(
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	165 (self.source_name, self.taxonomy, registered_values))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	166
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	167 if len(values) == 1:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	168 str_values = values[0]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	169 else:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	170 str_values = '/'.join(values)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	171 term_name = self.template_func_args[0]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	172 metadata = {term_name: str_values}
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	173
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	174 return self.getUri(metadata)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	175
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	176 else:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	177 # Normal route function.
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	178 def template_func(*args):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	179 if len(args) != len(self.template_func_args):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	180 raise Exception(
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	181 "Route function '%s' expected %d arguments, "
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	182 "got %d." %
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	183 (func_def, len(self.template_func_args),
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	184 len(args)))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	185 metadata = {}
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	186 for arg_name, arg_val in zip(self.template_func_args, args):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	187 metadata[arg_name] = arg_val
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	188 return self.getUri(metadata)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	189
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	190 self.template_func = template_func
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	191
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	192
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	193 class CompositeRouteFunction(object):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	194 def __init__(self):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	195 self._funcs = []
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	196 self._arg_names = None
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	197
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	198 def addFunc(self, route):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	199 if self._arg_names is None:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	200 self._arg_names = sorted(route.template_func_args)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	201
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	202 if sorted(route.template_func_args) != self._arg_names:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	203 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	204 "with route function with arguments '%s'." %
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	205 (route.template_func_args, self._arg_names))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	206 self._funcs.append((route, route.template_func))
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	207
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	208 def __call__(self, args, *kwargs):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	209 if len(args) == len(self._arg_names):
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	210 f = self._funcs[0][1]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	211 return f(args, *kwargs)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	212
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	213 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	214 f_args = args[:-1]
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	215 for r, f in self._funcs:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	216 if r.source_name == args[-1]:
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	217 return f(f_args, **kwargs)
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	218 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	219
f485ba500df3 Gigantic change to basically make PieCrust 2 vaguely functional. Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	220 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	221 "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	222

Mercurial > piecrust2

annotate piecrust/routing.py @ 173:0a86a7a6b284