summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-11-30 12:55:41 -0500
committerChris McDonough <chrism@plope.com>2011-11-30 12:55:41 -0500
commit57a0d7765c54031e6ac83881b536712316f22c45 (patch)
tree2b708572847ab35aa5172d5d5255daf8f5f07485 /docs/api
parent47e1f7336d2d954182cb439a0327d93044cfa244 (diff)
downloadpyramid-57a0d7765c54031e6ac83881b536712316f22c45.tar.gz
pyramid-57a0d7765c54031e6ac83881b536712316f22c45.tar.bz2
pyramid-57a0d7765c54031e6ac83881b536712316f22c45.zip
docs; todo; coverage for Introspector
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/config.rst15
-rw-r--r--docs/api/interfaces.rst6
-rw-r--r--docs/api/registry.rst25
3 files changed, 42 insertions, 4 deletions
diff --git a/docs/api/config.rst b/docs/api/config.rst
index 9f130b7dc..dbfbb1761 100644
--- a/docs/api/config.rst
+++ b/docs/api/config.rst
@@ -94,16 +94,23 @@
.. automethod:: set_renderer_globals_factory(factory)
- .. attribute:: introspector
-
- The :term:`introspector` associated with this configuration.
-
.. attribute:: introspectable
A shortcut attribute which points to the
:class:`pyramid.registry.Introspectable` class (used during
directives to provide introspection to actions).
+ This attribute is new as of :app:`Pyramid` 1.3.
+
+ .. attribute:: introspector
+
+ The :term:`introspector` related to this configuration. It is an
+ instance implementing the :class:`pyramid.interfaces.IIntrospector`
+ interface. If the Configurator constructor was supplied with an
+ ``introspector`` argument, this attribute will be that value.
+ Otherwise, it will be an instance of a default introspector type.
+
+ This attribute is new as of :app:`Pyramid` 1.3.
.. attribute:: global_registries
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index b336e549d..64f2773d3 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -68,3 +68,9 @@ Other Interfaces
.. autointerface:: IResponse
:members:
+ .. autointerface:: IIntrospectable
+ :members:
+
+ .. autointerface:: IIntrospector
+ :members:
+
diff --git a/docs/api/registry.rst b/docs/api/registry.rst
index 4d327370a..3dbf73a67 100644
--- a/docs/api/registry.rst
+++ b/docs/api/registry.rst
@@ -14,3 +14,28 @@
accessed as ``request.registry.settings`` or
``config.registry.settings`` in a typical Pyramid application.
+ .. attribute:: introspector
+
+ When a registry is set up (or created) by a :term:`Configurator`, the
+ registry will be decorated with an instance named ``introspector``
+ implementing the :class:`pyramid.interfaces.IIntrospector` interface.
+ See also :attr:`pyramid.config.Configurator.introspector``.
+
+ When a registry is created "by hand", however, this attribute will not
+ exist until set up by a configurator.
+
+ This attribute is often accessed as ``request.registry.introspector`` in
+ a typical Pyramid application.
+
+ This attribute is new as of :app:`Pyramid` 1.3.
+
+.. class:: Introspectable
+
+ The default implementation of the interface
+ :class:`pyramid.interfaces.IIntrospectable` used by framework exenders.
+ An instance of this class is is created when
+ :attr:`pyramid.config.Configurator.introspectable` is called.
+
+ This class is new as of :app:`Pyramid` 1.3.
+
+