- •Front Matter
- •Copyright, Trademarks, and Attributions
- •Attributions
- •Print Production
- •Contacting The Publisher
- •HTML Version and Source Code
- •Typographical Conventions
- •Author Introduction
- •Audience
- •Book Content
- •The Genesis of repoze.bfg
- •The Genesis of Pyramid
- •Thanks
- •Pyramid Introduction
- •What Makes Pyramid Unique
- •URL generation
- •Debug Toolbar
- •Debugging settings
- •Class-based and function-based views
- •Extensible templating
- •Rendered views can return dictionaries
- •Event system
- •Built-in internationalization
- •HTTP caching
- •Sessions
- •Speed
- •Exception views
- •No singletons
- •View predicates and many views per route
- •Transaction management
- •Flexible authentication and authorization
- •Traversal
- •Tweens
- •View response adapters
- •Testing
- •Support
- •Documentation
- •What Is The Pylons Project?
- •Pyramid and Other Web Frameworks
- •Installing Pyramid
- •Before You Install
- •Installing Pyramid on a UNIX System
- •Installing the virtualenv Package
- •Creating the Virtual Python Environment
- •Installing Pyramid Into the Virtual Python Environment
- •Installing Pyramid on a Windows System
- •What Gets Installed
- •Application Configuration
- •Summary
- •Creating Your First Pyramid Application
- •Hello World
- •Imports
- •View Callable Declarations
- •WSGI Application Creation
- •WSGI Application Serving
- •Conclusion
- •References
- •Creating a Pyramid Project
- •Scaffolds Included with Pyramid
- •Creating the Project
- •Installing your Newly Created Project for Development
- •Running The Tests For Your Application
- •Running The Project Application
- •Reloading Code
- •Viewing the Application
- •The Debug Toolbar
- •The Project Structure
- •The MyProject Project
- •development.ini
- •production.ini
- •MANIFEST.in
- •setup.py
- •setup.cfg
- •The myproject Package
- •__init__.py
- •views.py
- •static
- •templates/mytemplate.pt
- •tests.py
- •Modifying Package Structure
- •Using the Interactive Shell
- •What Is This pserve Thing
- •Using an Alternate WSGI Server
- •Startup
- •The Startup Process
- •Deployment Settings
- •Request Processing
- •URL Dispatch
- •High-Level Operational Overview
- •Route Pattern Syntax
- •Route Declaration Ordering
- •Route Matching
- •The Matchdict
- •The Matched Route
- •Routing Examples
- •Example 1
- •Example 2
- •Example 3
- •Matching the Root URL
- •Generating Route URLs
- •Static Routes
- •Debugging Route Matching
- •Using a Route Prefix to Compose Applications
- •Custom Route Predicates
- •Route Factories
- •Using Pyramid Security With URL Dispatch
- •Route View Callable Registration and Lookup Details
- •References
- •Views
- •View Callables
- •View Callable Responses
- •Using Special Exceptions In View Callables
- •HTTP Exceptions
- •How Pyramid Uses HTTP Exceptions
- •Custom Exception Views
- •Using a View Callable to Do an HTTP Redirect
- •Handling Form Submissions in View Callables (Unicode and Character Set Issues)
- •Alternate View Callable Argument/Calling Conventions
- •Renderers
- •Writing View Callables Which Use a Renderer
- •Built-In Renderers
- •string: String Renderer
- •json: JSON Renderer
- •JSONP Renderer
- •*.pt or *.txt: Chameleon Template Renderers
- •*.mak or *.mako: Mako Template Renderer
- •Varying Attributes of Rendered Responses
- •Deprecated Mechanism to Vary Attributes of Rendered Responses
- •Adding and Changing Renderers
- •Adding a New Renderer
- •Changing an Existing Renderer
- •Overriding A Renderer At Runtime
- •Templates
- •Using Templates Directly
- •System Values Used During Rendering
- •Chameleon ZPT Templates
- •A Sample ZPT Template
- •Using ZPT Macros in Pyramid
- •Templating with Chameleon Text Templates
- •Side Effects of Rendering a Chameleon Template
- •Debugging Templates
- •Chameleon Template Internationalization
- •Templating With Mako Templates
- •A Sample Mako Template
- •Automatically Reloading Templates
- •Available Add-On Template System Bindings
- •View Configuration
- •Mapping a Resource or URL Pattern to a View Callable
- •@view_defaults Class Decorator
- •NotFound Errors
- •Debugging View Configuration
- •Static Assets
- •Serving Static Assets
- •Generating Static Asset URLs
- •Advanced: Serving Static Assets Using a View Callable
- •Root-Relative Custom Static View (URL Dispatch Only)
- •Overriding Assets
- •The override_asset API
- •Request and Response Objects
- •Request
- •Special Attributes Added to the Request by Pyramid
- •URLs
- •Methods
- •Unicode
- •Multidict
- •Dealing With A JSON-Encoded Request Body
- •Cleaning Up After a Request
- •More Details
- •Response
- •Headers
- •Instantiating the Response
- •Exception Responses
- •More Details
- •Sessions
- •Using The Default Session Factory
- •Using a Session Object
- •Using Alternate Session Factories
- •Creating Your Own Session Factory
- •Flash Messages
- •Using the session.flash Method
- •Using the session.pop_flash Method
- •Using the session.peek_flash Method
- •Preventing Cross-Site Request Forgery Attacks
- •Using the session.get_csrf_token Method
- •Using the session.new_csrf_token Method
- •Using Events
- •An Example
- •Reloading Templates
- •Reloading Assets
- •Debugging Authorization
- •Debugging Not Found Errors
- •Debugging Route Matching
- •Preventing HTTP Caching
- •Debugging All
- •Reloading All
- •Default Locale Name
- •Including Packages
- •pyramid.includes vs. pyramid.config.Configurator.include()
- •Mako Template Render Settings
- •Mako Directories
- •Mako Module Directory
- •Mako Input Encoding
- •Mako Error Handler
- •Mako Default Filters
- •Mako Import
- •Mako Preprocessor
- •Examples
- •Understanding the Distinction Between reload_templates and reload_assets
- •Adding A Custom Setting
- •Logging
- •Sending Logging Messages
- •Filtering log messages
- •Logging Exceptions
- •PasteDeploy Configuration Files
- •PasteDeploy
- •Entry Points and PasteDeploy .ini Files
- •[DEFAULTS] Section of a PasteDeploy .ini File
- •Command-Line Pyramid
- •Displaying Matching Views for a Given URL
- •The Interactive Shell
- •Extending the Shell
- •IPython or bpython
- •Displaying All Application Routes
- •Invoking a Request
- •Writing a Script
- •Changing the Request
- •Cleanup
- •Setting Up Logging
- •Making Your Script into a Console Script
- •Internationalization and Localization
- •Creating a Translation String
- •Using The TranslationString Class
- •Using the TranslationStringFactory Class
- •Working With gettext Translation Files
- •Installing Babel and Lingua
- •Extracting Messages from Code and Templates
- •Initializing a Message Catalog File
- •Updating a Catalog File
- •Compiling a Message Catalog File
- •Using a Localizer
- •Performing a Translation
- •Performing a Pluralization
- •Obtaining the Locale Name for a Request
- •Performing Date Formatting and Currency Formatting
- •Chameleon Template Support for Translation Strings
- •Mako Pyramid I18N Support
- •Localization-Related Deployment Settings
- •Activating Translation
- •Adding a Translation Directory
- •Setting the Locale
- •Locale Negotiators
- •The Default Locale Negotiator
- •Using a Custom Locale Negotiator
- •Virtual Hosting
- •Virtual Root Support
- •Further Documentation and Examples
- •Test Set Up and Tear Down
- •What?
- •Using the Configurator and pyramid.testing APIs in Unit Tests
- •Creating Integration Tests
- •Creating Functional Tests
- •Resources
- •Location-Aware Resources
- •Generating The URL Of A Resource
- •Overriding Resource URL Generation
- •Generating the Path To a Resource
- •Finding a Resource by Path
- •Obtaining the Lineage of a Resource
- •Determining if a Resource is In The Lineage of Another Resource
- •Finding the Root Resource
- •Resources Which Implement Interfaces
- •Finding a Resource With a Class or Interface in Lineage
- •Pyramid API Functions That Act Against Resources
- •Much Ado About Traversal
- •URL Dispatch
- •Historical Refresher
- •Traversal (aka Resource Location)
- •View Lookup
- •Use Cases
- •Traversal
- •Traversal Details
- •The Resource Tree
- •The Traversal Algorithm
- •A Description of The Traversal Algorithm
- •Traversal Algorithm Examples
- •References
- •Security
- •Enabling an Authorization Policy
- •Enabling an Authorization Policy Imperatively
- •Protecting Views with Permissions
- •Setting a Default Permission
- •Assigning ACLs to your Resource Objects
- •Elements of an ACL
- •Special Principal Names
- •Special Permissions
- •Special ACEs
- •ACL Inheritance and Location-Awareness
- •Changing the Forbidden View
- •Debugging View Authorization Failures
- •Debugging Imperative Authorization Failures
- •Creating Your Own Authentication Policy
- •Creating Your Own Authorization Policy
- •Combining Traversal and URL Dispatch
- •A Review of Non-Hybrid Applications
- •URL Dispatch Only
- •Traversal Only
- •Hybrid Applications
- •The Root Object for a Route Match
- •Using *traverse In a Route Pattern
- •Using *subpath in a Route Pattern
- •Corner Cases
- •Registering a Default View for a Route That Has a view Attribute
- •Using Hooks
- •Changing the Not Found View
- •Changing the Forbidden View
- •Changing the Request Factory
- •Using The Before Render Event
- •Adding Renderer Globals (Deprecated)
- •Using Response Callbacks
- •Using Finished Callbacks
- •Changing the Traverser
- •Changing How pyramid.request.Request.resource_url() Generates a URL
- •Changing How Pyramid Treats View Responses
- •Using a View Mapper
- •Creating a Tween Factory
- •Registering an Implicit Tween Factory
- •Suggesting Implicit Tween Ordering
- •Explicit Tween Ordering
- •Displaying Tween Ordering
- •Pyramid Configuration Introspection
- •Using the Introspector
- •Introspectable Objects
- •Pyramid Introspection Categories
- •Introspection in the Toolbar
- •Disabling Introspection
- •Rules for Building An Extensible Application
- •Fundamental Plugpoints
- •Extending an Existing Application
- •Extending the Application
- •Overriding Views
- •Overriding Routes
- •Overriding Assets
- •Advanced Configuration
- •Two-Phase Configuration
- •Using config.action in a Directive
- •Adding Configuration Introspection
- •Introspectable Relationships
- •Thread Locals
- •Why and How Pyramid Uses Thread Local Variables
- •Using the Zope Component Architecture in Pyramid
- •Using the ZCA Global API in a Pyramid Application
- •Disusing the Global ZCA API
- •Enabling the ZCA Global API by Using hook_zca
- •Enabling the ZCA Global API by Using The ZCA Global Registry
- •Background
- •Design
- •Overall
- •Models
- •Views
- •Security
- •Summary
- •Installation
- •Preparation
- •Make a Project
- •Run the Tests
- •Expose Test Coverage Information
- •Start the Application
- •Visit the Application in a Browser
- •Decisions the zodb Scaffold Has Made For You
- •Basic Layout
- •Resources and Models with models.py
- •Views With views.py
- •Defining the Domain Model
- •Delete the Database
- •Edit models.py
- •Look at the Result of Our Edits to models.py
- •View the Application in a Browser
- •Defining Views
- •Declaring Dependencies in Our setup.py File
- •Adding View Functions
- •Viewing the Result of all Our Edits to views.py
- •Adding Templates
- •Viewing the Application in a Browser
- •Adding Authorization
- •Add Authentication and Authorization Policies
- •Add security.py
- •Give Our Root Resource an ACL
- •Add Login and Logout Views
- •Change Existing Views
- •Add permission Declarations to our view_config Decorators
- •Add the login.pt Template
- •Change view.pt and edit.pt
- •See Our Changes To views.py and our Templates
- •View the Application in a Browser
- •Adding Tests
- •Test the Models
- •Test the Views
- •Functional tests
- •View the results of all our edits to tests.py
- •Run the Tests
- •Distributing Your Application
- •SQLAlchemy + URL Dispatch Wiki Tutorial
- •Background
- •Design
- •Overall
- •Models
- •Views
- •Security
- •Summary
- •Installation
- •Preparation
- •Making a Project
- •Running the Tests
- •Exposing Test Coverage Information
- •Initializing the Database
- •Starting the Application
- •Decisions the alchemy Scaffold Has Made For You
- •Basic Layout
- •View Declarations via views.py
- •Content Models with models.py
- •Making Edits to models.py
- •Changing scripts/initializedb.py
- •Reinitializing the Database
- •Viewing the Application in a Browser
- •Defining Views
- •Declaring Dependencies in Our setup.py File
- •Running setup.py develop
- •Changing the views.py File
- •Adding Templates
- •Adding Routes to __init__.py
- •Viewing the Application in a Browser
- •Adding Authorization
- •Adding A Root Factory
- •Add an Authorization Policy and an Authentication Policy
- •Adding an authentication policy callback
- •Adding Login and Logout Views
- •Changing Existing Views
- •Adding the login.pt Template
- •Seeing Our Changes To views.py and our Templates
- •Viewing the Application in a Browser
- •Adding Tests
- •Testing the Models
- •Testing the Views
- •Functional tests
- •Viewing the results of all our edits to tests.py
- •Running the Tests
- •Distributing Your Application
- •Converting a repoze.bfg Application to Pyramid
- •Running a Pyramid Application under mod_wsgi
- •pyramid.authorization
- •pyramid.authentication
- •Authentication Policies
- •Helper Classes
- •pyramid.chameleon_text
- •pyramid.chameleon_zpt
- •pyramid.config
- •pyramid.events
- •Functions
- •Event Types
- •pyramid.exceptions
- •pyramid.httpexceptions
- •HTTP Exceptions
- •pyramid.i18n
- •pyramid.interfaces
- •Event-Related Interfaces
- •Other Interfaces
- •pyramid.location
- •pyramid.paster
- •pyramid.registry
- •pyramid.renderers
- •pyramid.request
- •pyramid.response
- •Functions
- •pyramid.scripting
- •pyramid.security
- •Authentication API Functions
- •Authorization API Functions
- •Constants
- •Return Values
- •pyramid.settings
- •pyramid.testing
- •pyramid.threadlocal
- •pyramid.traversal
- •pyramid.url
- •pyramid.view
- •pyramid.wsgi
- •Glossary
CHAPTER
THIRTY
PYRAMID CONFIGURATION INTROSPECTION
When Pyramid starts up, each call to a configuration directive causes one or more introspectable objects to be registered with an introspector. The introspector can be queried by application code to obtain information about the configuration of the running application. This feature is useful for debug toolbars, command-line scripts which show some aspect of configuration, and for runtime reporting of startup-time configuration settings.
latex-warning.png
Introspection is new in Pyramid 1.3.
30.1 Using the Introspector
Here’s an example of using Pyramid’s introspector from within a view callable:
341
30. PYRAMID CONFIGURATION INTROSPECTION
1from pyramid.view import view_config
2from pyramid.response import Response
3
4 @view_config(route_name=’bar’)
5def route_accepts(request):
6 introspector = request.registry.introspector
7route_name = request.matched_route.name
8 route_intr = introspector.get(’routes’, route_name)
9return Response(str(route_intr[’pattern’]))
This view will return a response that contains the “pattern” argument provided to the add_route method of the route which matched when the view was called. It uses the pyramid.interfaces.IIntrospector.get() method to return an introspectable in the category routes with a discriminator equal to the matched route name. It then uses the returned introspectable to obtain a “pattern” value.
The introspectable returned by the query methods of the introspector has methods and attributes described by pyramid.interfaces.IIntrospectable. In particular, the get(), get_category(), categories(), categorized(), and related() methods of an introspector can be used to query for introspectables.
30.2 Introspectable Objects
Introspectable objects are returned from query methods of an introspector. Each introspectable object implements the attributes and methods documented at pyramid.interfaces.IIntrospectable.
The important attributes shared by all introspectables are the following:
title
A human-readable text title describing the introspectable
category_name
A text category name describing the introspection category to which this introspectable belongs. It is often a plural if there are expected to be more than one introspectable registered within the category.
discriminator
342
30.3. PYRAMID INTROSPECTION CATEGORIES
A hashable object representing the unique value of this introspectable within its category.
discriminator_hash
The integer hash of the discriminator (useful for using in HTML links).
type_name
The text name of a subtype within this introspectable’s category. If there is only one type name in this introspectable’s category, this value will often be a singular version of the category name but it can be an arbitrary value.
action_info
An object describing the directive call site which caused this introspectable to be registered; contains attributes described in pyramid.interfaces.IActionInfo.
Besides having the attributes described above, an introspectable is a dictionary-like object. An introspectable can be queried for data values via its __getitem__, get, keys, values, or items methods. For example:
1
2
route_intr = introspector.get(’routes’, ’edit_user’) pattern = route_intr[’pattern’]
30.3 Pyramid Introspection Categories
The list of concrete introspection categories provided by built-in Pyramid configuration directives follows. Add-on packages may supply other introspectables in categories not described here.
subscribers
Each introspectable in the subscribers category represents a call to pyramid.config.Configurator.add_subscriber() (or the decorator equivalent); each will have the following data.
subscriber
The subscriber callable object (the resolution of the subscriber argument passed to add_susbcriber).
interfaces
343
30. PYRAMID CONFIGURATION INTROSPECTION
A sequence of interfaces (or classes) that are subscribed to (the resolution of the ifaces argument passed to add_subscriber).
response adapters
Each introspectable in the response adapters category represents a call to pyramid.config.Configurator.add_response_adapter() (or a decorator equivalent); each will have the following data.
adapter
The adapter object (the resolved adapter argument to add_response_adapter).
type
The resolved type_or_iface argument passed to add_response_adapter.
root factories
Each |
introspectable in the root factories category represents a |
call |
|
to |
pyramid.config.Configurator.set_root_factory() |
(or |
the |
Configurator constructor equivalent) or a factory argument passed to pyramid.config.Configurator.add_route(); each will have the following data.
factory
The factory object (the resolved factory argument to set_root_factory).
route_name
The name of the route which will use this factory. If this is the default root factory (if it’s registered during a call to set_root_factory), this value will be
None.
session factory
Only one introspectable will exist in the session factory category. It represents a call to pyramid.config.Configurator.set_session_factory() (or the Configurator constructor equivalent); it will have the following data.
factory
344
30.3. PYRAMID INTROSPECTION CATEGORIES
The factory object (the resolved factory argument to set_session_factory).
request factory
Only one introspectable will exist in the request factory category. It represents a call to pyramid.config.Configurator.set_request_factory() (or the Configurator constructor equivalent); it will have the following data.
factory
The factory object (the resolved factory argument to set_request_factory).
locale negotiator
Only one introspectable will exist in the locale negotiator category. It represents a call to pyramid.config.Configurator.set_locale_negotiator() (or the Configurator constructor equivalent); it will have the following data.
negotiator
The factory object (the resolved negotiator argument to set_locale_negotiator).
renderer factories
Each introspectable in the renderer factories category represents a call to pyramid.config.Configurator.add_renderer() (or the Configurator constructor equivalent); each will have the following data.
name
The name of the renderer (the value of the name argument to add_renderer).
factory
The factory object (the resolved factory argument to add_renderer).
renderer globals factory
345
30. PYRAMID CONFIGURATION INTROSPECTION
There will be one |
and only |
one introspectable in |
the |
renderer |
||
globals factory |
category. |
It |
represents |
a |
call |
to |
pyramid.config.Configurator.set_renderer_globals_factory(); it will have the following data.
factory
The factory object (the resolved factory argument to set_renderer_globals_factory).
routes
Each introspectable in the routes category represents a call to pyramid.config.Configurator.add_route(); each will have the following data.
name
The name argument passed to add_route.
pattern
The pattern argument passed to add_route.
factory
The (resolved) factory argument passed to add_route.
xhr
The xhr argument passed to add_route.
request_method
The request_method argument passed to add_route.
request_methods
A sequence of request method names implied by the request_method argument passed to add_route or the value None if a request_method argument was not supplied.
path_info
346
30.3. PYRAMID INTROSPECTION CATEGORIES
The path_info argument passed to add_route.
request_param
The request_param argument passed to add_route.
header
The header argument passed to add_route.
accept
The accept argument passed to add_route.
traverse
The traverse argument passed to add_route.
custom_predicates
The custom_predicates argument passed to add_route.
pregenerator
The pregenerator argument passed to add_route.
static
The static argument passed to add_route.
use_global_views
The use_global_views argument passed to add_route.
object
The pyramid.interfaces.IRoute object that is used to perform matching and generation for this route.
authentication policy
347
30. PYRAMID CONFIGURATION INTROSPECTION
There |
will |
be |
one |
and |
only |
one |
introspectable |
in |
the |
||
authentication policy |
category. |
|
It |
represents |
a |
call |
to |
the |
|||
pyramid.config.Configurator.set_authentication_policy() method |
|||||||||||
(or its Configurator constructor equivalent); it will have the following data. |
|
|
|
||||||||
policy |
|
|
|
|
|
|
|
|
|
|
|
The |
policy |
object |
(the |
resolved |
policy |
argument |
to |
|
|||
set_authentication_policy). |
|
|
|
|
|
|
|||||
authorization policy |
|
|
|
|
|
|
|
|
|
||
There |
will |
be |
one |
and |
only |
one |
introspectable |
in |
the |
||
authorization policy |
category. |
|
It represents |
a |
call |
to |
the |
||||
pyramid.config.Configurator.set_authorization_policy() method |
|||||||||||
(or its Configurator constructor equivalent); it will have the following data. |
|
|
|
||||||||
policy |
|
|
|
|
|
|
|
|
|
|
|
The |
policy |
object |
(the |
resolved |
policy |
argument |
to |
|
|||
set_authorization_policy). |
|
|
|
|
|
|
|
||||
default permission |
|
|
|
|
|
|
|
|
|
||
There |
will |
be |
one |
and |
only |
one |
introspectable |
in |
the |
||
default permission category. |
It |
represents |
a |
call |
to |
the |
|||||
pyramid.config.Configurator.set_default_permission() |
method |
||||||||||
(or its Configurator constructor equivalent); it will have the following data. |
|
|
|
value
The permission name passed to set_default_permission.
views
Each introspectable in the views category represents a call to pyramid.config.Configurator.add_view(); each will have the following data.
name
The name argument passed to add_view.
context
348
30.3. PYRAMID INTROSPECTION CATEGORIES
The (resolved) context argument passed to add_view.
containment
The (resolved) containment argument passed to add_view.
request_param
The request_param argument passed to add_view.
request_methods
A sequence of request method names implied by the request_method argument passed to add_view or the value None if a request_method argument was not supplied.
route_name
The route_name argument passed to add_view.
attr
The attr argument passed to add_view.
xhr
The xhr argument passed to add_view.
accept
The accept argument passed to add_view.
header
The header argument passed to add_view.
path_info
The path_info argument passed to add_view.
match_param
The match_param argument passed to add_view.
349
30. PYRAMID CONFIGURATION INTROSPECTION
callable
The (resolved) view argument passed to add_view. Represents the “raw” view callable.
derived_callable
The view callable derived from the view argument passed to add_view. Represents the view callable which Pyramid itself calls (wrapped in security and other wrappers).
mapper
The (resolved) mapper argument passed to add_view.
decorator
The (resolved) decorator argument passed to add_view.
permissions
Each |
introspectable |
in |
the |
permissions |
category |
represents |
|
a |
call |
to |
|
pyramid.config.Configurator.add_view() |
that has an explicit permission argument to or a call to pyramid.config.Configurator.set_default_permission(); each will have the following data.
value
The permission name passed to add_view or set_default_permission.
templates
Each introspectable in the templates category represents a call to pyramid.config.Configurator.add_view() that has a renderer argument which points to a template; each will have the following data.
name
The renderer’s name (a string).
type
The renderer’s type (a string).
350
30.3. PYRAMID INTROSPECTION CATEGORIES
renderer
The pyramid.interfaces.IRendererInfo object which represents this template’s renderer.
view mapper
Each introspectable in the permissions category represents a call to pyramid.config.Configurator.add_view() that has an explicit mapper argument to or a call to pyramid.config.Configurator.set_view_mapper(); each will have the following data.
mapper
The (resolved) mapper argument passed to add_view or set_view_mapper.
asset overrides
Each introspectable in the asset overrides category represents a call to pyramid.config.Configurator.override_asset(); each will have the following data.
to_override
The to_override argument (an asset spec) passed to override_asset.
override_with
The override_with argument (an asset spec) passed to override_asset.
translation directories |
|
|
|
|
|
|
|
|
Each |
introspectable |
in |
the |
asset overrides |
category |
|
repre- |
|
sents |
an individual element in a specs argument passed |
to to |
||||||
pyramid.config.Configurator.add_translation_dirs(); |
each |
will |
||||||
have the following data. |
|
|
|
|
|
|
|
directory
The absolute path of the translation directory.
spec
351
30. PYRAMID CONFIGURATION INTROSPECTION
The asset specification passed to add_translation_dirs.
tweens
Each introspectable in the tweens category represents a call to pyramid.config.Configurator.add_tween(); each will have the following data.
name
The dotted name to the tween factory as a string (passed as the tween_factory argument to add_tween).
factory
The (resolved) tween factory object.
type
implict or explicit as a string.
under
The under argument passed to add_tween (a string).
over
The over argument passed to add_tween (a string).
static views
Each introspectable in the static views category represents a call to pyramid.config.Configurator.add_static_view(); each will have the following data.
name
The name argument provided to add_static_view.
spec
A normalized version of the spec argument provided to add_static_view.
traversers
352
30.3. PYRAMID INTROSPECTION CATEGORIES
Each introspectable in the traversers category represents a call to pyramid.config.Configurator.add_traverser(); each will have the following data.
iface
The (resolved) interface or class object that represents the return value of a root factory that this traverser will be used for.
adapter
The (resolved) traverser class.
resource url adapters
Each introspectable in the resource url adapters category represents a call to 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.
353