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

QueueTasks sync

qtasks.py - Main module for the QueueTasks framework.

QueueTasks

Bases: BaseQueueTasks, SyncPluginMixin

QueueTasks - Фреймворк для очередей задач.

Читать больше: Первые шаги.

Пример

from qtasks import QueueTasks

app = QueueTasks()
Source code in src/qtasks/qtasks.py 
 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
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
class QueueTasks(BaseQueueTasks, SyncPluginMixin):
    """
    `QueueTasks` - Фреймворк для очередей задач.

    Читать больше:
    [Первые шаги](https://txello.github.io/qtasks/ru/getting_started/).

    ## Пример

    ```python
    from qtasks import QueueTasks

    app = QueueTasks()
    ```
    """

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

                    По умолчанию: `QueueTasks`.
                    """
            ),
        ] = "QueueTasks",
        broker_url: Annotated[
            Optional[str],
            Doc(
                """
                    URL для Брокера. Используется Брокером по умолчанию через параметр url.

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
        broker: Annotated[
            Optional["BaseBroker"],
            Doc(
                """
                    Брокер. Хранит в себе обработку из очередей задач и хранилище данных.

                    По умолчанию: `qtasks.brokers.SyncRedisBroker`.
                    """
            ),
        ] = None,
        worker: Annotated[
            Optional["BaseWorker"],
            Doc(
                """
                    Воркер. Хранит в себе обработку задач.

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

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

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

                    По умолчанию: `qtasks.events.SyncEvents`.
                    """
            ),
        ] = None,
    ):
        """
        Инициализация QueueTasks.

        Args:
            name (str): Имя проекта. По умолчанию: `QueueTasks`.
            broker_url (str, optional): URL для Брокера. Используется Брокером по умолчанию через параметр url. По умолчанию: `None`.
            broker (Type[BaseBroker], optional): Брокер. Хранит в себе обработку из очередей задач и хранилище данных. По умолчанию: `qtasks.brokers.AsyncRedisBroker`.
            worker (Type[BaseWorker], optional): Воркер. Хранит в себе обработку задач. По умолчанию: `qtasks.workers.AsyncWorker`.
            log (Logger, optional): Логгер. По умолчанию: `qtasks.logs.Logger`.
            config (QueueConfig, optional): Конфиг. По умолчанию: `qtasks.configs.QueueConfig`.
            events (BaseEvents, optional): События. По умолчанию: `qtasks.events.SyncEvents`.
        """
        super().__init__(
            name=name, broker=broker, worker=worker, log=log, config=config, events=events
        )
        self._method = "sync"
        self.events = self.events or SyncEvents()

        self.broker: "BaseBroker" = broker or SyncRedisBroker(
            name=name, url=broker_url, log=self.log, config=self.config, events=self.events
        )
        self.worker: "BaseWorker" = worker or SyncThreadWorker(
            name=name, broker=self.broker, log=self.log, config=self.config, events=self.events
        )
        self.starter: Union["BaseStarter", None] = None

        self._registry_tasks()

        self._set_state()

        self.init_plugins()

    def add_task(
        self,
        *args: Annotated[
            Optional[tuple],
            Doc(
                """
                    args задачи.

                    По умолчанию: `()`.
                    """
            ),
        ],
        task_name: Annotated[
            str,
            Doc(
                """
                    Имя задачи.
                    """
            ),
        ],
        priority: Annotated[
            Optional[int],
            Doc(
                """
                    Приоритет у задачи.

                    По умолчанию: Значение приоритета у задачи.
                    """
            ),
        ] = None,
        timeout: Annotated[
            Optional[float],
            Doc(
                """
                    Таймаут задачи.

                    Если указан, задача возвращается через `qtasks.results.AsyncTask`.
                    """
            ),
        ] = None,
        **kwargs: Annotated[
            Optional[dict],
            Doc(
                """
                    kwargs задачи.

                    По умолчанию: `{}`.
                    """
            ),
        ],
    ) -> Union["Task", None]:
        """Добавить задачу.

        Args:
            task_name (str): Имя задачи.
            priority (int, optional): Приоритет задачи. По умолчанию: Значение приоритета у задачи.
            args (tuple, optional): args задачи. По умолчанию `()`.
            kwargs (dict, optional): kwags задачи. По умолчанию `{}`.

            timeout (float, optional): Таймаут задачи. Если указан, задача возвращается через `qtasks.results.SyncResult`.

        Returns:
            Task|None: `schemas.task.Task` или `None`.
        """
        if priority is None:
            priority = self.tasks.get(task_name, 0)
            priority = priority.priority if isinstance(priority, TaskExecSchema) else 0

        args, kwargs = args or (), kwargs or {}
        extra = None

        new_args = self._plugin_trigger(
            "qtasks_add_task_before_broker",
            qtasks=self,
            broker=self.broker,
            task_name=task_name,
            priority=priority,
            args=args,
            kw=kwargs,
            return_last=True
        )
        if new_args:
            task_name = new_args.get("task_name", task_name)
            priority = new_args.get("priority", priority)
            extra = new_args.get("extra", extra)
            args = new_args.get("args", args)
            kwargs = new_args.get("kw", kwargs)

        task = self.broker.add(
            task_name=task_name, priority=priority, extra=extra, args=args, kwargs=kwargs
        )

        self._plugin_trigger(
            "qtasks_add_task_after_broker",
            qtasks=self,
            broker=self.broker,
            task_name=task_name,
            priority=priority,
            args=args,
            kwargs=kwargs,
            return_last=True
        )
        if timeout is not None:
            return SyncResult(uuid=task.uuid, app=self, log=self.log).result(
                timeout=timeout
            )
        return task

    def get(
        self,
        uuid: Annotated[
            Union[UUID, str],
            Doc(
                """
                    UUID задачи.
                    """
            ),
        ],
    ) -> Union["Task", None]:
        """Получить задачу.

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

        Returns:
            Task|None: Данные задачи или None.
        """
        if isinstance(uuid, str):
            uuid = UUID(uuid)
        result = self.broker.get(uuid=uuid)
        new_result = self._plugin_trigger("qtasks_get", qtasks=self, broker=self.broker, task=result, return_last=True)
        if new_result:
            result = new_result.get("task", result)
        return result

    def run_forever(
        self,
        starter: Annotated[
            Optional["BaseStarter"],
            Doc(
                """
                    Обновить Стартер.

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
        num_workers: Annotated[
            int,
            Doc(
                """
                    Количество запущенных воркеров.

                    По умолчанию: `4`.
                    """
            ),
        ] = 4,
        reset_config: Annotated[
            bool,
            Doc(
                """
                    Обновить config у воркера и брокера.

                    По умолчанию: `True`.
                    """
            ),
        ] = True,
    ) -> None:
        """Запуск синхронно Приложение.

        Args:
            starter (BaseStarter, optional): Стартер. По умолчанию: `qtasks.starters.SyncStarter`.
            num_workers (int, optional): Количество запущенных воркеров. По умолчанию: 4.
            reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
        """
        self.starter = starter or SyncStarter(
            name=self.name,
            worker=self.worker,
            broker=self.broker,
            log=self.log,
            config=self.config,
            events=self.events
        )

        plugins_hash = {}
        for plugins in [
            self.plugins,
            self.worker.plugins,
            self.broker.plugins,
            self.broker.storage.plugins,
        ]:
            plugins_hash.update(plugins)

        self._set_state()

        self.starter.start(
            num_workers=num_workers, reset_config=reset_config, plugins=plugins_hash
        )

    def stop(self):
        """Останавливает все компоненты."""
        self._plugin_trigger("qtasks_stop", qtasks=self, starter=self.starter)
        self.starter.stop()

    def ping(self, server: bool = True) -> bool:
        """Проверка запуска сервера.

        Args:
            server (bool, optional): Проверка через сервер. По умолчанию `True`.

        Returns:
            bool: True - Работает, False - Не работает.
        """
        self._plugin_trigger("qtasks_ping", qtasks=self, global_config=self.broker.storage.global_config)
        if server:
            status = self.broker.storage.global_config.get("main", "status")
            return status is not None
        return True

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

    @overload
    def task(
        self,
        name: Union[str, None] = None,
        *,
        priority: Union[int, None] = None,
        echo: bool = False,
        max_time: Union[float, None] = None,
        retry: Union[int, None] = None,
        retry_on_exc: Union[List[Type[Exception]], None] = None,
        decode: Union[Callable, None] = None,
        tags: Union[List[str], None] = None,
        description: Union[str, None] = None,
        generate_handler: Union[Callable, None] = None,
        executor: Union[Type["BaseTaskExecutor"], None] = None,
        middlewares_before: Union[List["TaskMiddleware"], None] = None,
        middlewares_after: Union[List["TaskMiddleware"], None] = None,
        **kwargs
    ) -> Callable[[Callable[P, R]], SyncTask[P, R]]:
        """Декоратор для регистрации задач.

        Args:
            name (str, optional): Имя задачи. По умолчанию: `func.__name__`.
            priority (int, optional): Приоритет у задачи по умолчанию. По умолчанию: `config.default_task_priority`.
            max_time (float, optional): Максимальное время выполнения задачи в секундах. По умолчанию: `None`.
            echo (bool, optional): Добавить SyncTask первым параметром. По умолчанию: `False`.
            retry (int, optional): Количество попыток повторного выполнения задачи. По умолчанию: `None`.
            retry_on_exc (List[Type[Exception]], optional): Исключения, при которых задача будет повторно выполнена. По умолчанию: `None`.
            decode (Callable, optional): Декодер результата задачи. По умолчанию: `None`.
            tags (List[str], optional): Теги задачи. По умолчанию: `None`.
            description (str, optional): Описание задачи. По умолчанию: `None`.
            generate_handler (Callable, optional): Генератор обработчика. По умолчанию: `None`.
            executor (Type["BaseTaskExecutor"], optional): Класс `BaseTaskExecutor`. По умолчанию: `SyncTaskExecutor`.
            middlewares_before (List["TaskMiddleware"], optional): Мидлвари, которые будут выполнены до задачи. По умолчанию: `Пустой массив`.
            middlewares_after (List["TaskMiddleware"], optional): Мидлвари, которые будут выполнены после задачи. По умолчанию: `Пустой массив`.

        Raises:
            ValueError: Если задача с таким именем уже зарегистрирована.
            ValueError: Неизвестный метод {self._method}.

        Returns:
            SyncTask: Декоратор для регистрации задачи.
        """
        ...

    @overload
    def task(
        self,
        func: Callable[P, R],
    ) -> SyncTask[P, R]:
        ...

    def task(self, *args, **kwargs):
        """Декоратор для регистрации задач.

        Args:
            name (str, optional): Имя задачи. По умолчанию: `func.__name__`.
            priority (int, optional): Приоритет у задачи по умолчанию. По умолчанию: `config.default_task_priority`.
            max_time (float, optional): Максимальное время выполнения задачи в секундах. По умолчанию: `None`.
            echo (bool, optional): Добавить SyncTask первым параметром. По умолчанию: `False`.
            retry (int, optional): Количество попыток повторного выполнения задачи. По умолчанию: `None`.
            retry_on_exc (List[Type[Exception]], optional): Исключения, при которых задача будет повторно выполнена. По умолчанию: `None`.
            decode (Callable, optional): Декодер результата задачи. По умолчанию: `None`.
            tags (List[str], optional): Теги задачи. По умолчанию: `None`.
            description (str, optional): Описание задачи. По умолчанию: `None`.
            generate_handler (Callable, optional): Генератор обработчика. По умолчанию: `None`.
            executor (Type["BaseTaskExecutor"], optional): Класс `BaseTaskExecutor`. По умолчанию: `SyncTaskExecutor`.
            middlewares_before (List["TaskMiddleware"], optional): Мидлвари, которые будут выполнены до задачи. По умолчанию: `Пустой массив`.
            middlewares_after (List["TaskMiddleware"], optional): Мидлвари, которые будут выполнены после задачи. По умолчанию: `Пустой массив`.

        Raises:
            ValueError: Если задача с таким именем уже зарегистрирована.
            ValueError: Неизвестный метод {self._method}.

        Returns:
            SyncTask: Декоратор для регистрации задачи.
        """
        return super().task(*args, **kwargs)

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

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

Parameters:

Name Type Description Default
name str

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

 'QueueTasks'
broker_url str

URL для Брокера. Используется Брокером по умолчанию через параметр url. По умолчанию: None.

 None
broker Type[BaseBroker]

Брокер. Хранит в себе обработку из очередей задач и хранилище данных. По умолчанию: qtasks.brokers.AsyncRedisBroker.

 None
worker Type[BaseWorker]

Воркер. Хранит в себе обработку задач. По умолчанию: qtasks.workers.AsyncWorker.

 None
log Logger

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

 None
config QueueConfig

Конфиг. По умолчанию: qtasks.configs.QueueConfig.

 None
events BaseEvents

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

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

                По умолчанию: `QueueTasks`.
                """
        ),
    ] = "QueueTasks",
    broker_url: Annotated[
        Optional[str],
        Doc(
            """
                URL для Брокера. Используется Брокером по умолчанию через параметр url.

                По умолчанию: `None`.
                """
        ),
    ] = None,
    broker: Annotated[
        Optional["BaseBroker"],
        Doc(
            """
                Брокер. Хранит в себе обработку из очередей задач и хранилище данных.

                По умолчанию: `qtasks.brokers.SyncRedisBroker`.
                """
        ),
    ] = None,
    worker: Annotated[
        Optional["BaseWorker"],
        Doc(
            """
                Воркер. Хранит в себе обработку задач.

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

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

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

                По умолчанию: `qtasks.events.SyncEvents`.
                """
        ),
    ] = None,
):
    """
    Инициализация QueueTasks.

    Args:
        name (str): Имя проекта. По умолчанию: `QueueTasks`.
        broker_url (str, optional): URL для Брокера. Используется Брокером по умолчанию через параметр url. По умолчанию: `None`.
        broker (Type[BaseBroker], optional): Брокер. Хранит в себе обработку из очередей задач и хранилище данных. По умолчанию: `qtasks.brokers.AsyncRedisBroker`.
        worker (Type[BaseWorker], optional): Воркер. Хранит в себе обработку задач. По умолчанию: `qtasks.workers.AsyncWorker`.
        log (Logger, optional): Логгер. По умолчанию: `qtasks.logs.Logger`.
        config (QueueConfig, optional): Конфиг. По умолчанию: `qtasks.configs.QueueConfig`.
        events (BaseEvents, optional): События. По умолчанию: `qtasks.events.SyncEvents`.
    """
    super().__init__(
        name=name, broker=broker, worker=worker, log=log, config=config, events=events
    )
    self._method = "sync"
    self.events = self.events or SyncEvents()

    self.broker: "BaseBroker" = broker or SyncRedisBroker(
        name=name, url=broker_url, log=self.log, config=self.config, events=self.events
    )
    self.worker: "BaseWorker" = worker or SyncThreadWorker(
        name=name, broker=self.broker, log=self.log, config=self.config, events=self.events
    )
    self.starter: Union["BaseStarter", None] = None

    self._registry_tasks()

    self._set_state()

    self.init_plugins()

