magscope.settings

Attributes

DEFAULT_GUI_ACCENT_COLOR
GUI_ACCENT_COLOR_SETTING
GUI_LIVE_PLOT_PROGRESS_BAR_SETTING
PREFERENCES_BUNDLE_VERSION
TRACKING_OPTIONS_QSETTINGS_GROUP
TRACKING_OPTIONS_QSETTINGS_KEY
_HEX_COLOR_RE
DEFAULT_TRACKING_OPTIONS

Classes

SettingSpec
MagScopeSettings	A MutableMapping is a generic container for associating

Functions

normalize_hex_color(→ str)
default_tracking_options(→ dict[str, Any])
_coerce_tracking_int_value(→ int)
_coerce_tracking_float_value(→ float)
_coerce_tracking_bool_value(→ bool)
tracking_options_from_mapping(→ dict[str, Any])
tracking_options_from_qsettings(→ dict[str, Any])
save_tracking_options_to_qsettings(→ None)
build_preferences_bundle(→ dict[str, Any])
load_preferences_bundle_mapping(→ dict[str, Any])
export_preferences_bundle(→ None)
import_preferences_bundle(→ dict[str, Any])

Module Contents

magscope.settings.DEFAULT_GUI_ACCENT_COLOR = '#78c7ff'

magscope.settings.GUI_ACCENT_COLOR_SETTING = 'gui accent color'

magscope.settings.GUI_LIVE_PLOT_PROGRESS_BAR_SETTING = 'gui live plot progress bar'

magscope.settings.PREFERENCES_BUNDLE_VERSION = 1

magscope.settings.TRACKING_OPTIONS_QSETTINGS_GROUP = 'TrackingOptions'

magscope.settings.TRACKING_OPTIONS_QSETTINGS_KEY = 'options_yaml'

magscope.settings._HEX_COLOR_RE

magscope.settings.DEFAULT_TRACKING_OPTIONS: dict[str, Any]

magscope.settings.normalize_hex_color(value: str) → str

magscope.settings.default_tracking_options() → dict[str, Any]

magscope.settings._coerce_tracking_int_value(raw: Any, *, name: str, fallback: int, minimum: int | None = None, enforce_odd: bool = False) → int

magscope.settings._coerce_tracking_float_value(raw: Any, *, name: str, fallback: float, minimum: float | None = None) → float

magscope.settings._coerce_tracking_bool_value(raw: Any, *, fallback: bool) → bool

magscope.settings.tracking_options_from_mapping(loaded: Any) → dict[str, Any]

magscope.settings.tracking_options_from_qsettings() → dict[str, Any]

magscope.settings.save_tracking_options_to_qsettings(options: Mapping[str, Any]) → None

magscope.settings.build_preferences_bundle(*, magscope_settings: MagScopeSettings, tracking_options: Mapping[str, Any], appearance_layout: Mapping[str, Any] | None = None) → dict[str, Any]

magscope.settings.load_preferences_bundle_mapping(data: Any) → dict[str, Any]

magscope.settings.export_preferences_bundle(path: str | os.PathLike[str], *, magscope_settings: MagScopeSettings, tracking_options: Mapping[str, Any], appearance_layout: Mapping[str, Any] | None = None) → None

magscope.settings.import_preferences_bundle(path: str | os.PathLike[str]) → dict[str, Any]

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

validator: Callable[[Any], Any] | None = None

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'

_MAG_SCOPE_PANEL_EXCLUDED_KEYS

_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]

classmethod magscope_panel_keys() → Iterable[str]