File size: 9,524 Bytes
079c32c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 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 |
from enum import unique, IntEnum
from threading import Lock
from typing import Mapping, Any, Optional, Callable
from uuid import UUID, uuid4
import enum_tools
import requests
from requests import RequestException
from .base import _BEFORE_HOOK_TYPE, _AFTER_HOOK_TYPE, _ERROR_HOOK_TYPE
from ..base import HttpEngine, get_values_from_response, default_func
@enum_tools.documentation.document_enum
@unique
class TaskResultType(IntEnum):
"""
Overview:
Types of the task result
"""
COMPLETED = 1 # doc: Task complete without error
FAILED = 2 # doc: Task end with error
@enum_tools.documentation.document_enum
@unique
class TaskStatus(IntEnum):
"""
Overview:
Status of a task
"""
IDLE = 0x00 # doc: Task not started, waiting for awake
STARTING = 0x11 # doc: Task is starting, but initialization is not completed.
STARTED = 0x12 # doc: Task started, initialization is completed.
START_FAILED = 0x13 # doc: Task start failed, error occurred when initializing.
COMPLETED = 0x21 # doc: Task completed without error
FAILED = 0x22 # doc: Task ended with error
_COMPLETE_TRIGGER_NAME = '__TASK_COMPLETE__'
_FAIL_TRIGGER_NAME = '__TASK_FAIL__'
class Task:
"""
Overview:
Task object of the connections.
Linking call is fully supported.
Example:
>>> with master.new_connection('cnn1,', '127.0.0.1', 2333) as connection:
>>> task = connection.new_task({'data': 233})
>>> # task is not sent yet
>>>
>>> task = task.on_complete(func1).on_fail(func2).on_complete(func3).start().join()
>>> # task is completed or failed after this line
>>> # when task completed : func1(result) --> func3(result)
>>> # when task failed : func2(result)
"""
def __init__(
self,
http_engine: HttpEngine,
data: Mapping[str, Any],
task_id: Optional[UUID] = None,
before_task_start: Optional[_BEFORE_HOOK_TYPE] = None,
after_task_start: Optional[_AFTER_HOOK_TYPE] = None,
error_task_start: Optional[_ERROR_HOOK_TYPE] = None
):
"""
Overview:
Constructor of `Task`
Arguments:
- http_engine (:obj:`HttpEngine`): Http engine object used by the task
- data (:obj:`Mapping[str, Any]`): Task data of the task
- task_id (:obj:`Optional[UUID]`): Id of the task
- before_task_start (:obj:`Optional[_BEFORE_HOOK_TYPE]`): Callback to be executed before task start \
(`None` means do nothing)
- after_task_start (:obj:`Optional[_AFTER_HOOK_TYPE]`): Callback to be executed after task start \
(`None` means do nothing)
- error_task_start (:obj:`Optional[_ERROR_HOOK_TYPE]`): Callback to be executed when task start failed \
(`None` means do nothing)
"""
self.__http_engine = http_engine
self.__lock = Lock()
self.__task_id = task_id or uuid4()
self.__task_data = data
self.__task_result = None
self.__task_status = TaskStatus.IDLE
self.__task_lock = Lock()
self.__before_task_start = before_task_start or (lambda d: d)
self.__after_task_start = default_func(None)(after_task_start)
self.__error_task_start = default_func(None)(error_task_start)
self.__after_task_completed_callbacks = []
self.__after_task_failed_callbacks = []
self.__init_triggers()
def __request(self, method: str, path: str, data: Optional[Mapping[str, Any]] = None) -> requests.Response:
return self.__http_engine.request(method, path, data)
def __task_start(self):
try:
self.__task_status = TaskStatus.STARTING
response = self.__request(
'POST', '/task/new', {
'task': {
'id': str(self.__task_id)
},
'data': self.__before_task_start(self.__task_data) or {}
}
)
except RequestException as err:
self.__task_status = TaskStatus.START_FAILED
return self.__error_task_start(err)
else:
self.__task_status = TaskStatus.STARTED
ret = self.__after_task_start(*get_values_from_response(response))
self.__task_lock.acquire()
return ret
def __task_complete(self, result: Mapping[str, Any]):
self.__task_status = TaskStatus.COMPLETED
self.__task_result = result
for _callback in self.__after_task_completed_callbacks:
_callback(self.__task_data, result)
self.__task_lock.release()
def __task_fail(self, result: Mapping[str, Any]):
self.__task_status = TaskStatus.FAILED
self.__task_result = result
for _callback in self.__after_task_failed_callbacks:
_callback(self.__task_data, result)
self.__task_lock.release()
# trigger methods
def __task_complete_trigger(self, result: Mapping[str, Any]):
with self.__lock:
if self.__task_status == TaskStatus.STARTED:
self.__task_complete(result)
else:
raise ValueError(
"Only task with {expect} status can be completed, but {actual} found.".format(
expect=repr(TaskStatus.STARTED.name),
actual=repr(self.__task_status.name),
)
)
def __task_fail_trigger(self, result: Mapping[str, Any]):
with self.__lock:
if self.__task_status == TaskStatus.STARTED:
self.__task_fail(result)
else:
raise ValueError(
"Only task with {expect} status can be failed, but {actual} found.".format(
expect=repr(TaskStatus.STARTED.name),
actual=repr(self.__task_status.name),
)
)
def __init_triggers(self):
setattr(self, _COMPLETE_TRIGGER_NAME, self.__task_complete_trigger)
setattr(self, _FAIL_TRIGGER_NAME, self.__task_fail_trigger)
# public properties
@property
def status(self) -> TaskStatus:
"""
Overview:
Get status of the current task
Returns:
- status (:obj:`TaskStatus`): Task status
"""
return self.__task_status
@property
def task(self) -> Mapping[str, Any]:
"""
Overview:
Get task data of the current task
Returns:
- data (:obj:`Mapping[str, Any]`): Task data
"""
return self.__task_data
@property
def result(self) -> Optional[Mapping[str, Any]]:
"""
Overview:
Get task result of the current task, return `None` if task is not completed or failed.
Returns:
- result (:obj:`Optional[Mapping[str, Any]]`): Task result (`None` when not completed or failed)
"""
return self.__task_result
# public methods
def start(self) -> 'Task':
"""
Overview:
Start current task.
Returns:
- task (:obj:`Task`): Self object, supporting linking call
"""
with self.__lock:
if self.__task_status == TaskStatus.IDLE:
self.__task_start()
return self
else:
raise ValueError(
"Only task with {expect} status can be started, but {actual} found.".format(
expect=repr(TaskStatus.IDLE.name),
actual=repr(self.__task_status.name),
)
)
def join(self) -> 'Task':
"""
Overview:
Wait until the task is completed or failed.
Returns:
- task (:obj:`Task`): Self object, supporting linking call
"""
with self.__task_lock:
return self
def on_complete(self, callback: Callable[[Mapping[str, Any], Mapping[str, Any]], Any]) -> 'Task':
"""
Overview:
Execute the callback when the task completed. Multiple callbacks is supported by using linking call.
Arguments:
- callback (:obj:`Callable[[Mapping[str, Any], Mapping[str, Any]], Any]`): Function to be executed when \
task completed.
Returns:
- task (:obj:`Task`): Self object, supporting linking call
"""
with self.__lock:
self.__after_task_completed_callbacks.append(callback)
return self
def on_fail(self, callback: Callable[[Mapping[str, Any], Mapping[str, Any]], Any]) -> 'Task':
"""
Overview:
Execute the callback when the task failed. Multiple callbacks is supported by using linking call.
Arguments:
- callback (:obj:`Callable[[Mapping[str, Any], Mapping[str, Any]], Any]`): Function to be executed when \
task failed.
Returns:
- task (:obj:`Task`): Self object, supporting linking call
"""
with self.__lock:
self.__after_task_failed_callbacks.append(callback)
return self
def _task_complete(task: Task, result: Mapping[str, Any]):
getattr(task, _COMPLETE_TRIGGER_NAME)(result)
def _task_fail(task: Task, result: Mapping[str, Any]):
getattr(task, _FAIL_TRIGGER_NAME)(result)
|