psi.experiment package

Submodules

psi.experiment.api module

psi.experiment.metadata_item module

psi.experiment.paradigm_description module

psi.experiment.plugin module

psi.experiment.preferences module

class psi.experiment.preferences.ItemPreferences(parent=None, **kwargs)[source]

Bases: _AutoPreferences

get_object(workbench)[source]

item

A member class which supports value initialization.

A plain Value provides support for default values and factories, but does not perform any type checking or validation. It serves as a useful base class for scalar members and can be used for cases where type checking is not needed (like private attributes).

class psi.experiment.preferences.PluginPreferences(parent=None, **kwargs)[source]

Bases: _AutoPreferences

get_object(workbench)[source]

plugin_id

A value of type str.

By default, bytes will NOT be promoted to strings. Pass strict=False to the constructor to enable loose string checking.

class psi.experiment.preferences.Preferences(parent=None, **kwargs)[source]

Bases: Declarative

get_object(workbench)[source]

get_preferences(workbench)[source]

name: Export the ‘name’ attribute as a declarative member.

set_preferences(workbench, preferences)[source]

psi.experiment.status_item module

psi.experiment.util module

psi.experiment.util.load_icon()[source]

psi.experiment.workbench module

psi.experiment.workspace module

class psi.experiment.workspace.ExperimentWorkspace(parent=None, **kwargs)[source]

Bases: Workspace

dock_area

A value which allows objects of a given type or types.

Values will be tested using the PyObject_TypeCheck C API call. This call is equivalent to type(obj) in cls.mro(). It is less flexible but can be faster than Instance. Use Instance when allowing you need a tuple of types or (abstract) types relying on custom __isinstancecheck__ and Typed when the value type is explicit.

If optional is True, the value of a Typed may be set to None, otherwise None is not considered as a valid value.

plugins_started()[source]

start()[source]

Start the workspace.

This method is called when the UI plugin starts the workspace. This can be used to load content or any other resource which should exist for the life of the workspace.