Перейти к содержанию

AsyncWorker

Init module for async worker.

AsyncWorker

Bases: BaseWorker, AsyncPluginMixin

Воркер, Получающий из Брокера задачи и обрабатывающий их.

Пример

from qtasks import QueueTasks
from qtasks.workers import AsyncWorker

worker = AsyncWorker()
app = QueueTasks(worker=worker)
Source code in src/qtasks/workers/async_worker.py
 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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
class AsyncWorker(BaseWorker, AsyncPluginMixin):
    """
    Воркер, Получающий из Брокера задачи и обрабатывающий их.

    ## Пример

    ```python
    from qtasks import QueueTasks
    from qtasks.workers import AsyncWorker

    worker = AsyncWorker()
    app = QueueTasks(worker=worker)
    ```
    """

    def __init__(
        self,
        name: Annotated[
            str,
            Doc(
                """
                    Имя проекта. Это имя также используется воркером.

                    По умолчанию: `QueueTasks`.
                    """
            ),
        ] = "QueueTasks",
        broker: Annotated[
            Optional["BaseBroker"],
            Doc(
                """
                    Брокер.

                    По умолчанию: `qtasks.brokers.AsyncRedisBroker`.
                    """
            ),
        ] = None,
        log: Annotated[
            Optional[Logger],
            Doc(
                """
                    Логгер.

                    По умолчанию: `qtasks.logs.Logger`.
                    """
            ),
        ] = None,
        config: Annotated[
            Optional[QueueConfig],
            Doc(
                """
                    Конфиг.

                    По умолчанию: `qtasks.configs.config.QueueConfig`.
                    """
            ),
        ] = None,
        events: Annotated[
            Optional["BaseEvents"],
            Doc(
                """
                    События.

                    По умолчанию: `qtasks.events.AsyncEvents`.
                    """
            ),
        ] = None,
    ):
        """Инициализация асинхронного воркера.

        Args:
            name (str, optional): Имя проекта. По умолчанию: "QueueTasks".
            broker (BaseBroker, optional): Брокер. По умолчанию: `None`.
            log (Logger, optional): Логгер. По умолчанию: `None`.
            config (QueueConfig, optional): Конфиг. По умолчанию: `None`.
            events (BaseEvents, optional): События. По умолчанию: `qtasks.events.AsyncEvents`.
        """
        super().__init__(name=name, broker=broker, log=log, config=config, events=events)
        self.events = self.events or AsyncEvents()
        self.broker = broker or AsyncRedisBroker(
            name=self.name, log=self.log, config=self.config
        )
        self.queue = asyncio.PriorityQueue()

        self._tasks: Dict[str, TaskExecSchema] = {}
        self._stop_event: Optional[asyncio.Event] = None
        self.semaphore = asyncio.Semaphore(self.config.max_tasks_process)
        self.condition: Optional[asyncio.Condition] = None

        self.task_executor = AsyncTaskExecutor

    async def worker(
        self,
        number: Annotated[
            int,
            Doc(
                """
                    Номер Воркера.
                    """
            ),
        ],
    ) -> None:
        """Обработчик задач.

        Args:
            number (int): Номер Воркера.
        """
        await self.events.fire("worker_running", worker=self, number=number)

        try:
            while not self._stop_event.is_set():
                async with self.condition:
                    while self.queue.empty():
                        await self.condition.wait()

                task_broker: Union[TaskPrioritySchema, None] = await self.queue.get()
                if task_broker is None:
                    break
                asyncio.create_task(self._execute_task(task_broker))
        finally:
            await self.events.fire("worker_stopping", worker=self, number=number)

    async def _execute_task(
        self,
        task_broker: Annotated[
            TaskPrioritySchema,
            Doc(
                """
                    Схема приоритетной задачи.
                    """
            ),
        ],
    ) -> None:
        """Выполняет задачу независимо.

        Args:
            task_broker (TaskPrioritySchema): Схема приоритетной задачи.
        """
        async with self.semaphore:
            model = TaskStatusProcessSchema(
                task_name=task_broker.name,
                priority=task_broker.priority,
                created_at=task_broker.created_at,
                updated_at=time(),
                args=task_broker.args,
                kwargs=task_broker.kwargs,
            )

            task_func = await self._task_exists(task_broker=task_broker)
            if not task_func:
                self.queue.task_done()
                return

            new_model = await self._plugin_trigger(
                "worker_execute_before",
                worker=self,
                task_broker=task_broker,
                task_func=task_func,
                model=model,
                return_last=True
            )
            if new_model:
                model = new_model.get("model", model)

            await self.broker.update(
                name=f"{self.name}:{task_broker.uuid}", mapping=asdict(model)
            )

            await self.events.fire("task_running", worker=self, task_func=task_func, task_broker=task_broker)
            model = await self._run_task(task_func, task_broker)
            await self.events.fire("task_stopping", worker=self, task_func=task_func, task_broker=task_broker, model=model)

            await self.remove_finished_task(task_func=task_func, task_broker=task_broker, model=model)

            await self._plugin_trigger("worker_execute_after", task_func=task_func, task_broker=task_broker, model=model)

            self.queue.task_done()

    async def add(
        self,
        name: Annotated[
            str,
            Doc(
                """
                    Имя задачи.
                    """
            ),
        ],
        uuid: Annotated[
            UUID,
            Doc(
                """
                    UUID задачи.
                    """
            ),
        ],
        priority: Annotated[
            int,
            Doc(
                """
                    Приоритет задачи.
                    """
            ),
        ],
        created_at: Annotated[
            float,
            Doc(
                """
                    Создание задачи в формате timestamp.
                    """
            ),
        ],
        args: Annotated[
            tuple,
            Doc(
                """
                    Аргументы задачи типа args.
                    """
            ),
        ],
        kwargs: Annotated[
            dict,
            Doc(
                """
                    Аргументы задачи типа kwargs.
                    """
            ),
        ],
    ) -> Task:
        """Добавление задачи в очередь.

        Args:
            name (str): Имя задачи.
            uuid (UUID): UUID задачи.
            priority (int): Приоритет задачи.
            created_at (float): Создание задачи в формате timestamp.
            args (tuple): Аргументы задачи типа args.
            kwargs (dict): Аргументы задачи типа kwargs.
        """
        new_data = await self._plugin_trigger(
            "worker_add",
            worker=self,
            task_name=name,
            uuid=uuid,
            priority=priority,
            args=args,
            kw=kwargs,
            created_at=created_at,
            return_last=True
        )
        if new_data:
            name = new_data.get("name", name)
            uuid = new_data.get("uuid", uuid)
            priority = new_data.get("priority", priority)
            args = new_data.get("args", args)
            kwargs = new_data.get("kw", kwargs)
            created_at = new_data.get("created_at", created_at)

        model = TaskPrioritySchema(
            priority=priority,
            uuid=uuid,
            name=name,
            args=list(args),
            kwargs=kwargs,
            created_at=created_at,
            updated_at=created_at,
        )
        async with self.condition:
            await self.queue.put(model)
            self.condition.notify_all()
        return Task(
            status=TaskStatusEnum.NEW.value,
            task_name=name,
            uuid=uuid,
            priority=priority,
            args=args,
            kwargs=kwargs,
            created_at=created_at,
            updated_at=created_at,
        )

    async def start(
        self,
        num_workers: Annotated[
            int,
            Doc(
                """
                    Количество воркеров.

                    По умолчанию: `4`.
                    """
            ),
        ] = 4,
    ) -> None:
        """Запускает несколько обработчиков задач.

        Args:
            num_workers (int, optional): Количество воркеров. По умолчанию: 4.
        """
        self.num_workers = num_workers

        if self.condition is None:
            self.condition = asyncio.Condition()
        if self._stop_event is None:
            self._stop_event = asyncio.Event()
        await self._plugin_trigger("worker_start", worker=self)

        # Запускаем несколько воркеров
        loop = asyncio.get_event_loop()
        workers = [
            loop.create_task(self.worker(number))
            for number in range(self.num_workers)
        ]
        await self._stop_event.wait()  # Ожидание сигнала остановки

        # Ожидаем завершения всех воркеров
        for worker_task in workers:
            worker_task.cancel()
        await asyncio.gather(*workers, return_exceptions=True)

    async def stop(self):
        """Останавливает воркеры."""
        await self._plugin_trigger("worker_stop", worker=self)
        self._stop_event.set()

    def update_config(
        self,
        config: Annotated[
            QueueConfig,
            Doc(
                """
                    Конфиг.
                    """
            ),
        ],
    ) -> None:
        """Обновляет конфиг брокера и семафору.

        Args:
            config (QueueConfig): Конфиг.
        """
        self.config = config
        self.semaphore = Semaphore(config.max_tasks_process)

    async def _run_task(
        self, task_func: TaskExecSchema, task_broker: TaskPrioritySchema
    ) -> Union[TaskStatusSuccessSchema, TaskStatusErrorSchema, TaskStatusCancelSchema]:
        """Запуск функции задачи.

        Args:
            task_func (TaskExecSchema): Схема `qtasks.schemas.TaskExecSchema`.
            task_broker (TaskPrioritySchema): Схема `qtasks.schemas.TaskPrioritySchema`.

        Returns:
            Any: Результат функции задачи.
        """
        self.log.info(
            f"Выполняю задачу {task_broker.uuid} ({task_broker.name}), приоритет: {task_broker.priority}"
        )
        new_data = await self._plugin_trigger(
            "worker_run_task_before",
            worker=self,
            task_func=task_func,
            task_broker=task_broker,
            return_last=True
        )
        if new_data:
            task_func = new_data.get("task_func", task_func)
            task_broker = new_data.get("task_broker", task_broker)

        if self.task_middlewares_before:
            task_func.add_middlewares_before(self.task_middlewares_before)
        if self.task_middlewares_after:
            task_func.add_middlewares_after(self.task_middlewares_after)

        executor = task_func.executor if task_func.executor is not None else self.task_executor
        executor = executor(
            task_func=task_func,
            task_broker=task_broker,
            log=self.log,
            plugins=self.plugins,
        )

        try:
            result = await executor.execute()
            return await self._task_success(result, task_func, task_broker)
        except TaskCancelError as e:
            return await self._task_cancel(e, task_func, task_broker)
        except BaseException as e:
            return await self._task_error(e, task_func, task_broker)

    async def _task_success(self, result: Any, task_func: TaskExecSchema, task_broker: TaskPrioritySchema) -> None:
        """Событие успешного завершения задачи."""
        model = TaskStatusSuccessSchema(
            task_name=task_func.name,
            priority=task_func.priority,
            returning=result,
            created_at=task_broker.created_at,
            updated_at=time(),
            args=task_broker.args,
            kwargs=task_broker.kwargs,
        )
        self.log.info(
            f"Задача {task_broker.uuid} успешно завершена, результат: {result}"
        )
        return model

    async def _task_error(self, e, task_func: TaskExecSchema, task_broker: TaskPrioritySchema) -> None:
        """Событие завершения задачи с ошибкой."""
        trace = traceback.format_exc()

        # plugin: retry
        plugin_result = None

        should_retry = (
            task_func.retry and (
                not task_func.retry_on_exc or type(e) in task_func.retry_on_exc
            )
        )
        if should_retry and task_func.retry:
                plugin_result = await self._plugin_trigger(
                    "worker_task_error_retry",
                    broker=self.broker,
                    task_func=task_func,
                    task_broker=task_broker,
                    trace=trace,
                )

        if not plugin_result:
            model = TaskStatusErrorSchema(
                task_name=task_func.name,
                priority=task_func.priority,
                traceback=trace,
                created_at=task_broker.created_at,
                updated_at=time(),
                args=task_broker.args,
                kwargs=task_broker.kwargs,
            )
        else:
            model: TaskStatusErrorSchema = plugin_result.get("model", model)

        if plugin_result and model.retry != 0:
            self.log.error(f"Задача {task_broker.uuid} завершена с ошибкой и будет повторена.")
        else:
            self.log.error(f"Задача {task_broker.uuid} завершена с ошибкой:\n{trace}")
        return model

    async def _task_cancel(self, e, task_func: TaskExecSchema, task_broker: TaskPrioritySchema) -> None:
        """Событие отмены задачи."""
        model = TaskStatusCancelSchema(
            task_name=task_func.name,
            priority=task_func.priority,
            cancel_reason=str(e),
            created_at=task_broker.created_at,
            updated_at=time(),
        )
        self.log.info(f"Задача {task_broker.uuid} была отменена по причине: {e}")
        return model

    async def _task_exists(
        self, task_broker: TaskPrioritySchema
    ) -> Union[TaskExecSchema, None]:
        """Проверка существования задачи.

        Args:
            task_broker (TaskPrioritySchema): Схема `TaskPrioritySchema`.

        Returns:
            TaskExecSchema|None: Схема `TaskExecSchema` или `None`.
        """
        try:
            return self._tasks[task_broker.name]
        except KeyError as e:
            self.log.warning(f"Задачи {e.args[0]} не существует!")
            trace = traceback.format_exc()
            model = TaskStatusErrorSchema(
                task_name=task_broker.name,
                priority=task_broker.priority,
                traceback=trace,
                created_at=task_broker.created_at,
                updated_at=time(),
            )
            await self.remove_finished_task(task_func=None, task_broker=task_broker, model=model)
            self.log.error(f"Задача {task_broker.name} завершена с ошибкой:\n{trace}")
            return None

    async def remove_finished_task(
        self,
        task_func: Annotated[
            Optional[TaskExecSchema],
            Doc(
                """
                    Схема функции задачи.
                    """
            )
        ],
        task_broker: Annotated[
            TaskPrioritySchema,
            Doc(
                """
                    Схема приоритетной задачи.
                    """
            ),
        ],
        model: Annotated[
            Union[
                TaskStatusProcessSchema, TaskStatusErrorSchema, TaskStatusCancelSchema
            ],
            Doc(
                """
                    Модель результата задачи.
                    """
            ),
        ],
    ) -> None:
        """Обновляет данные хранилища через функцию `self.storage.remove_finished_task`.

        Args:
            task_func (TaskExecSchema, optional): Схема функции задачи. По умолчанию: `None`.
            task_broker (TaskPrioritySchema): Схема приоритетной задачи.
            model (TaskStatusNewSchema | TaskStatusErrorSchema | TaskStatusCancelSchema): Модель результата задачи.
        """
        new_data = await self._plugin_trigger(
            "worker_remove_finished_task",
            worker=self,
            broker=self.broker,
            task_func=task_func,
            task_broker=task_broker,
            model=model,
            return_last=True
        )
        if new_data:
            task_broker, model = new_data.get("task_broker", task_broker), new_data.get("model", model)
        await self.broker.remove_finished_task(task_broker, model)

    def init_plugins(self):
        """Инициализация плагинов."""
        self.add_plugin(AsyncRetryPlugin(), trigger_names=["worker_task_error_retry"])
        self.add_plugin(AsyncPydanticWrapperPlugin(), trigger_names=["task_executor_args_replace", "task_executor_after_execute_result_replace"])
        self.add_plugin(AsyncDependsPlugin(), trigger_names=["task_executor_args_replace"])
        self.add_plugin(AsyncStatePlugin(), trigger_names=["task_executor_args_replace"])

