config

class mautrix.util.config.BaseConfig

Bases: ABC, RecursiveDict[CommentedMap]

abstractmethod do_update(helper)

Parameters:

helper (ConfigUpdateHelper)

Return type:

None

abstractmethod load()

Return type:

None

load_and_update()

Return type:

None

abstractmethod load_base()

Return type:

RecursiveDict[CommentedMap] | None

abstractmethod save()

Return type:

None

update(save=True)

Parameters:

save (bool)

Return type:

None

exception mautrix.util.config.BaseMissingError

Bases: ValueError

class mautrix.util.config.ConfigUpdateHelper

Bases: object

__init__(base, config)

Parameters:

• base (RecursiveDict)

• config (RecursiveDict)

Return type:

None

copy(from_path, to_path=None)

Parameters:

• from_path (str)

• to_path (str | None)

Return type:

None

copy_dict(from_path, to_path=None, override_existing_map=True)

Parameters:

• from_path (str)

• to_path (str | None)

• override_existing_map (bool)

Return type:

None

base: RecursiveDict[CommentedMap]

class mautrix.util.config.BaseFileConfig

Bases: BaseConfig, ABC

__init__(path, base_path)

Parameters:

• path (str)

• base_path (str)

Return type:

None

load()

Return type:

None

load_base()

Return type:

RecursiveDict[CommentedMap] | None

save()

Return type:

None

class mautrix.util.config.BaseProxyConfig

Bases: BaseConfig, ABC

__init__(load, load_base, save)

Parameters:

• load (Callable[[], CommentedMap])

• load_base (Callable[[], RecursiveDict[CommentedMap] | None])

• save (Callable[[RecursiveDict[CommentedMap]], None])

Return type:

None

load()

Return type:

None

load_base()

Return type:

RecursiveDict[CommentedMap] | None

save()

Return type:

None

class mautrix.util.config.RecursiveDict

Bases: Generic[T]

__init__(data=None, dict_factory=None)

Parameters:

• data (T | None)

• dict_factory (Type[T] | None)

Return type:

None

clone()

Return type:

RecursiveDict

delete(key, allow_recursion=True)

Parameters:

• key (str)

• allow_recursion (bool)

Return type:

None

get(key, default_value, allow_recursion=True)

Parameters:

• key (str)

• default_value (Any)

• allow_recursion (bool)

Return type:

Any

static parse_key(key)

Parameters:

key (str)

Return type:

tuple[str, str | None]

set(key, value, allow_recursion=True)

Parameters:

• key (str)

• value (Any)

• allow_recursion (bool)

Return type:

None

class mautrix.util.config.BaseStringConfig

Bases: BaseConfig, ABC

__init__(data, base_data)

Parameters:

• data (str)

• base_data (str)

Return type:

None

load()

Return type:

None

load_base()

Return type:

RecursiveDict[CommentedMap] | None

save()

Return type:

str

class mautrix.util.config.BaseValidatableConfig

Bases: BaseConfig, ABC

check_default_values()

Return type:

None

abstract property forbidden_defaults: list[ForbiddenDefault]

exception mautrix.util.config.ConfigValueError

Bases: ValueError

__init__(key, message)

Parameters:

• key (str)

• message (str)

Return type:

None

class mautrix.util.config.ForbiddenDefault

Bases: object

__init__(key, value, error=None, *, condition=None)

Method generated by attrs for class ForbiddenDefault.

Parameters:

• key (str)

• value (Any)

• error (str | None)

• condition (str | None)

Return type:

None

check(config)

Parameters:

config (BaseConfig)

Return type:

bool

property exception: ConfigValueError

key: str

value: Any

error: str | None

condition: str | None

class mautrix.util.config.ForbiddenKey

Bases: str