flask.Config.get_namespace

Config.get_namespace(namespace, lowercase=True, trim_namespace=True)[source]

Returns a dictionary containing a subset of configuration options that match the specified namespace/prefix. Example usage:

app.config['IMAGE_STORE_TYPE'] = 'fs'
app.config['IMAGE_STORE_PATH'] = '/var/app/images'
app.config['IMAGE_STORE_BASE_URL'] = 'http://img.website.com'
image_store_config = app.config.get_namespace('IMAGE_STORE_')

The resulting dictionary image_store_config would look like:

{
    'type': 'fs',
    'path': '/var/app/images',
    'base_url': 'http://img.website.com'
}

This is often useful when configuration options map directly to keyword arguments in functions or class constructors.

Parameters:
  • namespace – a configuration namespace
  • lowercase – a flag indicating if the keys of the resulting dictionary should be lowercase
  • trim_namespace – a flag indicating if the keys of the resulting dictionary should not include the namespace

New in version 0.11.