configmodel package

Submodules

configmodel.ConfigModel module

class configmodel.ConfigModel.ConfigModel(filename=None, **kwargs)

Bases: object

Base class for Config Models

class configmodel.ConfigModel.FieldInstance

Bases: object

definition: FieldBase | Any | None

get_path()

Get path to this field

get_value()

name: str | None

serializer: SerializerBase | None

set_value(value)

class configmodel.ConfigModel.MetaConfigModel

Bases: type

Metaclass for Config Models

configmodel.Decorators module

configmodel.Decorators.config_file(filename)

Decorator for ConfigModel classes to set the config file

configmodel.Decorators.nested_field(field_name)

Decorator for nested ConfigModel classes to define the field name in the parent class

configmodel.FieldBase module

class configmodel.FieldBase.FieldBase(name, default_value=None)

Bases: object

configmodel.Logger module

class configmodel.Logger.Log

Bases: object

classmethod debug(message)

classmethod error(message)

logging_enabled = False

configmodel.MixinCachedValues module

class configmodel.MixinCachedValues.MixinCachedValues

Bases: object

Mixin for caching values

class CachedValue(path, value, is_dirty=False)

Bases: object

Cached value

assign_cached_values(cached_values)

Assign cached values

get_cached_value(path)

Get cached value

set_cached_value(path, value, is_dirty=True)

Set cached value

configmodel.MixinDelayedWrite module

class configmodel.MixinDelayedWrite.InterruptibleTimer(timeout_seconds, callback)

Bases: object

Performs a callback after a specified timeout. The timer can be restarted by calling prolong() method.

cancel()

restart(timeout_seconds)

class configmodel.MixinDelayedWrite.MixinDelayedWrite(delayed_write_enabled=False, delay_seconds=1.0)

Bases: object

Mixin for delayed write

DEFAULT_DELAY_SECONDS = 1.0

configmodel.SerializerBase module

class configmodel.SerializerBase.SerializerBase(filename)

Bases: object

class FieldDefaultValue(path, value)

Bases: object

get_value(path)

set_value(path, value)

write_default_values_from_model(default_values: List[FieldDefaultValue])

Initialize default values

configmodel.SerializerIni module

class configmodel.SerializerIni.SerializerIni(filename)

Bases: SerializerBase, MixinCachedValues, MixinDelayedWrite

DEFAULT_SECTION = 'Global'

class ParameterLocation

Bases: object

property full_name

get_value(path)

set_value(path, value)

write_default_values_from_model(default_values)

Write default values to configuration file, if they are not already set

configmodel.SerializersFactory module

class configmodel.SerializersFactory.SerializersFactory

Bases: object

SUPPORTED_SERIALIZERS = [[<class 'configmodel.SerializerIni.SerializerIni'>, ['.ini']]]

classmethod get_all_supported_extensions()

Get all supported extensions

classmethod get_serializer_by_filename(filename)

Get serializer by filename

configmodel.Utils module

configmodel.Utils.pascal_case_to_snake_case(pascal_case_string)

Convert PascalCase string to snake_case string

Module contents

class configmodel.ConfigModel(filename=None, **kwargs)

Bases: object

Base class for Config Models

configmodel.config_file(filename)

Decorator for ConfigModel classes to set the config file

configmodel.nested_field(field_name)

Decorator for nested ConfigModel classes to define the field name in the parent class