config.rst

pyramid.config

pyramid.config

Configurator

Controlling Configuration State

commit

begin

end

include

make_wsgi_app()

scan

Adding Routes and Views

add_route

add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED)

add_view

add_notfound_view

add_forbidden_view

Adding an Event Subscriber

add_subscriber

Using Security

set_authentication_policy

set_authorization_policy

set_default_permission

Setting Request Properties

set_request_property

Using I18N

add_translation_dirs

set_locale_negotiator

Overriding Assets

override_asset(to_override, override_with)

Setting Renderer Globals

set_renderer_globals_factory(factory)

Getting and Adding Settings

add_settings

get_settings

Hooking Pyramid Behavior

add_renderer

add_resource_url_adapter

add_response_adapter

add_traverser

add_tween

set_request_factory

set_root_factory

set_session_factory

set_view_mapper

Extension Author APIs

action

add_directive

with_package

derive_view

Utility Methods

absolute_asset_spec

maybe_dotted

ZCA-Related APIs

hook_zca

unhook_zca

setup_registry

Testing Helper APIs

testing_add_renderer

testing_add_subscriber

testing_resources

testing_securitypolicy

Attributes

introspectable

A shortcut attribute which points to the pyramid.registry.Introspectable class (used during directives to provide introspection to actions).

Note

This attribute is new as of Pyramid 1.3.

introspector

The introspector related to this configuration. It is an instance implementing the pyramid.interfaces.IIntrospector interface.

Note

This attribute is new as of Pyramid 1.3.

registry

The application registry which holds the configuration associated with this configurator.

global_registries

The set of registries that have been created for Pyramid applications, one per each call to 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.