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

AsyncRedisBroker

Async Redis Broker.

AsyncRedisBroker

Bases: BaseBroker, AsyncPluginMixin

Брокер, слушающий Redis и добавляющий задачи в очередь.

Пример

from qtasks import QueueTasks
from qtasks.brokers import AsyncRedisBroker

broker = AsyncRedisBroker(name="QueueTasks", url="redis://localhost:6379/2")

app = QueueTasks(broker=broker)
Source code in src/qtasks/brokers/async_redis.py 
 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
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
class AsyncRedisBroker(BaseBroker, AsyncPluginMixin):
    """
    Брокер, слушающий Redis и добавляющий задачи в очередь.

    ## Пример

    ```python
    from qtasks import QueueTasks
    from qtasks.brokers import AsyncRedisBroker

    broker = AsyncRedisBroker(name="QueueTasks", url="redis://localhost:6379/2")

    app = QueueTasks(broker=broker)
    ```
    """

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

                    По умолчанию: `QueueTasks`.
                    """
            ),
        ] = "QueueTasks",
        url: Annotated[
            str,
            Doc(
                """
                    URL для подключения к Redis.

                    По умолчанию: `redis://localhost:6379/0`.
                    """
            ),
        ] = None,
        storage: Annotated[
            Optional["BaseStorage"],
            Doc(
                """
                    Хранилище.

                    По умолчанию: `AsyncRedisStorage`.
                    """
            ),
        ] = None,
        queue_name: Annotated[
            str,
            Doc(
                """
                    Имя массива очереди задач для Redis. Название обновляется на: `name:queue_name`.

                    По умолчанию: `task_queue`.
                    """
            ),
        ] = "task_queue",
        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,
    ):
        """Инициализация AsyncRedisBroker.

        Args:
            name (str, optional): Имя проекта. По умолчанию: "QueueTasks".
            url (str, optional): URL для подключения к Redis. По умолчанию: None.
            storage (BaseStorage, optional): Хранилище. По умолчанию: None.
            queue_name (str, optional): Имя массива очереди задач для Redis. По умолчанию: "task_queue".
            log (Logger, optional): Логгер. По умолчанию: None.
            config (QueueConfig, optional): Конфиг. По умолчанию: None.
            events (BaseEvents, optional): События. По умолчанию: `qtasks.events.AsyncEvents`.
        """
        super().__init__(name=name, log=log, config=config, events=events)
        self.url = url or "redis://localhost:6379/0"
        self.queue_name = f"{self.name}:{queue_name}"
        self.events = self.events or AsyncEvents()

        self.client = aioredis.ConnectionPool.from_url(
            self.url, decode_responses=True, encoding="utf-8"
        )
        self.client = aioredis.Redis.from_pool(self.client)
        self.storage = storage or AsyncRedisStorage(
            name=name,
            url=self.url,
            redis_connect=self.client,
            log=self.log,
            config=self.config,
        )
        self.running = False
        self.default_sleep = 0.01

    async def listen(
        self,
        worker: Annotated[
            "BaseWorker",
            Doc(
                """
                    Класс воркера.
                    """
            ),
        ],
    ):
        """Слушает очередь Redis и передаёт задачи воркеру.

        Args:
            worker (BaseWorker): Класс воркера.
        """
        await self._plugin_trigger("broker_listen_start", broker=self, worker=worker)
        self.running = True

        while self.running:
            task_data = await self.client.lpop(self.queue_name)
            if not task_data:
                await asyncio.sleep(self.default_sleep)
                continue

            task_name, uuid, priority = task_data.split(":")

            await self.storage.add_process(task_data, priority)

            model_get = await self.get(uuid=uuid)
            args, kwargs, created_at = (
                model_get.args or (),
                model_get.kwargs or {},
                model_get.created_at.timestamp(),
            )
            self.log.info(f"Получена новая задача: {uuid}")
            new_args = await self._plugin_trigger(
                "broker_add_worker",
                broker=self,
                worker=worker,

                task_name=task_name,
                uuid=uuid,
                priority=int(priority),
                args=args,
                kw=kwargs,
                created_at=created_at,
                return_last=True
            )
            if new_args:
                task_name = new_args.get("task_name", task_name)
                uuid = new_args.get("uuid", uuid)
                priority = new_args.get("priority", priority)
                args = new_args.get("args", args)
                kwargs = new_args.get("kw", kwargs)
                created_at = new_args.get("created_at", created_at)
            await worker.add(
                name=task_name,
                uuid=uuid,
                priority=int(priority),
                args=args,
                kwargs=kwargs,
                created_at=created_at,
            )

    async def add(
        self,
        task_name: Annotated[
            str,
            Doc(
                """
                    Имя задачи.
                    """
            ),
        ],
        priority: Annotated[
            int,
            Doc(
                """
                    Приоритет задачи.

                    По умолчанию: `0`.
                    """
            ),
        ] = 0,
        extra: dict = None,
        args: Annotated[
            tuple,
            Doc(
                """
                    Аргументы задачи типа args.
                    """
            ),
        ] = None,
        kwargs: Annotated[
            dict,
            Doc(
                """
                    Аргументы задачи типа kwargs.
                    """
            ),
        ] = None,
    ) -> Task:
        """Добавляет задачу в брокер.

        Args:
            task_name (str): Имя задачи.
            priority (int, optional): Приоритет задачи. По умоланию: 0.
            extra (dict, optional): Дополнительные параметры задачи.
            args (tuple, optional): Аргументы задачи типа args.
            kwargs (dict, optional): Аргументы задачи типа kwargs.

        Returns:
            Task: `schemas.task.Task`
        """
        loop = asyncio.get_running_loop()
        asyncio_atexit.register(self.stop, loop=loop)
        asyncio_atexit.register(self.storage.stop, loop=loop)

        args, kwargs = args or (), kwargs or {}
        uuid = str(uuid4())
        created_at = time()
        model = TaskStatusNewSchema(
            task_name=task_name,
            priority=priority,
            created_at=created_at,
            updated_at=created_at,
            args=args,
            kwargs=kwargs
        )

        if extra:
            model = self._dynamic_model(model=model, extra=extra)

        new_model = await self._plugin_trigger(
            "broker_add_before",
            broker=self,
            storage=self.storage,
            model=model
        )
        if new_model:
            model = new_model

        await self.storage.add(uuid=uuid, task_status=model)
        await self.client.rpush(self.queue_name, f"{task_name}:{uuid}:{priority}")

        await self._plugin_trigger(
            "broker_add_after",
            broker=self,
            storage=self.storage,
            model=model
        )
        return Task(
            status=TaskStatusEnum.NEW.value,
            task_name=task_name,
            uuid=uuid,
            priority=priority,
            args=args,
            kwargs=kwargs,
            created_at=created_at,
            updated_at=created_at,
        )

    async def get(
        self,
        uuid: Annotated[
            Union[UUID, str],
            Doc(
                """
                    UUID задачи.
                    """
            ),
        ],
    ) -> Union[Task, None]:
        """Получение информации о задаче.

        Args:
            uuid (UUID|str): UUID задачи.

        Returns:
            Task|None: Если есть информация о задаче, возвращает `schemas.task.Task`, иначе `None`.
        """
        if isinstance(uuid, str):
            uuid = UUID(uuid)
        task = await self.storage.get(uuid=uuid)
        new_task = await self._plugin_trigger("broker_get", broker=self, task=task, return_last=True)
        if new_task:
            task = new_task.get("task", task)
        return task

    async def update(
        self,
        **kwargs: Annotated[
            dict,
            Doc(
                """
                    Аргументы обновления для хранилища типа kwargs.
                    """
            ),
        ],
    ) -> None:
        """Обновляет информацию о задаче.

        Args:
            kwargs (dict, optional): данные задачи типа kwargs.
        """
        new_kw = await self._plugin_trigger("broker_update", broker=self, kw=kwargs, return_last=True)
        if new_kw:
            kwargs = new_kw.get("kw", kwargs)
        return await self.storage.update(**kwargs)

    async def start(
        self,
        worker: Annotated[
            "BaseWorker",
            Doc(
                """
                    Класс Воркера.
                    """
            ),
        ],
    ) -> None:
        """Запускает брокер.

        Args:
            worker (BaseWorker): Класс Воркера.
        """
        await self._plugin_trigger("broker_start", broker=self, worker=worker)
        await self.storage.start()

        if self.config.delete_finished_tasks:
            await self.storage._delete_finished_tasks()

        if self.config.running_older_tasks:
            await self.storage._running_older_tasks(worker)

        await self.listen(worker)

    async def stop(self):
        """Останавливает брокер."""
        await self._plugin_trigger("broker_stop", broker=self)
        self.running = False
        await self.client.aclose()

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

        Args:
            task_broker (TaskPrioritySchema): Схема приоритетной задачи.
            model (TaskStatusNewSchema | TaskStatusErrorSchema): Модель результата задачи.
        """
        new_model = await self._plugin_trigger(
            "broker_remove_finished_task",
            broker=self,
            storage=self.storage,
            model=model,
            return_last=True
        )
        if new_model:
            model = new_model.get("model", model)

        await self.storage.remove_finished_task(task_broker, model)
        return

    async def _running_older_tasks(self, worker):
        await self._plugin_trigger("broker_running_older_tasks", broker=self, worker=worker)
        return await self.storage._running_older_tasks(worker)

    async def flush_all(self) -> None:
        """Удалить все данные."""
        await self._plugin_trigger("broker_flush_all", broker=self)
        await self.storage.flush_all()

