diff options
| author | Chris McDonough <chrism@plope.com> | 2012-02-19 17:55:38 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2012-02-19 17:55:38 -0500 |
| commit | 4c3cca9d034818d3ab280bd3a1ff890b543bfa81 (patch) | |
| tree | 42cd6958e035436b2bd5d8ee1f5e844983c86837 /docs/api | |
| parent | 5baff75c94768628e777ec74fe8f653ef69dd0db (diff) | |
| parent | 51919e05d9c251f7f80a4736be2b822eafc5d189 (diff) | |
| download | pyramid-4c3cca9d034818d3ab280bd3a1ff890b543bfa81.tar.gz pyramid-4c3cca9d034818d3ab280bd3a1ff890b543bfa81.tar.bz2 pyramid-4c3cca9d034818d3ab280bd3a1ff890b543bfa81.zip | |
Merge branch '1.3-branch'
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/config.rst | 147 |
1 files changed, 78 insertions, 69 deletions
diff --git a/docs/api/config.rst b/docs/api/config.rst index 3fc2cfc44..b76fed9cb 100644 --- a/docs/api/config.rst +++ b/docs/api/config.rst @@ -1,102 +1,102 @@ .. _configuration_module: +.. role:: methodcategory + :class: methodcategory + :mod:`pyramid.config` --------------------- .. automodule:: pyramid.config - .. autoclass:: Configurator - - .. attribute:: registry - - The :term:`application registry` which holds the configuration - associated with this configurator. +.. autoclass:: Configurator - .. automethod:: begin + :methodcategory:`Controlling Configuration State` - .. automethod:: end + .. automethod:: commit + .. automethod:: begin + .. automethod:: end + .. automethod:: include + .. automethod:: make_wsgi_app() + .. automethod:: scan - .. automethod:: hook_zca + :methodcategory:`Adding Routes and Views` - .. automethod:: unhook_zca + .. automethod:: add_route + .. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED) + .. automethod:: add_view + .. automethod:: set_forbidden_view + .. automethod:: set_notfound_view - .. automethod:: get_settings + :methodcategory:`Adding an Event Subscriber` - .. automethod:: commit + .. automethod:: add_subscriber - .. automethod:: action + :methodcategory:`Using Security` - .. automethod:: include + .. automethod:: set_authentication_policy + .. automethod:: set_authorization_policy + .. automethod:: set_default_permission - .. automethod:: add_directive + :methodcategory:`Setting Request Properties` - .. automethod:: with_package + .. automethod:: set_request_property - .. automethod:: maybe_dotted + :methodcategory:`Using I18N` - .. automethod:: absolute_asset_spec + .. automethod:: add_translation_dirs + .. automethod:: set_locale_negotiator - .. automethod:: setup_registry + :methodcategory:`Overriding Assets` - .. automethod:: add_renderer + .. automethod:: override_asset(to_override, override_with) - .. automethod:: add_response_adapter + :methodcategory:`Setting Renderer Globals` - .. automethod:: add_route + .. automethod:: set_renderer_globals_factory(factory) - .. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED) + :methodcategory:`Getting and Adding Settings` .. automethod:: add_settings + .. automethod:: get_settings - .. automethod:: add_subscriber - - .. automethod:: add_translation_dirs - - .. automethod:: add_view + :methodcategory:`Hooking Pyramid Behavior` + .. automethod:: add_renderer + .. automethod:: add_resource_url_adapter + .. automethod:: add_response_adapter + .. automethod:: add_traverser .. automethod:: add_tween - - .. automethod:: derive_view - - .. automethod:: make_wsgi_app() - - .. automethod:: override_asset(to_override, override_with) - - .. automethod:: scan - - .. automethod:: set_locale_negotiator - - .. automethod:: set_default_permission - - .. automethod:: set_session_factory - .. automethod:: set_request_factory - - .. automethod:: set_request_property - .. automethod:: set_root_factory - + .. automethod:: set_session_factory .. automethod:: set_view_mapper - .. automethod:: set_authentication_policy - - .. automethod:: set_authorization_policy + :methodcategory:`Extension Author APIs` - .. automethod:: testing_securitypolicy + .. automethod:: action + .. automethod:: add_directive + .. automethod:: with_package - .. automethod:: testing_resources + :methodcategory:`Utility Methods` - .. automethod:: testing_add_subscriber + .. automethod:: absolute_asset_spec + .. automethod:: derive_view + .. automethod:: maybe_dotted + .. automethod:: setup_registry - .. automethod:: testing_add_renderer + :methodcategory:`ZCA-Related APIs` - .. automethod:: set_forbidden_view + .. automethod:: hook_zca + .. automethod:: unhook_zca - .. automethod:: set_notfound_view + :methodcategory:`Testing Helper APIs` - .. automethod:: add_traverser + .. automethod:: testing_add_renderer + .. automethod:: testing_add_subscriber + .. automethod:: testing_resources + .. automethod:: testing_securitypolicy - .. automethod:: set_renderer_globals_factory(factory) + :methodcategory:`Attributes` .. attribute:: introspectable @@ -104,7 +104,9 @@ :class:`pyramid.registry.Introspectable` class (used during directives to provide introspection to actions). - This attribute is new as of :app:`Pyramid` 1.3. + .. note:: + + This attribute is new as of :app:`Pyramid` 1.3. .. attribute:: introspector @@ -114,17 +116,24 @@ ``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. + .. note:: + + This attribute is new as of :app:`Pyramid` 1.3. + + .. attribute:: registry + + The :term:`application registry` which holds the configuration + associated with this configurator. - .. attribute:: global_registries +.. attribute:: global_registries - The set of registries that have been created for :app:`Pyramid` - applications, one per each call to - :meth:`pyramid.config.Configurator.make_wsgi_app` in the current - process. The object itself supports iteration and has a ``last`` - property containing the last registry loaded. + The set of registries that have been created for :app:`Pyramid` + applications, one per each call to + :meth:`pyramid.config.Configurator.make_wsgi_app` in the current + process. The object itself supports iteration and has a ``last`` property + containing the last registry loaded. - The registries contained in this object are stored as weakrefs, - thus they will only exist for the lifetime of the actual - applications for which they are being used. + The registries contained in this object are stored as weakrefs, thus they + will only exist for the lifetime of the actual applications for which they + are being used. |
