blob: a785b64adf8fb01da956e83532aa76cab349cf9f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
.. _configuration_module:
.. role:: methodcategory
:class: methodcategory
:mod:`pyramid.config`
---------------------
.. automodule:: pyramid.config
.. autoclass:: Configurator
:methodcategory:`Controlling Configuration State`
.. automethod:: commit
.. automethod:: begin
.. automethod:: end
.. automethod:: include
.. automethod:: make_wsgi_app()
.. automethod:: scan
:methodcategory:`Adding Routes and Views`
.. automethod:: add_route
.. automethod:: add_static_view(name, path, cache_max_age=3600, permission=NO_PERMISSION_REQUIRED)
.. automethod:: add_view
.. automethod:: add_notfound_view
.. automethod:: add_forbidden_view
.. automethod:: add_exception_view
:methodcategory:`Adding an Event Subscriber`
.. automethod:: add_subscriber
:methodcategory:`Using Security`
.. automethod:: set_authentication_policy
.. automethod:: set_authorization_policy
.. automethod:: set_default_csrf_options
.. automethod:: set_csrf_storage_policy
.. automethod:: set_default_permission
.. automethod:: add_permission
:methodcategory:`Extending the Request Object`
.. automethod:: add_request_method
.. automethod:: set_request_property
:methodcategory:`Using I18N`
.. automethod:: add_translation_dirs
.. automethod:: set_locale_negotiator
:methodcategory:`Overriding Assets`
.. automethod:: override_asset(to_override, override_with)
:methodcategory:`Getting and Adding Settings`
.. automethod:: add_settings
.. automethod:: get_settings
:methodcategory:`Hooking Pyramid Behavior`
.. automethod:: add_renderer
.. automethod:: add_resource_url_adapter
.. automethod:: add_response_adapter
.. automethod:: add_traverser
.. automethod:: add_tween
.. automethod:: add_route_predicate
.. automethod:: add_subscriber_predicate
.. automethod:: add_view_predicate
.. automethod:: add_view_deriver
.. automethod:: set_execution_policy
.. automethod:: set_request_factory
.. automethod:: set_root_factory
.. automethod:: set_session_factory
.. automethod:: set_view_mapper
:methodcategory:`Extension Author APIs`
.. automethod:: action
.. automethod:: add_directive
.. automethod:: with_package
.. automethod:: derive_view
:methodcategory:`Utility Methods`
.. automethod:: absolute_asset_spec
.. automethod:: maybe_dotted
:methodcategory:`ZCA-Related APIs`
.. automethod:: hook_zca
.. automethod:: unhook_zca
.. automethod:: setup_registry
:methodcategory:`Testing Helper APIs`
.. automethod:: testing_add_renderer
.. automethod:: testing_add_subscriber
.. automethod:: testing_resources
.. automethod:: testing_securitypolicy
:methodcategory:`Attributes`
.. attribute:: introspectable
A shortcut attribute which points to the
:class:`pyramid.registry.Introspectable` class (used during
directives to provide introspection to actions).
.. versionadded:: 1.3
.. attribute:: introspector
The :term:`introspector` related to this configuration. It is an
instance implementing the :class:`pyramid.interfaces.IIntrospector`
interface.
.. versionadded:: 1.3
.. attribute:: registry
The :term:`application registry` which holds the configuration
associated with this configurator.
.. attribute:: global_registries
The set of registries that have been created for :app:`Pyramid`
applications, one for 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.
.. autoclass:: not_
.. attribute:: PHASE0_CONFIG
.. attribute:: PHASE1_CONFIG
.. attribute:: PHASE2_CONFIG
.. attribute:: PHASE3_CONFIG
|