__init__(name='QueueTasks', url=None, storage=None, queue_name='task_queue', log=None, config=None, events=None)

Инициализация AsyncRedisBroker.

Parameters:

Name Type Description Default
name str

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

 'QueueTasks'
url str

URL для подключения к Redis. По умолчанию: None.

 None
storage BaseStorage

Хранилище. По умолчанию: None.

 None
queue_name str

Имя массива очереди задач для Redis. По умолчанию: "task_queue".

 'task_queue'
log Logger

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

 None
config QueueConfig

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

 None
events BaseEvents

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

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

                По умолчанию: `QueueTasks`.
                """
        ),
    ] = "QueueTasks",
    url: Annotated[
        str,
        Doc(
            """
                URL для подключения к Redis.

                По умолчанию: `redis://localhost:6379/0`.
                """
        ),
    ] = None,
    storage: Annotated[
        Optional["BaseStorage"],
        Doc(
            """
                Хранилище.

                По умолчанию: `AsyncRedisStorage`.
                """
        ),
    ] = None,
    queue_name: Annotated[
        str,
        Doc(
            """
                Имя массива очереди задач для Redis. Название обновляется на: `name:queue_name`.

                По умолчанию: `task_queue`.
                """
        ),
    ] = "task_queue",
    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,
):
    """Инициализация AsyncRedisBroker.

    Args:
        name (str, optional): Имя проекта. По умолчанию: "QueueTasks".
        url (str, optional): URL для подключения к Redis. По умолчанию: None.
        storage (BaseStorage, optional): Хранилище. По умолчанию: None.
        queue_name (str, optional): Имя массива очереди задач для Redis. По умолчанию: "task_queue".
        log (Logger, optional): Логгер. По умолчанию: None.
        config (QueueConfig, optional): Конфиг. По умолчанию: None.
        events (BaseEvents, optional): События. По умолчанию: `qtasks.events.AsyncEvents`.
    """
    super().__init__(name=name, log=log, config=config, events=events)
    self.url = url or "redis://localhost:6379/0"
    self.queue_name = f"{self.name}:{queue_name}"
    self.events = self.events or AsyncEvents()

    self.client = aioredis.ConnectionPool.from_url(
        self.url, decode_responses=True, encoding="utf-8"
    )
    self.client = aioredis.Redis.from_pool(self.client)
    self.storage = storage or AsyncRedisStorage(
        name=name,
        url=self.url,
        redis_connect=self.client,
        log=self.log,
        config=self.config,
    )
    self.running = False
    self.default_sleep = 0.01

add(task_name, priority=0, extra=None, args=None, kwargs=None) async

Добавляет задачу в брокер.

Parameters:

Name Type Description Default
task_name str

Имя задачи.

 required
priority int

Приоритет задачи. По умоланию: 0.

 0
extra dict

Дополнительные параметры задачи.

 None
args tuple

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

 None
kwargs dict

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

 None

Returns:

Name Type Description
Task Task

schemas.task.Task
Source code in src/qtasks/brokers/async_redis.py 
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
async def add(
    self,
    task_name: Annotated[
        str,
        Doc(
            """
                Имя задачи.
                """
        ),
    ],
    priority: Annotated[
        int,
        Doc(
            """
                Приоритет задачи.

                По умолчанию: `0`.
                """
        ),
    ] = 0,
    extra: dict = None,
    args: Annotated[
        tuple,
        Doc(
            """
                Аргументы задачи типа args.
                """
        ),
    ] = None,
    kwargs: Annotated[
        dict,
        Doc(
            """
                Аргументы задачи типа kwargs.
                """
        ),
    ] = None,
) -> Task:
    """Добавляет задачу в брокер.

    Args:
        task_name (str): Имя задачи.
        priority (int, optional): Приоритет задачи. По умоланию: 0.
        extra (dict, optional): Дополнительные параметры задачи.
        args (tuple, optional): Аргументы задачи типа args.
        kwargs (dict, optional): Аргументы задачи типа kwargs.

    Returns:
        Task: `schemas.task.Task`
    """
    loop = asyncio.get_running_loop()
    asyncio_atexit.register(self.stop, loop=loop)
    asyncio_atexit.register(self.storage.stop, loop=loop)

    args, kwargs = args or (), kwargs or {}
    uuid = str(uuid4())
    created_at = time()
    model = TaskStatusNewSchema(
        task_name=task_name,
        priority=priority,
        created_at=created_at,
        updated_at=created_at,
        args=args,
        kwargs=kwargs
    )

    if extra:
        model = self._dynamic_model(model=model, extra=extra)

    new_model = await self._plugin_trigger(
        "broker_add_before",
        broker=self,
        storage=self.storage,
        model=model
    )
    if new_model:
        model = new_model

    await self.storage.add(uuid=uuid, task_status=model)
    await self.client.rpush(self.queue_name, f"{task_name}:{uuid}:{priority}")

    await self._plugin_trigger(
        "broker_add_after",
        broker=self,
        storage=self.storage,
        model=model
    )
    return Task(
        status=TaskStatusEnum.NEW.value,
        task_name=task_name,
        uuid=uuid,
        priority=priority,
        args=args,
        kwargs=kwargs,
        created_at=created_at,
        updated_at=created_at,
    )

flush_all() async

Удалить все данные.

Source code in src/qtasks/brokers/async_redis.py 
442
443
444
445
async def flush_all(self) -> None:
    """Удалить все данные."""
    await self._plugin_trigger("broker_flush_all", broker=self)
    await self.storage.flush_all()

get(uuid) async

Получение информации о задаче.

Parameters:

Name Type Description Default
uuid UUID | str

UUID задачи.

 required

Returns:

Type Description
Union[Task, None]

Task|None: Если есть информация о задаче, возвращает schemas.task.Task, иначе None.
Source code in src/qtasks/brokers/async_redis.py 
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
async def get(
    self,
    uuid: Annotated[
        Union[UUID, str],
        Doc(
            """
                UUID задачи.
                """
        ),
    ],
) -> Union[Task, None]:
    """Получение информации о задаче.

    Args:
        uuid (UUID|str): UUID задачи.

    Returns:
        Task|None: Если есть информация о задаче, возвращает `schemas.task.Task`, иначе `None`.
    """
    if isinstance(uuid, str):
        uuid = UUID(uuid)
    task = await self.storage.get(uuid=uuid)
    new_task = await self._plugin_trigger("broker_get", broker=self, task=task, return_last=True)
    if new_task:
        task = new_task.get("task", task)
    return task

listen(worker) async

Слушает очередь Redis и передаёт задачи воркеру.

Parameters:

Name Type Description Default
worker BaseWorker

Класс воркера.

 required
Source code in src/qtasks/brokers/async_redis.py 
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
async def listen(
    self,
    worker: Annotated[
        "BaseWorker",
        Doc(
            """
                Класс воркера.
                """
        ),
    ],
):
    """Слушает очередь Redis и передаёт задачи воркеру.

    Args:
        worker (BaseWorker): Класс воркера.
    """
    await self._plugin_trigger("broker_listen_start", broker=self, worker=worker)
    self.running = True

    while self.running:
        task_data = await self.client.lpop(self.queue_name)
        if not task_data:
            await asyncio.sleep(self.default_sleep)
            continue

        task_name, uuid, priority = task_data.split(":")

        await self.storage.add_process(task_data, priority)

        model_get = await self.get(uuid=uuid)
        args, kwargs, created_at = (
            model_get.args or (),
            model_get.kwargs or {},
            model_get.created_at.timestamp(),
        )
        self.log.info(f"Получена новая задача: {uuid}")
        new_args = await self._plugin_trigger(
            "broker_add_worker",
            broker=self,
            worker=worker,

            task_name=task_name,
            uuid=uuid,
            priority=int(priority),
            args=args,
            kw=kwargs,
            created_at=created_at,
            return_last=True
        )
        if new_args:
            task_name = new_args.get("task_name", task_name)
            uuid = new_args.get("uuid", uuid)
            priority = new_args.get("priority", priority)
            args = new_args.get("args", args)
            kwargs = new_args.get("kw", kwargs)
            created_at = new_args.get("created_at", created_at)
        await worker.add(
            name=task_name,
            uuid=uuid,
            priority=int(priority),
            args=args,
            kwargs=kwargs,
            created_at=created_at,
        )

remove_finished_task(task_broker, model) async

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

Parameters:

Name Type Description Default
task_broker TaskPrioritySchema

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

 required
model TaskStatusNewSchema | TaskStatusErrorSchema

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

 required
Source code in src/qtasks/brokers/async_redis.py 
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
async def remove_finished_task(
    self,
    task_broker: Annotated[
        TaskPrioritySchema,
        Doc(
            """
                Схема приоритетной задачи.
                """
        ),
    ],
    model: Annotated[
        Union[
            TaskStatusProcessSchema, TaskStatusErrorSchema, TaskStatusCancelSchema
        ],
        Doc(
            """
                Модель результата задачи.
                """
        ),
    ],
) -> None:
    """Обновляет данные хранилища через функцию `self.storage.remove_finished_task`.

    Args:
        task_broker (TaskPrioritySchema): Схема приоритетной задачи.
        model (TaskStatusNewSchema | TaskStatusErrorSchema): Модель результата задачи.
    """
    new_model = await self._plugin_trigger(
        "broker_remove_finished_task",
        broker=self,
        storage=self.storage,
        model=model,
        return_last=True
    )
    if new_model:
        model = new_model.get("model", model)

    await self.storage.remove_finished_task(task_broker, model)
    return

start(worker) async

Запускает брокер.

Parameters:

Name Type Description Default
worker BaseWorker

Класс Воркера.

 required
Source code in src/qtasks/brokers/async_redis.py 
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
async def start(
    self,
    worker: Annotated[
        "BaseWorker",
        Doc(
            """
                Класс Воркера.
                """
        ),
    ],
) -> None:
    """Запускает брокер.

    Args:
        worker (BaseWorker): Класс Воркера.
    """
    await self._plugin_trigger("broker_start", broker=self, worker=worker)
    await self.storage.start()

    if self.config.delete_finished_tasks:
        await self.storage._delete_finished_tasks()

    if self.config.running_older_tasks:
        await self.storage._running_older_tasks(worker)

    await self.listen(worker)

stop() async

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

Source code in src/qtasks/brokers/async_redis.py 
392
393
394
395
396
async def stop(self):
    """Останавливает брокер."""
    await self._plugin_trigger("broker_stop", broker=self)
    self.running = False
    await self.client.aclose()

update(**kwargs) async

Обновляет информацию о задаче.

Parameters:

Name Type Description Default
kwargs dict

данные задачи типа kwargs.

 {}
Source code in src/qtasks/brokers/async_redis.py 
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
async def update(
    self,
    **kwargs: Annotated[
        dict,
        Doc(
            """
                Аргументы обновления для хранилища типа kwargs.
                """
        ),
    ],
) -> None:
    """Обновляет информацию о задаче.

    Args:
        kwargs (dict, optional): данные задачи типа kwargs.
    """
    new_kw = await self._plugin_trigger("broker_update", broker=self, kw=kwargs, return_last=True)
    if new_kw:
        kwargs = new_kw.get("kw", kwargs)
    return await self.storage.update(**kwargs)