EventHandler
class¶
A class that encapsulates event callbacks and provides a mechanism for executing them when the event occurs. This class manages both asynchronous and synchronous execution and handles event completion in both success and error scenarios.
Notes:
-
The
__call__
method of theEventHandler
class is an asynchronous method that returns aCoroutine
. It should never be treated as a synchronous function. -
This class is not intended to be subclassed or manually created. It is used internally to encapsulate the callbacks associated with an event and manage their execution.
-
The event handler can be invoked by calling the instance as a function and passing the required arguments.
Read more in the Pyventus docs for Event Handler.
Source code in pyventus/handlers/event_handler.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
|
Attributes¶
once
property
¶
Determines if the event handler is a one-time subscription.
RETURNS | DESCRIPTION |
---|---|
bool
|
A boolean value indicating if the event handler is a one-time subscription. |
force_async
property
¶
Determines whether all callbacks are forced to run asynchronously.
RETURNS | DESCRIPTION |
---|---|
bool
|
A boolean value indicating if all callbacks are forced to run asynchronously. If |
timestamp
property
¶
Retrieves the timestamp when the event handler was created.
RETURNS | DESCRIPTION |
---|---|
datetime
|
The timestamp when the event handler was created. |
Functions¶
get_callback_name
staticmethod
¶
get_callback_name(callback: EventCallbackType | SuccessCallbackType | FailureCallbackType | None) -> str
Retrieves the name of the provided callback.
PARAMETER | DESCRIPTION |
---|---|
callback
|
The callback object.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
str
|
The name of the callback as a string. |
Source code in pyventus/handlers/event_handler.py
validate_callback
staticmethod
¶
Validates whether the provided callback is a valid callable object.
PARAMETER | DESCRIPTION |
---|---|
callback
|
The callback to be validated.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
None
|
None |
RAISES | DESCRIPTION |
---|---|
PyventusException
|
If the callback is not a callable object. |
Source code in pyventus/handlers/event_handler.py
is_async
staticmethod
¶
Checks whether the provided callback is an asynchronous function or method.
PARAMETER | DESCRIPTION |
---|---|
callback
|
The callback to be checked.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
bool
|
|
RAISES | DESCRIPTION |
---|---|
PyventusException
|
If the callback is not a callable or a string. |
Source code in pyventus/handlers/event_handler.py
__init__
¶
__init__(once: bool, force_async: bool, event_callback: EventCallbackType, success_callback: SuccessCallbackType | None = None, failure_callback: FailureCallbackType | None = None) -> None
Initialize an instance of EventHandler
.
PARAMETER | DESCRIPTION |
---|---|
once
|
Specifies if the event handler is a one-time subscription.
TYPE:
|
force_async
|
Determines whether to force all callbacks to run asynchronously. If
TYPE:
|
event_callback
|
The callback to be executed when the event occurs.
TYPE:
|
success_callback
|
The callback to be executed when the event execution completes successfully. Default is
TYPE:
|
failure_callback
|
The callback to be executed when the event execution fails. Default is
TYPE:
|
RAISES | DESCRIPTION |
---|---|
PyventusException
|
If the provided callbacks are invalid. |
Source code in pyventus/handlers/event_handler.py
__call__
async
¶
Executes the event flow by invoking the associated callbacks.
PARAMETER | DESCRIPTION |
---|---|
args
|
Positional arguments to be passed to the event callback.
TYPE:
|
kwargs
|
Keyword arguments to be passed to the event callback.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
None
|
Coroutine |