Settings¶

Configuration¶

To configure settings use settings.py in your application’s root. There should already be some defaults configured but you may add your own:

defaults['cats'] = {
    'herdable': False
}

settings.defaults(defaults)

To read your settings, import settings and use get():

from ferris import settings

HERDABLE = settings.get('cats').get('herdable')

Functions¶

ferris.core.settings.defaults(dict=None)[source]¶

Adds a set of default values to the settings registry. These can and will be updated by any settings modules in effect, such as the Settings Manager.

If dict is None, it’ll return the current defaults.

ferris.core.settings.settings()[source]¶

Returns the entire settings registry

ferris.core.settings.get(key, default=None)[source]¶

Returns the setting at key, if available, raises an ConfigurationError if default is none, otherwise returns the default

Plugin¶

The built-in settings plugin provides you with the ability to configure overrides to the default settings via a web interface.

To use the settings plugin make sure it’s enabled in app/routes.py (preferably before any other plugins):

plugins.enable('settings')

You can then access the settings manager at /admin/settings.

Any settings specified in the admin interface will take precendence over the ones specified in your settings.py file.

You can also add your own custom settings to the admin interface. To do so, subclass the setting model Setting:

from ferris import ndb
from plugins.settings.models.setting import Setting


class SFTPSettings(Setting):
    _name = 'SFTP Settings'
    _settings_key = 'sftp_settings'
    _description = 'SFTP Settings'
    server = ndb.StringProperty(required=True)
    user_name = ndb.StringProperty(required=True)
    password = ndb.StringProperty(required=True)

This is a normal model class so regular ndb properties are used to specify fields. You must also specify the _setting_key and _name attributes.

class plugins.settings.Setting¶

Setting._setting_key¶

The key where the settings will be stored. To get these settings use settings.get(_setting_key).

Setting._name¶

The name to display for this setting in the admin interface.

Setting._description¶

The description to use for this setting in the admin interface.