Package comodit_client :: Package api :: Module settings

Module settings

Provides classes related to setting entities, in particular HasSettings.

Classes
  Setting
Base class for all setting representations.
  SimpleSetting
Simple setting representation.
  LinkSetting
Link setting representation.
  PropertySetting
Property setting representation.
  SettingCollection
Collection of settings.
  HasSettings
Super class for entities having settings.
Functions
 
add_settings(container, settings)
Helper function that adds simple settings taken from a dictionary to a container.
Variables
  __package__ = 'comodit_client.api'
Function Details

add_settings(container, settings)

 

Helper function that adds simple settings taken from a dictionary to a container.

Parameters:
  • container (HasSettings) - The container.
  • settings (dict) - The dictionary containing settings' data. Each key is interpreted as a setting key and each value as simple setting value.