Pylons
PylonsConfig
Pylons configuration object
The PylonsConfig class is accessible via the pylons.configuration module.
The Pylons configuration object is a per-application instance object that retains the information regarding the global and app conf's as well as per-application instance specific data such as the mapper, the paths for this instance, and the myghty configuration.
The config object is available in your application as the Pylons global pylons.config. An example usage:
1 2 3 | from pylons import config template_paths = config['pylons.paths']['templates'] |
There's several useful keys of the config object most people will be interested in:
- pylons.template_options
- Full dict of template options that any TG compatible plugin should be able to parse. Comes with basic config needed for Myghty, Kid, and Mako.
- pylons.paths
- A dict of absolute paths that were defined in the applications config/environment.py module.
- pylons.environ_config
- Dict of environ keys for where in the environ to pickup various objects for registering with Pylons. If these are present then PylonsApp will use them from environ rather than using default middleware from Beaker. Valid keys are: session, cache
- pylons.template_engines
- List of template engines to configure. The first one in the list will be configured as the default template engine. Each item in the list is a dict indicating how to configure the template engine with keys: engine, template_root, template_options, and alias
- pylons.default_charset
- Deprecated: Use the response_settings dict instead. Default character encoding specified to the browser via the 'charset' parameter of the HTTP response's Content-Type header.
- pylons.strict_c
- Whether or not the c object should throw an attribute error when access is attempted to an attribute that doesn't exist.
- pylons.request_options
- A dict of Content-Type related default settings for new instances of paste.wsgiwrappers.WSGIRequest. May contain the values charset and errors and decode_param_names. Overrides the Pylons default values specified by the request_defaults dict.
- pylons.response_options
- A dict of Content-Type related default settings for new instances of pylons.Response. May contain the values content_type, charset and errors. Overrides the Pylons default values specified by the response_defaults dict.
- routes.map
- Mapper object used for Routing. Yes, it is possible to add routes after your application has started running.
Attributes
a defaults
{'buffet.template_engines': [],
'buffet.template_options': {},
'debug': False,
'pylons.db_engines': {},
'pylons.environ_config': {},
'pylons.g': None,
'pylons.h': None,
'pylons.package': None,
'pylons.paths': {'controllers': None,
'root': None,
'static_files': None,
'templates': []},
'pylons.request_options': {'charset': 'utf-8',
'decode_param_names': False,
'errors': 'replace',
'language': 'en-us'},
'pylons.response_options': {'charset': 'utf-8',
'content_type': 'text/html',
'errors': 'strict',
'headers': {'Cache-Control': 'no-cache',
'Pragma': 'no-cache'}},
'pylons.strict_c': False}
Methods
f add_template_engine(self, engine, root, options=None, alias=None) ...
Add additional template engines for configuration on Pylons WSGI init.
- engine
- The name of the template engine
- root
- Template root for the engine
- options
- Dict of additional options used during engine initialization, if not provided, default to using the template_options dict.
- alias
- Name engine should respond to when actually used. This allows for multiple configurations of the same engine and lets you alias the additional ones to other names.
Example of Kid addition:
1 2 3 4 5 6 7 | # In yourproj/middleware.py # ... config.init_app(global_conf, app_conf, package='yourproj') # Load additional template engines kidopts = {'kid.assume_encoding':'utf-8', 'kid.encoding':'utf-8'} config.add_template_engine('kid', 'yourproj.kidtemplates', kidopts) |
Example of changing the default template engine:
1 2 3 4 5 6 7 8 9 10 11 12 13 | # In yourproj/middleware.py # ... config.init_app(global_conf, app_conf, package='yourproj') # Remove existing template engine old_default = config.template_engines.pop() # Load additional template engines kidopts = {'kid.assume_encoding':'utf-8', 'kid.encoding':'utf-8'} config.add_template_engine('kid', 'yourproj.kidtemplates', kidopts) # Add old default as additional engine config.template_engines.append(old_default) |
f init_app(self, global_conf, app_conf, package=None, template_engine='mako', paths=None) ...
Initialize configuration for the application
- global_config
Several options are expected to be set for a Pylons web application. They will be loaded from the global_config which has the main Paste options. If debug is not enabled as a global config option, the following option must be set:
- error_to - The email address to send the debug error to
The optional config options in this case are:
- smtp_server - The SMTP server to use, defaults to 'localhost'
- error_log - A logfile to write the error to
- error_subject_prefix - The prefix of the error email subject
- from_address - Whom the error email should be from
- app_conf
- Defaults supplied via the [app:main] section from the Paste config file. load_config only cares about whether a 'prefix' option is set, if so it will update Routes to ensure URL's take that into account.
- package
- The name of the application package, to be stored in the app_conf.
- template_engine
- Declare the default template engine to setup. Choices are kid, genshi, mako (the default), and pylonsmyghty.
f load_environment(self, tmpl_options=None, map=None, paths=None, environ_config=None, default_charset=None, strict_c=False, request_settings=None, response_settings=None) ...
Load the environment options
Deprecated functionality for pre-0.9.6 projects.
See the source for more information.