magscope.settings

Classes

SettingSpec
MagScopeSettings	A MutableMapping is a generic container for associating

Module Contents

class magscope.settings.SettingSpec

key: str

value_type: type | tuple[type, Ellipsis]

default: Any | None = None

display_name: str | None = None

minimum: float | None = None

maximum: float | None = None

must_be_even: bool = False

coerce(value: Any) → Any

default_value() → Any

property _candidate_types: tuple[type, Ellipsis]

property label: str

class magscope.settings.MagScopeSettings(values: Mapping[str, Any] | None = None, *, persistence_available: bool = True, persistence_enabled: bool = False)

Bases: MutableMapping[str, Any]

A MutableMapping is a generic container for associating key/value pairs.

This class provides concrete generic implementations of all methods except for __getitem__, __setitem__, __delitem__, __iter__, and __len__.

_QSETTINGS_ORGANIZATION = 'MagScope'

_QSETTINGS_APPLICATION = 'MagScope'

_QSETTINGS_GROUP = 'MagScopeSettings'

_SETTING_SPECS: dict[str, SettingSpec]

_persistence_enabled = False

_persistence_listeners: list[Callable[[MagScopeSettings], None]] = []

persistence_available = True

_values: dict[str, Any]

classmethod _load_defaults() → dict[str, Any]

classmethod _qsettings() → PyQt6.QtCore.QSettings

_load_qsettings_values() → dict[str, Any]

_update_persistence_availability(available: bool) → None

add_persistence_listener(callback: Callable[[MagScopeSettings], None]) → None

classmethod from_qsettings(values: Mapping[str, Any] | None = None) → MagScopeSettings

save_to_qsettings() → None

reset_to_defaults() → None

to_dict() → dict[str, Any]

clone() → MagScopeSettings

persistent_copy() → MagScopeSettings

_coerce_setting(key: str, value: Any) → Any

update(mapping: Mapping[str, Any] | Iterable[tuple[str, Any]] = (), **kwargs: Any) → None

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F. If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

__getitem__(key: str) → Any

__setitem__(key: str, value: Any) → None

__delitem__(key: str) → None

__iter__()

__len__()

export_yaml(path: str | os.PathLike[str]) → None

classmethod import_yaml(path: str | os.PathLike[str]) → MagScopeSettings

classmethod spec_for(key: str) → SettingSpec

classmethod defined_keys() → Iterable[str]