import os
|
import warnings
|
|
from zope.interface import implementer
|
|
from pyramid.interfaces import ISettings
|
|
from pyramid.settings import asbool
|
|
class SettingsConfiguratorMixin(object):
|
def _set_settings(self, mapping):
|
if not mapping:
|
mapping = {}
|
settings = Settings(mapping)
|
self.registry.settings = settings
|
return settings
|
|
def add_settings(self, settings=None, **kw):
|
"""Augment the :term:`deployment settings` with one or more
|
key/value pairs.
|
|
You may pass a dictionary::
|
|
config.add_settings({'external_uri':'http://example.com'})
|
|
Or a set of key/value pairs::
|
|
config.add_settings(external_uri='http://example.com')
|
|
This function is useful when you need to test code that accesses the
|
:attr:`pyramid.registry.Registry.settings` API (or the
|
:meth:`pyramid.config.Configurator.get_settings` API) and
|
which uses values from that API.
|
"""
|
if settings is None:
|
settings = {}
|
utility = self.registry.settings
|
if utility is None:
|
utility = self._set_settings(settings)
|
utility.update(settings)
|
utility.update(kw)
|
|
def get_settings(self):
|
"""
|
Return a :term:`deployment settings` object for the current
|
application. A deployment settings object is a dictionary-like
|
object that contains key/value pairs based on the dictionary passed
|
as the ``settings`` argument to the
|
:class:`pyramid.config.Configurator` constructor.
|
|
.. note:: the :attr:`pyramid.registry.Registry.settings` API
|
performs the same duty.
|
"""
|
return self.registry.settings
|
|
|
@implementer(ISettings)
|
class Settings(dict):
|
""" Deployment settings. Update application settings (usually
|
from PasteDeploy keywords) with framework-specific key/value pairs
|
(e.g. find ``PYRAMID_DEBUG_AUTHORIZATION`` in os.environ and jam into
|
keyword args)."""
|
# _environ_ is dep inj for testing
|
def __init__(self, d=None, _environ_=os.environ, **kw):
|
if d is None:
|
d = {}
|
dict.__init__(self, d, **kw)
|
eget = _environ_.get
|
config_debug_all = self.get('debug_all', '')
|
config_debug_all = self.get('pyramid.debug_all', config_debug_all)
|
eff_debug_all = asbool(eget('PYRAMID_DEBUG_ALL', config_debug_all))
|
config_reload_all = self.get('reload_all', '')
|
config_reload_all = self.get('pyramid.reload_all', config_reload_all)
|
eff_reload_all = asbool(eget('PYRAMID_RELOAD_ALL', config_reload_all))
|
config_debug_auth = self.get('debug_authorization', '')
|
config_debug_auth = self.get('pyramid.debug_authorization',
|
config_debug_auth)
|
eff_debug_auth = asbool(eget('PYRAMID_DEBUG_AUTHORIZATION',
|
config_debug_auth))
|
config_debug_notfound = self.get('debug_notfound', '')
|
config_debug_notfound = self.get('pyramid.debug_notfound',
|
config_debug_notfound)
|
eff_debug_notfound = asbool(eget('PYRAMID_DEBUG_NOTFOUND',
|
config_debug_notfound))
|
config_debug_routematch = self.get('debug_routematch', '')
|
config_debug_routematch = self.get('pyramid.debug_routematch',
|
config_debug_routematch)
|
eff_debug_routematch = asbool(eget('PYRAMID_DEBUG_ROUTEMATCH',
|
config_debug_routematch))
|
config_debug_templates = self.get('debug_templates', '')
|
config_debug_templates = self.get('pyramid.debug_templates',
|
config_debug_templates)
|
eff_debug_templates = asbool(eget('PYRAMID_DEBUG_TEMPLATES',
|
config_debug_templates))
|
config_reload_templates = self.get('reload_templates', '')
|
config_reload_templates = self.get('pyramid.reload_templates',
|
config_reload_templates)
|
eff_reload_templates = asbool(eget('PYRAMID_RELOAD_TEMPLATES',
|
config_reload_templates))
|
config_reload_assets = self.get('reload_assets', '')
|
config_reload_assets = self.get('pyramid.reload_assets',
|
config_reload_assets)
|
reload_assets = asbool(eget('PYRAMID_RELOAD_ASSETS',
|
config_reload_assets))
|
config_reload_resources = self.get('reload_resources', '')
|
config_reload_resources = self.get('pyramid.reload_resources',
|
config_reload_resources)
|
reload_resources = asbool(eget('PYRAMID_RELOAD_RESOURCES',
|
config_reload_resources))
|
# reload_resources is an older alias for reload_assets
|
eff_reload_assets = reload_assets or reload_resources
|
locale_name = self.get('default_locale_name', 'en')
|
locale_name = self.get('pyramid.default_locale_name', locale_name)
|
eff_locale_name = eget('PYRAMID_DEFAULT_LOCALE_NAME', locale_name)
|
config_prevent_http_cache = self.get('prevent_http_cache', '')
|
config_prevent_http_cache = self.get('pyramid.prevent_http_cache',
|
config_prevent_http_cache)
|
eff_prevent_http_cache = asbool(eget('PYRAMID_PREVENT_HTTP_CACHE',
|
config_prevent_http_cache))
|
config_prevent_cachebust = self.get('prevent_cachebust', '')
|
config_prevent_cachebust = self.get('pyramid.prevent_cachebust',
|
config_prevent_cachebust)
|
eff_prevent_cachebust = asbool(eget('PYRAMID_PREVENT_CACHEBUST',
|
config_prevent_cachebust))
|
require_default_csrf = self.get('pyramid.require_default_csrf')
|
eff_require_default_csrf = require_default_csrf
|
|
update = {
|
'debug_authorization': eff_debug_all or eff_debug_auth,
|
'debug_notfound': eff_debug_all or eff_debug_notfound,
|
'debug_routematch': eff_debug_all or eff_debug_routematch,
|
'debug_templates': eff_debug_all or eff_debug_templates,
|
'reload_templates': eff_reload_all or eff_reload_templates,
|
'reload_resources':eff_reload_all or eff_reload_assets,
|
'reload_assets':eff_reload_all or eff_reload_assets,
|
'default_locale_name':eff_locale_name,
|
'prevent_http_cache':eff_prevent_http_cache,
|
'prevent_cachebust':eff_prevent_cachebust,
|
'require_default_csrf':eff_require_default_csrf,
|
|
'pyramid.debug_authorization': eff_debug_all or eff_debug_auth,
|
'pyramid.debug_notfound': eff_debug_all or eff_debug_notfound,
|
'pyramid.debug_routematch': eff_debug_all or eff_debug_routematch,
|
'pyramid.debug_templates': eff_debug_all or eff_debug_templates,
|
'pyramid.reload_templates': eff_reload_all or eff_reload_templates,
|
'pyramid.reload_resources':eff_reload_all or eff_reload_assets,
|
'pyramid.reload_assets':eff_reload_all or eff_reload_assets,
|
'pyramid.default_locale_name':eff_locale_name,
|
'pyramid.prevent_http_cache':eff_prevent_http_cache,
|
'pyramid.prevent_cachebust':eff_prevent_cachebust,
|
'pyramid.require_default_csrf':eff_require_default_csrf,
|
}
|
|
self.update(update)
|
|
def __getattr__(self, name):
|
try:
|
val = self[name]
|
# only deprecate on success; a probing getattr/hasattr should not
|
# print this warning
|
warnings.warn(
|
'Obtaining settings via attributes of the settings dictionary '
|
'is deprecated as of Pyramid 1.2; use settings["foo"] instead '
|
'of settings.foo',
|
DeprecationWarning,
|
2
|
)
|
return val
|
except KeyError:
|
raise AttributeError(name)
|
