circuits.io.notify – File System Notification — circuits 2.1.0 documentation

# circuits 2.1.0 documentation

# `circuits.io.notify` – File System Notification

## Events

class `circuits.io.notify.` `Accessed`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Accessed Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Closed`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Closed Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Created`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Created Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Deleted`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Deleted Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Modified`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Modified Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Moved`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Moved Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Opened`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Opened Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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 `circuits.io.notify.` `Unmounted`(*args, **kwargs)

  Bases: `circuits.core.events.Event`

  Unmounted Event

  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. By default, the name is the uncameled class name of the event.

  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 `EventSuccess` (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 `EventComplete` (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. success_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.

## Components

class `circuits.io.notify.` `Notify`(channel='notify')

  Bases: `circuits.core.components.Component`

## Functions