blob: 40b22e5bc5f8f45006dd64289b36742bb17e0c2c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
.. _urldispatch_module:
:mod:`repoze.bfg.urldispatch`
=============================
.. automodule:: repoze.bfg.urldispatch
.. autoclass:: RoutesMapper
:members:
An example of configuring a ``bfg:view`` stanza in ``configure.zcml``
that maps a context found via :term:`Routes` URL dispatch to a view
function is as follows:
.. code-block:: xml
:linenos:
<bfg:view
for="repoze.bfg.interfaces.IRoutesContext"
view=".views.articles_view"
name="articles"
/>
All context objects found via Routes URL dispatch will provide the
``IRoutesContext`` interface (attached dynamically). You might then
configure the ``RoutesMapper`` like so:
.. code-block:: python
:linenos:
def fallback_get_root(environ):
return {} # the graph traversal root is empty in this example
class Article(object):
def __init__(self, **kw):
self.__dict__update(kw)
get_root = RoutesMapper(fallback_get_root)
get_root.connect('archives/:article', controller='articles',
context_factory=Article)
import myapp
from repoze.bfg.router import make_app
app = make_app(get_root, myapp)
The effect of this configuration: when this :mod:`repoze.bfg`
application runs, if any URL matches the pattern
``archives/:article``, the ``.views.articles_view`` view will be
called with its :term:`context` as a instance of the ``Article``
class. The ``Article`` instance will have attributes matching the
keys and values in the Routes routing dictionary associated with the
request.
In this case in particular, when a user visits
``/archives/something``, the context will be an instance of the
Article class and it will have an ``article`` attribute with the value
of ``something``.
|
