summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2012-02-19 17:55:38 -0500
committerChris McDonough <chrism@plope.com>2012-02-19 17:55:38 -0500
commit4c3cca9d034818d3ab280bd3a1ff890b543bfa81 (patch)
tree42cd6958e035436b2bd5d8ee1f5e844983c86837 /docs/narr
parent5baff75c94768628e777ec74fe8f653ef69dd0db (diff)
parent51919e05d9c251f7f80a4736be2b822eafc5d189 (diff)
downloadpyramid-4c3cca9d034818d3ab280bd3a1ff890b543bfa81.tar.gz
pyramid-4c3cca9d034818d3ab280bd3a1ff890b543bfa81.tar.bz2
pyramid-4c3cca9d034818d3ab280bd3a1ff890b543bfa81.zip
Merge branch '1.3-branch'
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/MyProject/development.ini3
-rw-r--r--docs/narr/advconfig.rst20
-rw-r--r--docs/narr/hooks.rst18
-rw-r--r--docs/narr/introspector.rst22
-rw-r--r--docs/narr/project.rst31
5 files changed, 73 insertions, 21 deletions
diff --git a/docs/narr/MyProject/development.ini b/docs/narr/MyProject/development.ini
index 2ccedb27b..3c38e3805 100644
--- a/docs/narr/MyProject/development.ini
+++ b/docs/narr/MyProject/development.ini
@@ -7,7 +7,8 @@ pyramid.debug_notfound = false
pyramid.debug_routematch = false
pyramid.debug_templates = true
pyramid.default_locale_name = en
-pyramid.includes = pyramid_debugtoolbar
+pyramid.includes =
+ pyramid_debugtoolbar
[server:main]
use = egg:waitress#main
diff --git a/docs/narr/advconfig.rst b/docs/narr/advconfig.rst
index 5f2175d2a..0060ef65c 100644
--- a/docs/narr/advconfig.rst
+++ b/docs/narr/advconfig.rst
@@ -122,9 +122,10 @@ configuration or configuration that results from the execution of a
Manually Resolving Conflicts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-There are a number of ways to manually resolve conflicts: the "right" way, by
-strategically using :meth:`pyramid.config.Configurator.commit`, or by using
-an "autocommitting" configurator.
+There are a number of ways to manually resolve conflicts: by changing
+registrations to not conflict, by strategically using
+:meth:`pyramid.config.Configurator.commit`, or by using an "autocommitting"
+configurator.
The Right Thing
+++++++++++++++
@@ -294,9 +295,18 @@ These are the methods of the configurator which provide conflict detection:
:meth:`~pyramid.config.Configurator.add_route`,
:meth:`~pyramid.config.Configurator.add_renderer`,
:meth:`~pyramid.config.Configurator.set_request_factory`,
+:meth:`~pyramid.config.Configurator.set_session_factory`,
+:meth:`~pyramid.config.Configurator.set_request_property`,
+:meth:`~pyramid.config.Configurator.set_root_factory`,
+:meth:`~pyramid.config.Configurator.set_view_mapper`,
+:meth:`~pyramid.config.Configurator.set_authentication_policy`,
+:meth:`~pyramid.config.Configurator.set_authorization_policy`,
:meth:`~pyramid.config.Configurator.set_renderer_globals_factory`,
-:meth:`~pyramid.config.Configurator.set_locale_negotiator` and
-:meth:`~pyramid.config.Configurator.set_default_permission`.
+:meth:`~pyramid.config.Configurator.set_locale_negotiator`,
+:meth:`~pyramid.config.Configurator.set_default_permission`,
+:meth:`~pyramid.config.Configurator.add_traverser`,
+:meth:`~pyramid.config.Configurator.add_resource_url_adapter`,
+and :meth:`~pyramid.config.Configurator.add_response_adapter`.
:meth:`~pyramid.config.Configurator.add_static_view` also indirectly
provides conflict detection, because it's implemented in terms of the
diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst
index 2c4310080..eaccc14a3 100644
--- a/docs/narr/hooks.rst
+++ b/docs/narr/hooks.rst
@@ -145,10 +145,10 @@ Here's some sample code that implements a minimal forbidden view:
Changing the Request Factory
----------------------------
-Whenever :app:`Pyramid` handles a :term:`WSGI` request, it creates a
-:term:`request` object based on the WSGI environment it has been passed. By
-default, an instance of the :class:`pyramid.request.Request` class is created
-to represent the request object.
+Whenever :app:`Pyramid` handles a request from a :term:`WSGI` server, it
+creates a :term:`request` object based on the WSGI environment it has been
+passed. By default, an instance of the :class:`pyramid.request.Request`
+class is created to represent the request object.
The class (aka "factory") that :app:`Pyramid` uses to create a request object
instance can be changed by passing a ``request_factory`` argument to the
@@ -236,11 +236,11 @@ Adding Renderer Globals (Deprecated)
is documented in :ref:`beforerender_event`.
Whenever :app:`Pyramid` handles a request to perform a rendering (after a
-view with a ``renderer=`` configuration attribute is invoked, or when any
-of the methods beginning with ``render`` within the :mod:`pyramid.renderers`
+view with a ``renderer=`` configuration attribute is invoked, or when any of
+the methods beginning with ``render`` within the :mod:`pyramid.renderers`
module are called), *renderer globals* can be injected into the *system*
values sent to the renderer. By default, no renderer globals are injected,
-and the "bare" system values (such as ``request``, ``context``, and
+and the "bare" system values (such as ``request``, ``context``, ``view``, and
``renderer_name``) are the only values present in the system dictionary
passed to every renderer.
@@ -447,7 +447,7 @@ that implements the following interface:
More than one traversal algorithm can be active at the same time. For
instance, if your :term:`root factory` returns more than one type of object
-conditionally, you could claim that an alternate traverser adapter is ``for``
+conditionally, you could claim that an alternate traverser adapter is "for"
only one particular class or interface. When the root factory returned an
object that implemented that class or interface, a custom traverser would be
used. Otherwise, the default traverser would be used. For example:
@@ -495,7 +495,7 @@ For example:
from myapp.traversal import ResourceURLAdapter
from myapp.resources import MyRoot
- config.add_resource_url_adapter(ResourceURLAdapter, resource_iface=MyRoot)
+ config.add_resource_url_adapter(ResourceURLAdapter, MyRoot)
In the above example, the ``myapp.traversal.ResourceURLAdapter`` class will
be used to provide services to :meth:`~pyramid.request.Request.resource_url`
diff --git a/docs/narr/introspector.rst b/docs/narr/introspector.rst
index 08cc430f6..d465c47d9 100644
--- a/docs/narr/introspector.rst
+++ b/docs/narr/introspector.rst
@@ -540,10 +540,30 @@ introspectables in categories not described here.
The (resolved) interface or class object that represents the return value
of a root factory that this traverser will be used for.
- ``factory``
+ ``adapter``
The (resolved) traverser class.
+``resource url adapters``
+
+ Each introspectable in the ``resource url adapters`` category represents a
+ call to :meth:`pyramid.config.Configurator.add_resource_url_adapter`; each
+ will have the following data.
+
+ ``adapter``
+
+ The (resolved) resource URL adapter class.
+
+ ``resource_iface``
+
+ The (resolved) interface or class object that represents the resource
+ interface that this url adapter is registered for.
+
+ ``request_iface``
+
+ The (resolved) interface or class object that represents the request
+ interface that this url adapter is registered for.
+
Introspection in the Toolbar
----------------------------
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 4566a4fb8..5a519ca30 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -348,27 +348,48 @@ when you use the ``production.ini`` file instead of the ``development.ini``
ini file to run the application.
You can also turn the debug toolbar off by editing ``development.ini`` and
-commenting out the line ``pyramid.includes = pyramid_debugtoolbar``. For
-example, instead of:
+commenting out a line. For example, instead of:
.. code-block:: ini
:linenos:
[app:main]
...
- pyramid.includes = pyramid_debugtoolbar
+ pyramid.includes =
+ pyramid_debugtoolbar
-Put a hash mark in front of the ``pyramid.includes`` line:
+Put a hash mark at the beginning of the ``pyramid_debugtoolbar`` line:
.. code-block:: ini
:linenos:
[app:main]
...
- #pyramid.includes = pyramid_debugtoolbar
+ pyramid.includes =
+ # pyramid_debugtoolbar
Then restart the application to see that the toolbar has been turned off.
+Note that if you comment out the ``pryamid_debugtoolbar`` line, the ``#``
+*must* be in the first column. If you put the hash mark anywhere except the
+first column instead, for example like this:
+
+.. code-block:: ini
+ :linenos:
+
+ [app:main]
+ ...
+ pyramid.includes =
+ #pyramid_debugtoolbar
+
+When you attempt to restart the application with a section like the abvoe
+you'll receive an error that ends something like this, and the application
+will not start:
+
+.. code-block:: text
+
+ ImportError: No module named #pyramid_debugtoolbar
+
.. index::
single: project structure