isomer.events.objectmanager module

Module: Events

Major Isomer event declarations

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

Bases: isomer.events.system.authorized_event

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

class objectchange(uuid, schema, client, *args, **kwargs)

Bases: isomer.events.objectmanager.objectevent

A stored object has been successfully modified

class objectcreation(uuid, schema, client, *args, **kwargs)

Bases: isomer.events.objectmanager.objectevent

A new object has been successfully created

class objectdeletion(uuid, schema, client, *args, **kwargs)

Bases: isomer.events.objectmanager.objectevent

A stored object has been successfully deleted

class objectevent(uuid, schema, client, *args, **kwargs)

Bases: circuits.core.events.Event

A unspecified objectevent

__init__(uuid, schema, client, *args, **kwargs)

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.

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

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

Bases: isomer.events.system.authorized_event

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

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

Bases: isomer.events.system.authorized_event

A client requires a schema to validate data or display a form

class updatesubscriptions(schema, data, *args, **kwargs)

Bases: circuits.core.events.Event

A backend component needs to write changes to an object. Clients that are subscribed should be notified etc.

__init__(schema, data, *args, **kwargs)

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.