Repository navigation
Expand file tree
/
Copy pathkicker.py
More file actions
269 lines (231 loc) · 7.83 KB
/
Copy pathkicker.py
File metadata and controls
269 lines (231 loc) · 7.83 KB
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
265
266
267
268
269
from dataclasses import asdict, is_dataclass
from datetime import datetime
from logging import getLogger
from typing import (
TYPE_CHECKING,
Any,
Coroutine,
Dict,
Generic,
Optional,
TypeVar,
Union,
overload,
)
from pydantic import BaseModel
from typing_extensions import ParamSpec
from taskiq.abc.middleware import TaskiqMiddleware
from taskiq.compat import model_dump
from taskiq.exceptions import SendTaskError
from taskiq.labels import prepare_label
from taskiq.message import TaskiqMessage
from taskiq.scheduler.created_schedule import CreatedSchedule
from taskiq.scheduler.scheduled_task import CronSpec, ScheduledTask
from taskiq.task import AsyncTaskiqTask
from taskiq.utils import maybe_awaitable
if TYPE_CHECKING: # pragma: no cover
from taskiq.abc.broker import AsyncBroker
from taskiq.abc.schedule_source import ScheduleSource
_T = TypeVar("_T")
_FuncParams = ParamSpec("_FuncParams")
_ReturnType = TypeVar("_ReturnType")
logger = getLogger("taskiq")
class AsyncKicker(Generic[_FuncParams, _ReturnType]):
"""Class that used to modify data before sending it to broker."""
def __init__(
self,
task_name: str,
broker: "AsyncBroker",
labels: Dict[str, Any],
) -> None:
self.task_name = task_name
self.broker = broker
self.labels = labels
self.custom_task_id: Optional[str] = None
def with_labels(
self,
**labels: Union[str, float],
) -> "AsyncKicker[_FuncParams, _ReturnType]":
"""
Update function's labels before sending.
:param labels: new labels.
:return: kicker with new labels.
"""
self.labels.update(labels)
return self
def with_task_id(self, task_id: str) -> "AsyncKicker[_FuncParams, _ReturnType]":
"""
Set task_id for current execution.
Please use this method with caution,
because it may brake the logic of getting results.
:param task_id: custom task id.
:return: kicker with custom task id.
"""
self.custom_task_id = task_id
return self
def with_broker(
self,
broker: "AsyncBroker",
) -> "AsyncKicker[_FuncParams, _ReturnType]":
"""
Replace broker for the function.
This method can be used with
shared tasks.
:param broker: new broker instance.
:return: Kicker with new broker.
"""
self.broker = broker
return self
@overload
async def kiq(
self: "AsyncKicker[_FuncParams, Coroutine[Any, Any, _T]]",
*args: _FuncParams.args,
**kwargs: _FuncParams.kwargs,
) -> AsyncTaskiqTask[_T]: # pragma: no cover
...
@overload
async def kiq(
self: "AsyncKicker[_FuncParams, _ReturnType]",
*args: _FuncParams.args,
**kwargs: _FuncParams.kwargs,
) -> AsyncTaskiqTask[_ReturnType]: # pragma: no cover
...
async def kiq(
self,
*args: _FuncParams.args,
**kwargs: _FuncParams.kwargs,
) -> Any:
"""
This method sends function call over the network.
It gets current broker and calls it's kick method,
returning what it returns.
:param args: function's arguments.
:param kwargs: function's key word arguments.
:raises SendTaskError: if we can't send task to the broker.
:returns: taskiq task.
"""
logger.debug(
f"Kicking {self.task_name} with args={args} and kwargs={kwargs}.",
)
message = self._prepare_message(*args, **kwargs)
for middleware in self.broker.middlewares:
if middleware.__class__.pre_send != TaskiqMiddleware.pre_send:
message = await maybe_awaitable(middleware.pre_send(message))
try:
await self.broker.kick(self.broker.formatter.dumps(message))
except Exception as exc:
raise SendTaskError from exc
for middleware in self.broker.middlewares:
if middleware.__class__.post_send != TaskiqMiddleware.post_send:
await maybe_awaitable(middleware.post_send(message))
return AsyncTaskiqTask(
task_id=message.task_id,
result_backend=self.broker.result_backend,
)
async def schedule_by_cron(
self,
source: "ScheduleSource",
cron: Union[str, "CronSpec"],
*args: _FuncParams.args,
**kwargs: _FuncParams.kwargs,
) -> CreatedSchedule[_ReturnType]:
"""
Function to schedule task with cron.
:param source: schedule source.
:param cron: cron expression.
:param args: function's args.
:param cron_offset: cron offset.
:param kwargs: function's kwargs.
:return: schedule id.
"""
schedule_id = self.broker.id_generator()
message = self._prepare_message(*args, **kwargs)
cron_offset = None
if isinstance(cron, CronSpec):
cron_str = cron.to_cron()
cron_offset = cron.offset
else:
cron_str = cron
scheduled = ScheduledTask(
schedule_id=schedule_id,
task_name=message.task_name,
labels=message.labels,
args=message.args,
kwargs=message.kwargs,
cron=cron_str,
cron_offset=cron_offset,
)
await source.add_schedule(scheduled)
return CreatedSchedule(self, source, scheduled)
async def schedule_by_time(
self,
source: "ScheduleSource",
time: datetime,
*args: _FuncParams.args,
**kwargs: _FuncParams.kwargs,
) -> CreatedSchedule[_ReturnType]:
"""
Function to schedule task to run at specific time.
:param source: schedule source.
:param time: time to run task at.
:param args: function's args.
:param kwargs: function's kwargs.
"""
schedule_id = self.broker.id_generator()
message = self._prepare_message(*args, **kwargs)
scheduled = ScheduledTask(
schedule_id=schedule_id,
task_name=message.task_name,
labels=message.labels,
args=message.args,
kwargs=message.kwargs,
time=time,
)
await source.add_schedule(scheduled)
return CreatedSchedule(self, source, scheduled)
@classmethod
def _prepare_arg(cls, arg: Any) -> Any:
"""
Parses argument if possible.
This function is used to construct dicts
from pydantic models or dataclasses.
:param arg: argument to format.
:return: Formatted argument.
"""
if isinstance(arg, BaseModel):
arg = model_dump(arg)
if is_dataclass(arg):
arg = asdict(arg)
return arg
def _prepare_message(
self,
*args: Any,
**kwargs: Any,
) -> TaskiqMessage:
"""
Create a message from args and kwargs.
:param args: function's args.
:param kwargs: function's kwargs.
:return: constructed message.
"""
formatted_args = []
formatted_kwargs = {}
labels = {}
labels_types = {}
for arg in args:
formatted_args.append(self._prepare_arg(arg))
for kwarg_name, kwarg_val in kwargs.items():
formatted_kwargs[kwarg_name] = self._prepare_arg(kwarg_val)
for label, label_val in self.labels.items():
labels[label], labels_types[label] = prepare_label(label_val)
task_id = self.custom_task_id
if task_id is None:
task_id = self.broker.id_generator()
return TaskiqMessage(
task_id=task_id,
task_name=self.task_name,
labels=labels,
labels_types=labels_types,
args=formatted_args,
kwargs=formatted_kwargs,
)