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

BaseWorker - Пишем свой Воркер

Base worker class.

BaseWorker

Bases: ABC

BaseWorker - Абстрактный класс, который является фундаментом для Воркеров.

Example

from qtasks import QueueTasks
from qtasks.workers.base import BaseWorker

class MyWorker(BaseWorker):
    def __init__(self, name: str = None, broker: BaseBroker = None):
        super().__init__(name=name, broker=broker)
        pass
Source code in src/qtasks/workers/base.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
class BaseWorker(ABC):
    """
    `BaseWorker` - Абстрактный класс, который является фундаментом для Воркеров.

    ## Example

    ```python
    from qtasks import QueueTasks
    from qtasks.workers.base import BaseWorker

    class MyWorker(BaseWorker):
        def __init__(self, name: str = None, broker: BaseBroker = None):
            super().__init__(name=name, broker=broker)
            pass
    ```
    """

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

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

                    По умолчанию: `None`.
                    """
            ),
        ] = 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(
                """
                    События.

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

        Args:
            name (str, optional): Имя проекта. По умолчанию: None.
            broker (BaseBroker, optional): Брокер. По умолчанию: None.
            log (Logger, optional): Логгер. По умолчанию: None.
            config (QueueConfig, optional): Конфиг. По умолчанию: None.
        """
        self.name = name
        self.broker = broker
        self.config = config or QueueConfig()

        self.log = (
            log.with_subname("Worker")
            if log
            else Logger(
                name=self.name,
                subname="Worker",
                default_level=self.config.logs_default_level_server,
                format=self.config.logs_format,
            )
        )

        self._tasks: Dict[str, TaskExecSchema] = {}
        self.events: "BaseEvents" = events
        self.task_middlewares_before: List[TaskMiddleware] = []
        self.task_middlewares_after: List[TaskMiddleware] = []

        self.task_executor: Type["BaseTaskExecutor"] = None

        self.plugins: Dict[str, List["BasePlugin"]] = {}

        self.num_workers = 0

        self.init_plugins()

    @abstractmethod
    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.
                    """
            ),
        ],
    ) -> None:
        """Добавление задачи в очередь.

        Args:
            name (str): Имя задачи.
            uuid (UUID): UUID задачи.
            priority (int): Приоритет задачи.
            created_at (float): Создание задачи в формате timestamp.
            args (tuple): Аргументы задачи типа args.
            kwargs (dict): Аргументы задачи типа kwargs.
        """
        pass

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

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
    ):
        """Запускает несколько обработчиков задач. Эта функция задействуется основным экземпляром `QueueTasks` через `run_forever`.

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

    @abstractmethod
    def stop(self):
        """Останавливает воркеры. Эта функция задействуется основным экземпляром `QueueTasks` после завершения функции `run_forever`."""
        pass

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

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

    def add_plugin(
        self,
        plugin: Annotated[
            "BasePlugin",
            Doc(
                """
                    Плагин.
                    """
            ),
        ],
        trigger_names: Annotated[
            Optional[List[str]],
            Doc(
                """
                    Имя триггеров для плагина.

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

        Args:
            plugin (BasePlugin): Плагин
            trigger_names (List[str], optional): Имя триггеров для плагина. По умолчанию: будет добавлен в `Globals`.
        """
        trigger_names = trigger_names or ["Globals"]

        for name in trigger_names:
            if name not in self.plugins:
                self.plugins.update({name: [plugin]})
            else:
                self.plugins[name].append(plugin)
        return

    def init_plugins(self):
        """Инициализация плагинов."""
        pass

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

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

Parameters:

Name Type Description Default
name str

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

 None
broker BaseBroker

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

 None
log Logger

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

 None
config QueueConfig

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

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

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

                По умолчанию: `None`.
                """
        ),
    ] = 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(
            """
                События.

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

    Args:
        name (str, optional): Имя проекта. По умолчанию: None.
        broker (BaseBroker, optional): Брокер. По умолчанию: None.
        log (Logger, optional): Логгер. По умолчанию: None.
        config (QueueConfig, optional): Конфиг. По умолчанию: None.
    """
    self.name = name
    self.broker = broker
    self.config = config or QueueConfig()

    self.log = (
        log.with_subname("Worker")
        if log
        else Logger(
            name=self.name,
            subname="Worker",
            default_level=self.config.logs_default_level_server,
            format=self.config.logs_format,
        )
    )

    self._tasks: Dict[str, TaskExecSchema] = {}
    self.events: "BaseEvents" = events
    self.task_middlewares_before: List[TaskMiddleware] = []
    self.task_middlewares_after: List[TaskMiddleware] = []

    self.task_executor: Type["BaseTaskExecutor"] = None

    self.plugins: Dict[str, List["BasePlugin"]] = {}

    self.num_workers = 0

    self.init_plugins()

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

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

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/base.py 
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
@abstractmethod
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.
                """
        ),
    ],
) -> None:
    """Добавление задачи в очередь.

    Args:
        name (str): Имя задачи.
        uuid (UUID): UUID задачи.
        priority (int): Приоритет задачи.
        created_at (float): Создание задачи в формате timestamp.
        args (tuple): Аргументы задачи типа args.
        kwargs (dict): Аргументы задачи типа kwargs.
    """
    pass

add_plugin(plugin, trigger_names=None)

Добавить плагин в класс.

Parameters:

Name Type Description Default
plugin BasePlugin

Плагин

 required
trigger_names List[str]

Имя триггеров для плагина. По умолчанию: будет добавлен в Globals.

 None
Source code in src/qtasks/workers/base.py 
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
def add_plugin(
    self,
    plugin: Annotated[
        "BasePlugin",
        Doc(
            """
                Плагин.
                """
        ),
    ],
    trigger_names: Annotated[
        Optional[List[str]],
        Doc(
            """
                Имя триггеров для плагина.

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

    Args:
        plugin (BasePlugin): Плагин
        trigger_names (List[str], optional): Имя триггеров для плагина. По умолчанию: будет добавлен в `Globals`.
    """
    trigger_names = trigger_names or ["Globals"]

    for name in trigger_names:
        if name not in self.plugins:
            self.plugins.update({name: [plugin]})
        else:
            self.plugins[name].append(plugin)
    return

init_plugins()

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

Source code in src/qtasks/workers/base.py 
271
272
273
def init_plugins(self):
    """Инициализация плагинов."""
    pass

start(num_workers=None) abstractmethod

Запускает несколько обработчиков задач. Эта функция задействуется основным экземпляром QueueTasks через run_forever.

Parameters:

Name Type Description Default
num_workers int

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

 None
Source code in src/qtasks/workers/base.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
@abstractmethod
def start(
    self,
    num_workers: Annotated[
        Optional[int],
        Doc(
            """
                Количество воркеров.

                По умолчанию: `None`.
                """
        ),
    ] = None,
):
    """Запускает несколько обработчиков задач. Эта функция задействуется основным экземпляром `QueueTasks` через `run_forever`.

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

stop() abstractmethod

Останавливает воркеры. Эта функция задействуется основным экземпляром QueueTasks после завершения функции run_forever.

Source code in src/qtasks/workers/base.py 
211
212
213
214
@abstractmethod
def stop(self):
    """Останавливает воркеры. Эта функция задействуется основным экземпляром `QueueTasks` после завершения функции `run_forever`."""
    pass

update_config(config)

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

Parameters:

Name Type Description Default
config QueueConfig

Конфиг.

 required
Source code in src/qtasks/workers/base.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
def update_config(
    self,
    config: Annotated[
        QueueConfig,
        Doc(
            """
                Конфиг.
                """
        ),
    ],
) -> None:
    """Обновляет конфиг брокера.

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