SettingsBaseModel#

class gufe.settings.models.SettingsBaseModel(*args: Any, **kwargs: Any)#

Settings and modifications we want for all settings classes.

Methods

frozen_copy

A copy of this Settings object which cannot be modified

unfrozen_copy

A copy of this Settings object, which can be modified

Attributes

is_frozen

If this Settings object is frozen and cannot be modified

class Config#
Noindex:

arbitrary_types_allowed = False#
extra = 'forbid'#
smart_union = True#
frozen_copy()#

A copy of this Settings object which cannot be modified

This is intended to be used by Protocols to make their stored Settings read-only

property is_frozen#

If this Settings object is frozen and cannot be modified

unfrozen_copy()#

A copy of this Settings object, which can be modified

Settings objects become frozen when within a Protocol. If you really need to reverse this, this method is how.