add_task(*args, task_name, priority=None, timeout=None, **kwargs)

Добавить задачу.

Parameters:

Name Type Description Default
task_name str

Имя задачи.

 required
priority int

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

 None
args tuple

args задачи. По умолчанию ().

 ()
kwargs dict

kwags задачи. По умолчанию {}.

 {}
timeout float

Таймаут задачи. Если указан, задача возвращается через qtasks.results.SyncResult.

 None

Returns:

Type Description
Union[Task, None]

Task|None: schemas.task.Task или None.
Source code in src/qtasks/qtasks.py 
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
def add_task(
    self,
    *args: Annotated[
        Optional[tuple],
        Doc(
            """
                args задачи.

                По умолчанию: `()`.
                """
        ),
    ],
    task_name: Annotated[
        str,
        Doc(
            """
                Имя задачи.
                """
        ),
    ],
    priority: Annotated[
        Optional[int],
        Doc(
            """
                Приоритет у задачи.

                По умолчанию: Значение приоритета у задачи.
                """
        ),
    ] = None,
    timeout: Annotated[
        Optional[float],
        Doc(
            """
                Таймаут задачи.

                Если указан, задача возвращается через `qtasks.results.AsyncTask`.
                """
        ),
    ] = None,
    **kwargs: Annotated[
        Optional[dict],
        Doc(
            """
                kwargs задачи.

                По умолчанию: `{}`.
                """
        ),
    ],
) -> Union["Task", None]:
    """Добавить задачу.

    Args:
        task_name (str): Имя задачи.
        priority (int, optional): Приоритет задачи. По умолчанию: Значение приоритета у задачи.
        args (tuple, optional): args задачи. По умолчанию `()`.
        kwargs (dict, optional): kwags задачи. По умолчанию `{}`.

        timeout (float, optional): Таймаут задачи. Если указан, задача возвращается через `qtasks.results.SyncResult`.

    Returns:
        Task|None: `schemas.task.Task` или `None`.
    """
    if priority is None:
        priority = self.tasks.get(task_name, 0)
        priority = priority.priority if isinstance(priority, TaskExecSchema) else 0

    args, kwargs = args or (), kwargs or {}
    extra = None

    new_args = self._plugin_trigger(
        "qtasks_add_task_before_broker",
        qtasks=self,
        broker=self.broker,
        task_name=task_name,
        priority=priority,
        args=args,
        kw=kwargs,
        return_last=True
    )
    if new_args:
        task_name = new_args.get("task_name", task_name)
        priority = new_args.get("priority", priority)
        extra = new_args.get("extra", extra)
        args = new_args.get("args", args)
        kwargs = new_args.get("kw", kwargs)

    task = self.broker.add(
        task_name=task_name, priority=priority, extra=extra, args=args, kwargs=kwargs
    )

    self._plugin_trigger(
        "qtasks_add_task_after_broker",
        qtasks=self,
        broker=self.broker,
        task_name=task_name,
        priority=priority,
        args=args,
        kwargs=kwargs,
        return_last=True
    )
    if timeout is not None:
        return SyncResult(uuid=task.uuid, app=self, log=self.log).result(
            timeout=timeout
        )
    return task