__init__(name='QueueTasks', broker=None, log=None, config=None, events=None)

Инициализация асинхронного воркера.

Parameters:

Name Type Description Default
name str

Имя проекта. По умолчанию: "QueueTasks".

'QueueTasks'
broker BaseBroker

Брокер. По умолчанию: None.

None
log Logger

Логгер. По умолчанию: None.

None
config QueueConfig

Конфиг. По умолчанию: None.

None
events BaseEvents

События. По умолчанию: qtasks.events.AsyncEvents.

None
Source code in src/qtasks/workers/async_worker.py
 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
def __init__(
    self,
    name: Annotated[
        str,
        Doc(
            """
                Имя проекта. Это имя также используется воркером.

                По умолчанию: `QueueTasks`.
                """
        ),
    ] = "QueueTasks",
    broker: Annotated[
        Optional["BaseBroker"],
        Doc(
            """
                Брокер.

                По умолчанию: `qtasks.brokers.AsyncRedisBroker`.
                """
        ),
    ] = None,
    log: Annotated[
        Optional[Logger],
        Doc(
            """
                Логгер.

                По умолчанию: `qtasks.logs.Logger`.
                """
        ),
    ] = None,
    config: Annotated[
        Optional[QueueConfig],
        Doc(
            """
                Конфиг.

                По умолчанию: `qtasks.configs.config.QueueConfig`.
                """
        ),
    ] = None,
    events: Annotated[
        Optional["BaseEvents"],
        Doc(
            """
                События.

                По умолчанию: `qtasks.events.AsyncEvents`.
                """
        ),
    ] = None,
):
    """Инициализация асинхронного воркера.

    Args:
        name (str, optional): Имя проекта. По умолчанию: "QueueTasks".
        broker (BaseBroker, optional): Брокер. По умолчанию: `None`.
        log (Logger, optional): Логгер. По умолчанию: `None`.
        config (QueueConfig, optional): Конфиг. По умолчанию: `None`.
        events (BaseEvents, optional): События. По умолчанию: `qtasks.events.AsyncEvents`.
    """
    super().__init__(name=name, broker=broker, log=log, config=config, events=events)
    self.events = self.events or AsyncEvents()
    self.broker = broker or AsyncRedisBroker(
        name=self.name, log=self.log, config=self.config
    )
    self.queue = asyncio.PriorityQueue()

    self._tasks: Dict[str, TaskExecSchema] = {}
    self._stop_event: Optional[asyncio.Event] = None
    self.semaphore = asyncio.Semaphore(self.config.max_tasks_process)
    self.condition: Optional[asyncio.Condition] = None

    self.task_executor = AsyncTaskExecutor

