telegram.ext.utils.promise.Promise¶

class telegram.ext.utils.promise.Promise(pooled_function, args, kwargs, update=None, error_handling=True)¶

Bases: object

A simple Promise implementation for use with the run_async decorator, DelayQueue etc.

Parameters

pooled_function (callable) – The callable that will be called concurrently.
args (list | tuple) – Positional arguments for pooled_function.
kwargs (dict) – Keyword arguments for pooled_function.
update (telegram.Update | object, optional) – The update this promise is associated with.
error_handling (bool, optional) – Whether exceptions raised by func may be handled by error handlers. Defaults to True.

pooled_function¶

The callable that will be called concurrently.

args¶

Positional arguments for pooled_function.

kwargs¶

Keyword arguments for pooled_function.

done¶

Is set when the result is available.

update¶

Optional. The update this promise is associated with.

error_handling¶

Optional. Whether exceptions raised by func may be handled by error handlers. Defaults to True.

property exception¶: The exception raised by pooled_function or None if no exception has been raised (yet).

result(timeout=None)¶

Return the result of the Promise.

Parameters: timeout (float, optional) – Maximum time in seconds to wait for the result to be calculated. None means indefinite. Default is None.
Returns: Returns the return value of pooled_function or None if the timeout expires.
Return type: Optional[RT]

:raises object exception raised by pooled_function.:

run()¶

Calls the pooled_function callable.