flush_all()

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

Source code in src/qtasks/qtasks.py 
372
373
374
375
def flush_all(self) -> None:
    """Удалить все данные."""
    self._plugin_trigger("qtasks_flush_all", qtasks=self)
    self.broker.flush_all()

get(uuid)

Получить задачу.

Parameters:

Name Type Description Default
uuid UUID | str

UUID Задачи.

 required

Returns:

Type Description
Union[Task, None]

Task|None: Данные задачи или None.
Source code in src/qtasks/qtasks.py 
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
def get(
    self,
    uuid: Annotated[
        Union[UUID, str],
        Doc(
            """
                UUID задачи.
                """
        ),
    ],
) -> Union["Task", None]:
    """Получить задачу.

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

    Returns:
        Task|None: Данные задачи или None.
    """
    if isinstance(uuid, str):
        uuid = UUID(uuid)
    result = self.broker.get(uuid=uuid)
    new_result = self._plugin_trigger("qtasks_get", qtasks=self, broker=self.broker, task=result, return_last=True)
    if new_result:
        result = new_result.get("task", result)
    return result

ping(server=True)

Проверка запуска сервера.

Parameters:

Name Type Description Default
server bool

Проверка через сервер. По умолчанию True.

 True

Returns:

Name Type Description
bool bool

