duck.settings.settings

Provides access to application settings.

Module Contents

Classes

Settings

A class for managing Duck settings.

Functions

get_combined_settings	Combine default and user settings into a single settings object.
settings_to_dict	Convert a settings module into a Settings object.
warn_deprecated_settings	Warn about deprecated settings currently in use.

Data

DEPRECATED_SETTINGS
SETTINGS
SETTINGS_MODULE

API

duck.settings.settings.DEPRECATED_SETTINGS: List[Tuple[str, str]]

[(‘FORCE_HTTPS’, “Setting ‘FORCE_HTTPS’ is deprecated, please use ‘HTTPS_REDIRECT’ instead.”), (‘FOR…

duck.settings.settings.SETTINGS: duck.settings.settings.Settings

‘get_combined_settings(…)’

duck.settings.settings.SETTINGS_MODULE

‘get(…)’

class duck.settings.settings.Settings

Bases: dict

A class for managing Duck settings.

Initialization

Initialize self. See help(type(self)) for accurate signature.

__repr__()

reload()

Re-execute the settings module and update this dict in-place.

source

None

duck.settings.settings.get_combined_settings() → duck.settings.settings.Settings

Combine default and user settings into a single settings object.

Returns:

Combined settings object.

Return type:

Settings

Raises:

SettingsError – Raised if the user settings module cannot be loaded.

duck.settings.settings.settings_to_dict(settings_module: str) → duck.settings.settings.Settings

Convert a settings module into a Settings object.

duck.settings.settings.warn_deprecated_settings(settings: Settings)

Warn about deprecated settings currently in use.

Parameters:

settings – Loaded settings object to inspect.