add(name, uuid, priority, created_at, args, kwargs) async

Добавление задачи в очередь.

Parameters:

Name Type Description Default
name str

Имя задачи.

required
uuid UUID

UUID задачи.

required
priority int

Приоритет задачи.

required
created_at float

Создание задачи в формате timestamp.

required
args tuple

Аргументы задачи типа args.

required
kwargs dict

Аргументы задачи типа kwargs.

required
Source code in src/qtasks/workers/async_worker.py
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
async def add(
    self,
    name: Annotated[
        str,
        Doc(
            """
                Имя задачи.
                """
        ),
    ],
    uuid: Annotated[
        UUID,
        Doc(
            """
                UUID задачи.
                """
        ),
    ],
    priority: Annotated[
        int,
        Doc(
            """
                Приоритет задачи.
                """
        ),
    ],
    created_at: Annotated[
        float,
        Doc(
            """
                Создание задачи в формате timestamp.
                """
        ),
    ],
    args: Annotated[
        tuple,
        Doc(
            """
                Аргументы задачи типа args.
                """
        ),
    ],
    kwargs: Annotated[
        dict,
        Doc(
            """
                Аргументы задачи типа kwargs.
                """
        ),
    ],
) -> Task:
    """Добавление задачи в очередь.

    Args:
        name (str): Имя задачи.
        uuid (UUID): UUID задачи.
        priority (int): Приоритет задачи.
        created_at (float): Создание задачи в формате timestamp.
        args (tuple): Аргументы задачи типа args.
        kwargs (dict): Аргументы задачи типа kwargs.
    """
    new_data = await self._plugin_trigger(
        "worker_add",
        worker=self,
        task_name=name,
        uuid=uuid,
        priority=priority,
        args=args,
        kw=kwargs,
        created_at=created_at,
        return_last=True
    )
    if new_data:
        name = new_data.get("name", name)
        uuid = new_data.get("uuid", uuid)
        priority = new_data.get("priority", priority)
        args = new_data.get("args", args)
        kwargs = new_data.get("kw", kwargs)
        created_at = new_data.get("created_at", created_at)

    model = TaskPrioritySchema(
        priority=priority,
        uuid=uuid,
        name=name,
        args=list(args),
        kwargs=kwargs,
        created_at=created_at,
        updated_at=created_at,
    )
    async with self.condition:
        await self.queue.put(model)
        self.condition.notify_all()
    return Task(
        status=TaskStatusEnum.NEW.value,
        task_name=name,
        uuid=uuid,
        priority=priority,
        args=args,
        kwargs=kwargs,
        created_at=created_at,
        updated_at=created_at,
    )

