summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-11-23 11:24:19 +0000
committerChris McDonough <chrism@agendaless.com>2009-11-23 11:24:19 +0000
commit5453b7bc96005c7607338c24e9ccf858f7cfe153 (patch)
tree36892eef44208cbf494f3d2857f2d7f219f48bd6 /docs
parent9ef3b3ec29e3f02e901b41ba04eceb2af86be461 (diff)
downloadpyramid-5453b7bc96005c7607338c24e9ccf858f7cfe153.tar.gz
pyramid-5453b7bc96005c7607338c24e9ccf858f7cfe153.tar.bz2
pyramid-5453b7bc96005c7607338c24e9ccf858f7cfe153.zip
- The ``repoze.bfg.interfaces.ITemplateRendererFactory`` interface was
removed; it has become unused. - Change imperative API.
Diffstat (limited to 'docs')
-rw-r--r--docs/api/configuration.rst22
-rw-r--r--docs/narr/configuration.rst66
2 files changed, 43 insertions, 45 deletions
diff --git a/docs/api/configuration.rst b/docs/api/configuration.rst
index 12c90260f..fb7c508fc 100644
--- a/docs/api/configuration.rst
+++ b/docs/api/configuration.rst
@@ -7,26 +7,24 @@
.. autoclass:: Configurator(registry=None, package=None, settings=None, root_factory=None, zcml_file=None, authentication_policy=None, authorization_policy=None, renderers=DEFAULT_RENDERERS)
- .. automethod:: route
+ .. automethod:: add_route
- .. automethod:: view
+ .. automethod:: add_view
- .. automethod:: security_policies
+ .. automethod:: add_renderer(name, factory)
- .. automethod:: forbidden(view=None, attr=None, renderer=None, wrapper=None)
+ .. automethod:: add_static_view(name, path, cache_max_age=3600)
- .. automethod:: notfound(view=None, attr=None, renderer=None, wrapper=None)
+ .. automethod:: load_zcml(spec)
- .. automethod:: renderer(factory, name)
+ .. automethod:: make_wsgi_app()
- .. automethod:: resource(to_override, override_with)
+ .. automethod:: override_resource(to_override, override_with)
.. automethod:: scan(package)
- .. automethod:: static(name, path, cache_max_age=3600)
+ .. automethod:: set_forbidden_view(view=None, attr=None, renderer=None, wrapper=None)
- .. automethod:: load_zcml(spec)
-
- .. automethod:: make_wsgi_app()
+ .. automethod:: set_notfound_view(view=None, attr=None, renderer=None, wrapper=None)
-
+ .. automethod:: set_security_policies
diff --git a/docs/narr/configuration.rst b/docs/narr/configuration.rst
index 09e412c30..7f1952c0d 100644
--- a/docs/narr/configuration.rst
+++ b/docs/narr/configuration.rst
@@ -92,7 +92,7 @@ imperatively:
if __name__ == '__main__':
config = Configurator()
- config.view(hello_world)
+ config.add_view(hello_world)
app = config.make_wsgi_app()
simple_server.make_server('', 8080, app).serve_forever()
@@ -191,7 +191,7 @@ imports and function definitions is placed within the confines of an
if __name__ == '__main__':
config = Configurator()
- config.view(hello_world)
+ config.add_view(hello_world)
app = config.make_wsgi_app()
simple_server.make_server('', 8080, app).serve_forever()
@@ -232,28 +232,28 @@ this particular :mod:`repoze.bfg` application. An instance of the
.. code-block:: python
:linenos:
- config.view(hello_world)
+ config.add_view(hello_world)
-This line calls the ``view`` method of the ``Configurator``. The
-``view`` method of a configurator creates a :term:`view configuration`
-within the :term:`application registry`. A :term:`view configuration`
-represents a set of circumstances which must be true for a particular
-:term:`view callable` to be called when a WSGI request is handled by
-:mod:`repoze.bfg`.
+This line calls the ``add_view`` method of the ``Configurator``. The
+``add_view`` method of a configurator creates a :term:`view
+configuration` within the :term:`application registry`. A :term:`view
+configuration` represents a set of circumstances which must be true
+for a particular :term:`view callable` to be called when a WSGI
+request is handled by :mod:`repoze.bfg`.
-The first argument of the configurator's ``view`` method must always
-be a reference to the :term:`view callable` that is meant to be
+The first argument of the configurator's ``add_view`` method must
+always be a reference to the :term:`view callable` that is meant to be
invoked when the view configuration implied by the remainder of the
-arguments passed to ``view`` is found to "match" during a request.
-This particular invocation of the ``view`` method passes no other
+arguments passed to ``add_view`` is found to "match" during a request.
+This particular invocation of the ``add_view`` method passes no other
arguments; this implies that there are no circumstances which would
limit the applicability of this view callable. The view configuration
-implied by this call to ``view`` thus will match during *any* request.
-Since our ``hello_world`` view callable returns a Response instance
-with a body of ``Hello world!```, this means, in the configuration
-implied by the script, that any URL visited by a user agent to a
-server running this application will receive the greeting ``Hello
-world!``.
+implied by this call to ``add_view`` thus will match during *any*
+request. Since our ``hello_world`` view callable returns a Response
+instance with a body of ``Hello world!```, this means, in the
+configuration implied by the script, that any URL visited by a user
+agent to a server running this application will receive the greeting
+``Hello world!``.
WGSI Application Creation
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -279,9 +279,9 @@ method calls to the configurator used to configure it. The Router
consults the registry to obey the policy choices made by a single
application. These policy choices were informed by method calls to
the ``Configurator`` made earlier; in our case, the only policy choice
-made was a single call to the ``view`` method, telling our application
-that it should unconditionally serve up the ``hello_world`` view
-callable to any requestor.
+made was a single call to the ``add_view`` method, telling our
+application that it should unconditionally serve up the
+``hello_world`` view callable to any requestor.
WSGI Application Serving
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -384,14 +384,14 @@ within the ``if __name__ == '__main__'`` section of ``helloworld.py``:
if __name__ == '__main__':
config = Configurator()
- config.view(hello_world)
+ config.add_view(hello_world)
app = config.make_wsgi_app()
simple_server.make_server('', 8080, app).serve_forever()
In our "declarative" code, we've added a ``zcml_file`` argument to the
``Configurator`` constructor's argument list with the value
``configure.zcml``, and we've removed the line which reads
-``config.view(hello_world)``, so that it now reads as:
+``config.add_view(hello_world)``, so that it now reads as:
.. code-block:: python
:linenos:
@@ -500,21 +500,21 @@ The ``configure.zcml`` ZCML file contains this bit of XML after the
/>
This ``<view>`` declaration tag directs :mod:`repoze.bfg` to create a
-:term:`view configuration`. This ``<view>`` tag has an attribute
-(also named ``view``), which points at a :term:`dotted Python name`,
-referencing the ``hello_world`` function defined within the
-``helloworld`` package. This tag is functionally equivalent to a
+:term:`view configuration`. This ``<view>`` tag has an attribute (the
+attribute is also named ``view``), which points at a :term:`dotted
+Python name`, referencing the ``hello_world`` function defined within
+the ``helloworld`` package. This tag is functionally equivalent to a
line we saw previously in our imperatively-configured application:
.. code-block:: python
:linenos:
- config.view(hello_world)
+ config.add_view(hello_world)
-The ``<view>`` declaration tag effectively invokes the ``view`` method
-of the ``Configurator`` object on your behalf. Various attributes can
-be specified on the ``<view>`` tag which influence the :term:`view
-configuration` it creates.
+The ``<view>`` declaration tag effectively invokes the ``add_view``
+method of the ``Configurator`` object on your behalf. Various
+attributes can be specified on the ``<view>`` tag which influence the
+:term:`view configuration` it creates.
The ``<view>`` tag is an example of a :mod:`repoze.bfg` declaration
tag. Other such tags include ``<route>``, ``<scan>``, ``<notfound>``,