microscope.abc._Setting Class Reference

Public Member Functions
None	__init__ (self, str name, str dtype, typing.Optional[typing.Callable[[], typing.Any]] get_func, typing.Optional[typing.Callable[[typing.Any], None]] set_func=None, typing.Any values=None, typing.Optional[typing.Callable[[], bool]] readonly=None)
	describe (self)
	get (self)
bool	readonly (self)
None	set (self, value)
	values (self)

Public Attributes
	name = name
str	dtype = dtype

Protected Attributes
	_get = get_func
	_values = values
	_last_written = None
	_set = set_func
bool	_readonly = lambda: True

Detailed Description

Create a setting.

Args:
    name: the setting's name.
    dtype: a data type from `"int"`, `"float"`, `"bool"`,
        `"enum"`, or `"str"` (see `DTYPES`).
    get_func: a function to get the current value.
    set_func: a function to set the value.
    values: a description of allowed values dependent on dtype, or
        function that returns a description.
    readonly: an optional function to indicate if the setting is
        readonly.  A setting may be readonly temporarily, so this
        function will return `True` or `False` to indicate its
        current state.  If set to no `None` (default), then its
        value will be dependent on the value of `set_func`.

A client needs some way of knowing a setting name and data type,
retrieving the current value and, if settable, a way to retrieve
allowable values, and set the value.

Setters and getters accept or return:

* the setting value for int, float, bool and str;
* the setting index into a list, dict or Enum type for enum.

.. todo::

    refactor into subclasses to avoid if isinstance .. elif
    .. else.  Settings classes should be private: devices should
    use a factory method rather than instantiate settings
    directly; most already use add_setting for this.

Definition at line 64 of file abc.py.

Constructor & Destructor Documentation

__init__()

None microscope.abc._Setting.__init__	(		self,
		str	name,
		str	dtype,
		typing.Optional[typing.Callable[[], typing.Any]]	get_func,
		typing.Optional[typing.Callable[[typing.Any], None]]	set_func = None,
		typing.Any	values = None,
		typing.Optional[typing.Callable[[], bool]]	readonly = None )

Definition at line 99 of file abc.py.

    ) -> None:
        self.name = name
        if dtype not in DTYPES:
            raise ValueError("Unsupported dtype.")
        elif not (isinstance(values, DTYPES[dtype]) or callable(values)):
            raise TypeError(
                "Invalid values type for %s '%s': expected function or %s"
                % (dtype, name, DTYPES[dtype])
            )
        self.dtype = dtype
        self._get = get_func
        self._values = values
        self._last_written = None
        if self._get is not None:
            self._set = set_func
        else:
            # Cache last written value for write-only settings.
            def w(value):
                self._last_written = value
                set_func(value)
 
            self._set = w
 
        if readonly is None:
            if self._set is None:
                self._readonly = lambda: True
            else:
                self._readonly = lambda: False
        else:
            if self._set is None:
                raise ValueError(
                    "`readonly` is not `None` but `set_func` is `None`"
                )
            else:
                self._readonly = readonly
 

Member Function Documentation

describe()

microscope.abc._Setting.describe

(

self

)

Definition at line 143 of file abc.py.

    def describe(self):
        return {
            "type": self.dtype,
            "values": self.values(),
            "readonly": self.readonly(),
            "cached": self._last_written is not None,
        }
 

get()

microscope.abc._Setting.get

(

self

)

Definition at line 151 of file abc.py.

    def get(self):
        if self._get is not None:
            value = self._get()
        else:
            value = self._last_written
        if isinstance(self._values, EnumMeta):
            return self._values(value).value
        else:
            return value
 

readonly()

bool microscope.abc._Setting.readonly

(

self

)

Definition at line 161 of file abc.py.

    def readonly(self) -> bool:
        return self._readonly()
 

set()

None microscope.abc._Setting.set	(		self,
			value )

Set a setting.

Definition at line 164 of file abc.py.

    def set(self, value) -> None:
        """Set a setting."""
        if self._set is None:
            raise NotImplementedError()
        # TODO further validation.
        if isinstance(self._values, EnumMeta):
            value = self._values(value)
        self._set(value)
 

values()

microscope.abc._Setting.values

(

self

)

Definition at line 173 of file abc.py.

    def values(self):
        if isinstance(self._values, EnumMeta):
            return [(v.value, v.name) for v in self._values]
        values = _call_if_callable(self._values)
        if values is not None:
            if self.dtype == "enum":
                if isinstance(values, dict):
                    return list(values.items())
                else:
                    # self._values is a list or tuple
                    return list(enumerate(values))
            elif self._values is not None:
                return values
 
 

Member Data Documentation

_get

microscope.abc._Setting._get = get_func

protected

Definition at line 117 of file abc.py.

_last_written

microscope.abc._Setting._last_written = None

protected

Definition at line 119 of file abc.py.

_readonly

bool microscope.abc._Setting._readonly = lambda: True

protected

Definition at line 132 of file abc.py.

_set

microscope.abc._Setting._set = set_func

protected

Definition at line 121 of file abc.py.

_values

microscope.abc._Setting._values = values

protected

Definition at line 118 of file abc.py.

dtype

str microscope.abc._Setting.dtype = dtype

Definition at line 116 of file abc.py.

name

microscope.abc._Setting.name = name

Definition at line 108 of file abc.py.

---

The documentation for this class was generated from the following file:

• BioImager/PythonMicroscope/microscope/abc.py