init_plugins()

Инициализация плагинов.

Source code in src/qtasks/workers/async_worker.py
578
579
580
581
582
583
def init_plugins(self):
    """Инициализация плагинов."""
    self.add_plugin(AsyncRetryPlugin(), trigger_names=["worker_task_error_retry"])
    self.add_plugin(AsyncPydanticWrapperPlugin(), trigger_names=["task_executor_args_replace", "task_executor_after_execute_result_replace"])
    self.add_plugin(AsyncDependsPlugin(), trigger_names=["task_executor_args_replace"])
    self.add_plugin(AsyncStatePlugin(), trigger_names=["task_executor_args_replace"])

remove_finished_task(task_func, task_broker, model) async

Обновляет данные хранилища через функцию self.storage.remove_finished_task.

Parameters:

Name Type Description Default
task_func TaskExecSchema

Схема функции задачи. По умолчанию: None.

required
task_broker TaskPrioritySchema

Схема приоритетной задачи.

required
model TaskStatusNewSchema | TaskStatusErrorSchema | TaskStatusCancelSchema

Модель результата задачи.

required
Source code in src/qtasks/workers/async_worker.py
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
async def remove_finished_task(
    self,
    task_func: Annotated[
        Optional[TaskExecSchema],
        Doc(
            """
                Схема функции задачи.
                """
        )
    ],
    task_broker: Annotated[
        TaskPrioritySchema,
        Doc(
            """
                Схема приоритетной задачи.
                """
        ),
    ],
    model: Annotated[
        Union[
            TaskStatusProcessSchema, TaskStatusErrorSchema, TaskStatusCancelSchema
        ],
        Doc(
            """
                Модель результата задачи.
                """
        ),
    ],
) -> None:
    """Обновляет данные хранилища через функцию `self.storage.remove_finished_task`.

    Args:
        task_func (TaskExecSchema, optional): Схема функции задачи. По умолчанию: `None`.
        task_broker (TaskPrioritySchema): Схема приоритетной задачи.
        model (TaskStatusNewSchema | TaskStatusErrorSchema | TaskStatusCancelSchema): Модель результата задачи.
    """
    new_data = await self._plugin_trigger(
        "worker_remove_finished_task",
        worker=self,
        broker=self.broker,
        task_func=task_func,
        task_broker=task_broker,
        model=model,
        return_last=True
    )
    if new_data:
        task_broker, model = new_data.get("task_broker", task_broker), new_data.get("model", model)
    await self.broker.remove_finished_task(task_broker, model)