True - Работает, False - Не работает.
Source code in src/qtasks/qtasks.py 
357
358
359
360
361
362
363
364
365
366
367
368
369
370
def ping(self, server: bool = True) -> bool:
    """Проверка запуска сервера.

    Args:
        server (bool, optional): Проверка через сервер. По умолчанию `True`.

    Returns:
        bool: True - Работает, False - Не работает.
    """
    self._plugin_trigger("qtasks_ping", qtasks=self, global_config=self.broker.storage.global_config)
    if server:
        status = self.broker.storage.global_config.get("main", "status")
        return status is not None
    return True

run_forever(starter=None, num_workers=4, reset_config=True)

Запуск синхронно Приложение.

Parameters:

Name Type Description Default
starter BaseStarter

Стартер. По умолчанию: qtasks.starters.SyncStarter.

 None
num_workers int

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

 4
reset_config bool

Обновить config у воркера и брокера. По умолчанию: True.

 True
Source code in src/qtasks/qtasks.py 
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
def run_forever(
    self,
    starter: Annotated[
        Optional["BaseStarter"],
        Doc(
            """
                Обновить Стартер.

                По умолчанию: `None`.
                """
        ),
    ] = None,
    num_workers: Annotated[
        int,
        Doc(
            """
                Количество запущенных воркеров.

                По умолчанию: `4`.
                """
        ),
    ] = 4,
    reset_config: Annotated[
        bool,
        Doc(
            """
                Обновить config у воркера и брокера.

                По умолчанию: `True`.
                """
        ),
    ] = True,
) -> None:
    """Запуск синхронно Приложение.

    Args:
        starter (BaseStarter, optional): Стартер. По умолчанию: `qtasks.starters.SyncStarter`.
        num_workers (int, optional): Количество запущенных воркеров. По умолчанию: 4.
        reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
    """
    self.starter = starter or SyncStarter(
        name=self.name,
        worker=self.worker,
        broker=self.broker,
        log=self.log,
        config=self.config,
        events=self.events
    )

    plugins_hash = {}
    for plugins in [
        self.plugins,
        self.worker.plugins,
        self.broker.plugins,
        self.broker.storage.plugins,
    ]:
        plugins_hash.update(plugins)

    self._set_state()

    self.starter.start(
        num_workers=num_workers, reset_config=reset_config, plugins=plugins_hash
    )

