isomer.events.system module

Module: Events

Major Isomer event declarations

class anonymous_event(action, data, client, *args)

Bases: isomer.events.system.isomer_ui_event

Base class for events for logged in users.

__init__(action, data, client, *args)

Initializes an Isomer anonymous user interface event.

Parameters:

• action –
• data –
• client –
• args –

Returns:

classmethod realname()

Return real name of an object class

class authorized_event(user, action, data, client, *args)

Bases: isomer.events.system.isomer_ui_event

Base class for events for logged in users.

__init__(user, action, data, client, *args)

Initializes an Isomer authorized user interface event.

Parameters:

• user – User object from :py:class:isomer.web.clientmanager.User
• action –
• data –
• client –
• args –

Returns:

classmethod realname()

Return real name of an object class

roles = ['admin', 'crew']

classmethod source()

Return real name of an object class

class componentupdaterequest(force=False, install=False, *args)

Bases: isomer.events.system.frontendbuildrequest

Check for updated components

class debugrequest(*args)

Bases: isomer.events.system.authorized_event

Debugging event

__init__(*args)

Initializes an Isomer authorized user interface event.

Parameters:

• user – User object from :py:class:isomer.web.clientmanager.User
• action –
• data –
• client –
• args –

Returns:

class frontendbuildrequest(force=False, install=False, *args)

Bases: circuits.core.events.Event

Rebuild and/or install the frontend

__init__(force=False, install=False, *args)

An event is a message send to one or more channels. It is eventually dispatched to all components that have handlers for one of the channels and the event type.

All normal arguments and keyword arguments passed to the constructor of an event are passed on to the handler. When declaring a handler, its argument list must therefore match the arguments used for creating the event.

Every event has a name attribute that is used for matching the event with the handlers.

Variables:

• channels –

  an optional attribute that may be set before firing the event. If defined (usually as a class variable), the attribute specifies the channels that the event should be delivered to as a tuple. This overrides the default behavior of sending the event to the firing component’s channel.

  When an event is fired, the value in this attribute is replaced for the instance with the channels that the event is actually sent to. This information may be used e.g. when the event is passed as a parameter to a handler.

• value – this is a circuits.core.values.Value object that holds the results returned by the handlers invoked for the event.
• success – if this optional attribute is set to True, an associated event success (original name with “_success” appended) will automatically be fired when all handlers for the event have been invoked successfully.
• success_channels – the success event is, by default, delivered to same channels as the successfully dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.
• complete – if this optional attribute is set to True, an associated event complete (original name with “_complete” appended) will automatically be fired when all handlers for the event and all events fired by these handlers (recursively) have been invoked successfully.
• complete_channels – the complete event is, by default, delivered to same channels as the initially dispatched event itself. This may be overridden by specifying an alternative list of destinations using this attribute.

get_anonymous_events()

Return all registered anonymous events

get_user_events()

Return all registered authorized events

class isomer_basic_event(*args, **kwargs)

Bases: circuits.core.events.Event

Basic Isomer event class

__init__(*args, **kwargs)

Initializes a basic Isomer event.

For further details, check out the circuits documentation.

class isomer_event(*args, **kwargs)

Bases: isomer.events.system.isomer_basic_event

Isomer internal event class

class isomer_ui_event(*args, **kwargs)

Bases: isomer.events.system.isomer_basic_event

Isomer user interface event class

class logtailrequest(user, action, data, client, *args)

Bases: isomer.events.system.authorized_event

Request the logger’s latest output

populate_user_events()

Generate a list of all registered authorized and anonymous events

class profilerequest(*args)

Bases: isomer.events.system.authorized_event

A user has changed his profile

__init__(*args)

Parameters:

• user – Userobject of client
• data – The new profile data

class reload_configuration(target, *args, **kwargs)

Bases: isomer.events.system.isomer_ui_event

Instructs a component to reload its configuration

__init__(target, *args, **kwargs)

Initializes a basic Isomer event.

For further details, check out the circuits documentation.

class system_stop(*args, **kwargs)

Bases: isomer.events.system.isomer_event

Stop everything, save persistent state and cease operations