start(num_workers=4) async

Запускает несколько обработчиков задач.

Parameters:

Name Type Description Default
num_workers int

Количество воркеров. По умолчанию: 4.

4
Source code in src/qtasks/workers/async_worker.py
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
async def start(
    self,
    num_workers: Annotated[
        int,
        Doc(
            """
                Количество воркеров.

                По умолчанию: `4`.
                """
        ),
    ] = 4,
) -> None:
    """Запускает несколько обработчиков задач.

    Args:
        num_workers (int, optional): Количество воркеров. По умолчанию: 4.
    """
    self.num_workers = num_workers

    if self.condition is None:
        self.condition = asyncio.Condition()
    if self._stop_event is None:
        self._stop_event = asyncio.Event()
    await self._plugin_trigger("worker_start", worker=self)

    # Запускаем несколько воркеров
    loop = asyncio.get_event_loop()
    workers = [
        loop.create_task(self.worker(number))
        for number in range(self.num_workers)
    ]
    await self._stop_event.wait()  # Ожидание сигнала остановки

    # Ожидаем завершения всех воркеров
    for worker_task in workers:
        worker_task.cancel()
    await asyncio.gather(*workers, return_exceptions=True)

stop() async

Останавливает воркеры.

Source code in src/qtasks/workers/async_worker.py
363
364
365
366
async def stop(self):
    """Останавливает воркеры."""
    await self._plugin_trigger("worker_stop", worker=self)
    self._stop_event.set()