stop()

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

Source code in src/qtasks/qtasks.py 
352
353
354
355
def stop(self):
    """Останавливает все компоненты."""
    self._plugin_trigger("qtasks_stop", qtasks=self, starter=self.starter)
    self.starter.stop()

task(*args, **kwargs) 

task(name: Union[str, None] = None, *, priority: Union[int, None] = None, echo: bool = False, max_time: Union[float, None] = None, retry: Union[int, None] = None, retry_on_exc: Union[List[Type[Exception]], None] = None, decode: Union[Callable, None] = None, tags: Union[List[str], None] = None, description: Union[str, None] = None, generate_handler: Union[Callable, None] = None, executor: Union[Type[BaseTaskExecutor], None] = None, middlewares_before: Union[List[TaskMiddleware], None] = None, middlewares_after: Union[List[TaskMiddleware], None] = None, **kwargs) -> Callable[[Callable[P, R]], SyncTask[P, R]]

task(func: Callable[P, R]) -> SyncTask[P, R]

Декоратор для регистрации задач.

Parameters:

Name Type Description Default
name str

Имя задачи. По умолчанию: func.__name__.

 required
priority int

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

 required
max_time float

Максимальное время выполнения задачи в секундах. По умолчанию: None.

 required
echo bool

Добавить SyncTask первым параметром. По умолчанию: False.

 required
