Phoenix Logo

phoenix_title wx.lib.delayedresult.Sender

Base class for various kinds of senders. A sender sends a result produced by a worker funtion to a result handler (listener). Note that each sender can be given a “job id”. This can be anything (number, string, id, and object, etc) and is not used, it is simply added as attribute whenever a DelayedResult is created. This allows you to know, if desired, what result corresponds to which sender. Note that uniqueness is not necessary.

Derive from this class if none of the existing derived classes are adequate, and override _sendImpl().


class_hierarchy Class Hierarchy

Inheritance diagram for class Sender:


method_summary Methods Summary

__init__ The optional jobID can be anything that you want to use to
getJobID Return the jobID given at construction
sendException Use this when the worker function raised an exception.
sendResult This will send the result to handler, using whatever

api Class API



class Sender

Base class for various kinds of senders. A sender sends a result produced by a worker funtion to a result handler (listener). Note that each sender can be given a “job id”. This can be anything (number, string, id, and object, etc) and is not used, it is simply added as attribute whenever a DelayedResult is created. This allows you to know, if desired, what result corresponds to which sender. Note that uniqueness is not necessary.

Derive from this class if none of the existing derived classes are adequate, and override _sendImpl().


Methods



__init__(self, jobID=None)

The optional jobID can be anything that you want to use to track which sender particular results come from.



getJobID(self)

Return the jobID given at construction



sendException(self, exception, extraInfo = None, originalTb = None)

Use this when the worker function raised an exception. The exception is the instance of Exception caught. The extraInfo could be anything you want (e.g. locals or traceback etc), it will be added to the exception as attribute ‘extraInfo’. The exception will be raised when DelayedResult.get() is called.



sendResult(self, result)

This will send the result to handler, using whatever technique the derived class uses.