update_config(config)

Обновляет конфиг брокера и семафору.

Parameters:

Name Type Description Default
config QueueConfig

Конфиг.

required
Source code in src/qtasks/workers/async_worker.py
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
def update_config(
    self,
    config: Annotated[
        QueueConfig,
        Doc(
            """
                Конфиг.
                """
        ),
    ],
) -> None:
    """Обновляет конфиг брокера и семафору.

    Args:
        config (QueueConfig): Конфиг.
    """
    self.config = config
    self.semaphore = Semaphore(config.max_tasks_process)

worker(number) async

Обработчик задач.

Parameters:

Name Type Description Default
number int

Номер Воркера.

required
Source code in src/qtasks/workers/async_worker.py
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
async def worker(
    self,
    number: Annotated[
        int,
        Doc(
            """
                Номер Воркера.
                """
        ),
    ],
) -> None:
    """Обработчик задач.

    Args:
        number (int): Номер Воркера.
    """
    await self.events.fire("worker_running", worker=self, number=number)

    try:
        while not self._stop_event.is_set():
            async with self.condition:
                while self.queue.empty():
                    await self.condition.wait()

            task_broker: Union[TaskPrioritySchema, None] = await self.queue.get()
            if task_broker is None:
                break
            asyncio.create_task(self._execute_task(task_broker))
    finally:
        await self.events.fire("worker_stopping", worker=self, number=number)