SyncContext

Sync context for tasks.

SyncContext

Контекст, связанный с синхронными задачами.

Пример

from qtasks import QueueTasks
from qtasks.registries import SyncTask

app = QueueTasks()

@app.task(echo=True)
async def my_task(self: SyncTask):
    self.ctx # SyncContext

generate_handler = kwargs.get('generate_handler') instance-attribute

Функция-генератор для создания задач.

task_name = kwargs.get('task_name') instance-attribute

Имя задачи.

task_uuid = kwargs.get('task_uuid') instance-attribute

UUID задачи.

__init__(**kwargs)

Инициализация контекста.

cancel(reason='')

Отменяет задачу.

Parameters:

Name	Type	Description	Default
reason	str	Причина отмены задачи.	''

Raises:

Type	Description
TaskCancelError	Исключение, вызываемое при отмене задачи.

get_component(name)

Возвращает компонент приложения по имени.

Parameters:

Name	Type	Description	Default
name	str	Имя компонента.	required

Returns:

Name	Type	Description
Any		Компонент приложения или None, если не найден.

get_config()

Возвращает конфигурацию приложения.

Returns:

Name	Type	Description
QueueConfig	QueueConfig	Конфигурация приложения.

get_logger(name=None)

Возвращает логгер для текущего контекста.

Parameters:

Name	Type	Description	Default
name	str | None	Имя логгера. Если не указано, используется "AsyncContext".	None

Returns:

Name	Type	Description
Logger	Logger	Логгер для текущего контекста.

get_metadata(cache=True)

Возвращает метаданные задачи.

Parameters:

Name	Type	Description	Default
cache	bool	Использовать кэшированные метаданные.	True

Returns:

Type	Description
Task | None	Task|None: Метаданные задачи или None, если не найдены.

get_task(uuid)

Возвращает задачу по UUID.

Parameters:

Name	Type	Description	Default
uuid	UUID | str	UUID задачи.	required

Returns:

Type	Description
Task | None	Task|None: Задача или None, если не найдена.

plugin_error(**kwargs)

Вызывает ошибку плагина.

Parameters:

Name	Type	Description	Default
**kwargs		Аргументы для передачи в обработчик ошибки плагина.	{}

sleep(seconds)

Приостанавливает выполнение на заданное количество секунд.

Parameters:

Name	Type	Description	Default
seconds	float	Количество секунд для приостановки.	required