exopy.measurement.monitors.text_monitor.monitor module

The text monitor displays the database values it observes in a text format.

exopy.measurement.monitors.text_monitor.monitor.import_monitor_plugin()[source]

Delayed import of the plugin to avoid circular imports.

class exopy.measurement.monitors.text_monitor.monitor.TextMonitor[source]

Bases: exopy.measurement.monitors.base_monitor.BaseMonitor

Simple monitor displaying entries as text in a widget.

displayed_entries

List of the entries which should be displayed when a measurement is running. This should not be manipulated directly by user code.

undisplayed_entries

List of the entries which should not be displayed when a measurement is running. This should not be manipulated directly by user code.

hidden_entries

List of the entries which should be not displayed when a measurement is running because they would be redundant with another entry. (created by a rule for example.) This should not be manipulated directly by user code.

updaters

Mapping between a database entry and a list of callable used for updating a monitor entry which relies on the database entry.

rules

List of rules which should be used to build monitor entries.

custom_entries

List of user created monitor entries.

known_monitored_entries

List of all the known database entries.

process_news(news)[source]

Handle a news by calling every related entrt updater.

refresh_monitored_entries(entries=None)[source]

Rebuild entries based on the rules and database entries.

Parameters

entries (dict, optional) – Database entries to use when rebuilding the monitor entries.

handle_database_entries_change(news)[source]

Generate new entries for added values and clean removed values.

handle_database_nodes_change(news)[source]

Update the paths when a node is renamed.

get_state()[source]

Write the state of the monitor in a dictionary.

set_state(state)[source]

Rebuild all rules and dispatch entries according to the state.

Set the entries according to the state if one is present.

add_entries(section, entries)[source]

Add entries to the specified section.

The entries should not be present in another section. (save hidden)

Parameters

  • section ({'displayed', 'undisplayed', 'hidden'}) – Section in which to add the entries.

  • entry (iterable[MonitoredEntry]) – Entries to add.

move_entries(origin, destination, entries)[source]

Move entries from a section to another.

Parameters

  • origin ({'displayed', 'undisplayed', 'hidden'}) – Section in which the entries currently are.

  • destination ({'displayed', 'undisplayed', 'hidden'}) – Section in which to put the entries.

  • entries (iterable[MonitoredEntry]) – Entries to move.

remove_entries(section, entries)[source]

Remove entries to the specified section.

The entries should not be present in another section.

Parameters

  • section ({'displayed', 'undisplayed', 'hidden'}) – Section from which to remove the entries.

  • entry (iterable[MonitoredEntry]) – Entries to remove.