Input

Note

Input modules either take events from the outside world or generate events.

Input module properties:

• They have a protocol decoder method mapped to wishbone.module.InputModule.decode() in order to convert the incoming data into a workable datastructure.
• wishbone.actorconfig.ActorConfig.protocol_function determines whether wishbone.module.InputModule.generateEvent() either expects events from the outside world to be Wishbone events or regular data.
• Contextual data about the incoming event can/should be stored under tmp.<module name>.
• Should always have an destination and native_events parameter.
• Should use wishbone.actor.Actor.generateEvent() to generate the event in which to store the incoming data. It takes care of how the event is created in relation to the obligatory destination and native_events parameters.
• If you’re setting a default decoder function make sure you use wishbone.module.InputModule.setDecoder() as this method will prevent overwrite any user defined decoder set via wishbone.actorconfig.ActorConfig.

The builtin Wishbone Input modules:

Name	Description
wishbone.module.input.cron	Generates an event at the defined time.
wishbone.module.input.generator	Generates an event at the chosen interval.
wishbone.module.input.inotify	Monitors one or more paths for inotify events.

---

Input modules must base wishbone.module.InputModule:

class wishbone.module.InputModule(config)

Bases: wishbone.actor.Actor

generateEvent(data={}, destination=None)

Generates a new event.

This function can get overridden by wishbone.module.InputModule._generateNativeEvent.

The provided data will be traversed in search of valid templates which then will be rendered.

Parameters:

• data – The payload to add to the event.
• destination – The destination key to write the data to

Returns:

An event containing data as a payload.

Return type:

wishbone.event.Event

getDecoder()

Returns a new instance of the handler() method of the decoder set by self.setDecoder(). Each concurrent incoming data stream should use its own instance of the decoder otherwise they end up overwriting each other’s content.

loop()

The global lock for this module.

Returns:True when module is in running mode. False if not. Return type:bool

postHook()

Is executed when module exits.

preHook()

Is executed when module starts. Can be overriden by the user.

registerConsumer(function, queue)

Registers <function> to process all events in <queue>

Don’t not trap errors here. When <function> fails then the event will be submitted to the “failed” queue, If <function> succeeds to the success queue.

Registering function to consume queue will also apply all the registered module functions against the events consumed from it.

Parameters:

• function – The function which processes events
• queue – The name of the queue from which function will process the events.

Returns:

None

renderEventKwargs(event, queue=None)

Renders kwargs using the content of event and stores the result under event.kwargs.

Parameters:

• event – An Event instance
• queue – The queue name so RenderKwargs can store the results in the correct queue context.

Returns:

The provided event instance.

Return type:

wishbone.event.Event

renderKwargs()

Renders kwargs without making use of event content. This is typically used when initiliazing a module and render the defined kwargs which do not need a event data for rendering.

Returns:None

sendToBackground(function, *args, **kwargs)

Executes a function and sends it to the background. Such a function should never exit until self.loop returns False. This method wraps function again in a loop as long self.loop returns False so that function is restarted and an error is logged.

Parameters:

• function – The function which has to be executed.
• *args – Variable length argument list.
• **kwargs – Arbitrary keyword arguments.

setDecoder(name, *args, **kwargs)

Sets the decoder with name <name> unless there’s already a decoder defined via actorconfig.ActorConfig.

Parameters:

• name – The entrypoint name of the decoder to initialize
• *args – Variable length argument list.
• **kwargs – Arbitrary keyword arguments.

start()

Starts the module.

Returns:None

stop()

Makes self.loop return False and handles shutdown of of the registered background jobs.

submit(event, queue)

Submits <event> to the queue with name <queue>.

Parameters:

• event – An event instance.
• queue – The name of the queue

Returns:

None