retry int

Количество попыток повторного выполнения задачи. По умолчанию: None.

 required
retry_on_exc List[Type[Exception]]

Исключения, при которых задача будет повторно выполнена. По умолчанию: None.

 required
decode Callable

Декодер результата задачи. По умолчанию: None.

 required
tags List[str]

Теги задачи. По умолчанию: None.

 required
description str

Описание задачи. По умолчанию: None.

 required
generate_handler Callable

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

 required
executor Type[BaseTaskExecutor]

Класс BaseTaskExecutor. По умолчанию: SyncTaskExecutor.

 required
middlewares_before List[TaskMiddleware]

Мидлвари, которые будут выполнены до задачи. По умолчанию: Пустой массив.

 required
middlewares_after List[TaskMiddleware]

Мидлвари, которые будут выполнены после задачи. По умолчанию: Пустой массив.

 required

Raises:

Type Description
ValueError

Если задача с таким именем уже зарегистрирована.
ValueError

Неизвестный метод {self._method}.

Returns:

Name Type Description
SyncTask

Декоратор для регистрации задачи.
Source code in src/qtasks/qtasks.py 
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
def task(self, *args, **kwargs):
    """Декоратор для регистрации задач.

    Args:
        name (str, optional): Имя задачи. По умолчанию: `func.__name__`.
        priority (int, optional): Приоритет у задачи по умолчанию. По умолчанию: `config.default_task_priority`.
        max_time (float, optional): Максимальное время выполнения задачи в секундах. По умолчанию: `None`.
        echo (bool, optional): Добавить SyncTask первым параметром. По умолчанию: `False`.
        retry (int, optional): Количество попыток повторного выполнения задачи. По умолчанию: `None`.
        retry_on_exc (List[Type[Exception]], optional): Исключения, при которых задача будет повторно выполнена. По умолчанию: `None`.
        decode (Callable, optional): Декодер результата задачи. По умолчанию: `None`.
        tags (List[str], optional): Теги задачи. По умолчанию: `None`.
        description (str, optional): Описание задачи. По умолчанию: `None`.
        generate_handler (Callable, optional): Генератор обработчика. По умолчанию: `None`.
        executor (Type["BaseTaskExecutor"], optional): Класс `BaseTaskExecutor`. По умолчанию: `SyncTaskExecutor`.
        middlewares_before (List["TaskMiddleware"], optional): Мидлвари, которые будут выполнены до задачи. По умолчанию: `Пустой массив`.
        middlewares_after (List["TaskMiddleware"], optional): Мидлвари, которые будут выполнены после задачи. По умолчанию: `Пустой массив`.

    Raises:
        ValueError: Если задача с таким именем уже зарегистрирована.
        ValueError: Неизвестный метод {self._method}.

    Returns:
        SyncTask: Декоратор для регистрации задачи.
    """
    return super().task(*args, **kwargs)