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

BaseBroker - пишем свой Брокер

Base Broker.

BaseBroker

Bases: ABC

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

Пример

from qtasks import QueueTasks
from qtasks.brokers.base import BaseBroker

class MyBroker(BaseBroker):
    def __init__(self, name: str = None, storage: BaseStorage = None):
        super().__init__(name=name, storage=storage)
        pass
Source code in src/qtasks/brokers/base.py 
 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
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
class BaseBroker(ABC):
    """
    `BaseBroker` - Абстрактный класс, который является фундаментом для Брокеров.

    ## Пример

    ```python
    from qtasks import QueueTasks
    from qtasks.brokers.base import BaseBroker

    class MyBroker(BaseBroker):
        def __init__(self, name: str = None, storage: BaseStorage = None):
            super().__init__(name=name, storage=storage)
            pass
    ```
    """

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

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
        storage: Annotated[
            Optional["BaseStorage"],
            Doc(
                """
                    Хранилище `qtasks.storages.base.BaseStorage`.

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

        Args:
            name (str, optional): Имя проекта. По умолчанию: `None`.
            storage (BaseStorage, optional): Хранилище. По умолчанию: `None`.
            log (Logger, optional): Логгер. По умолчанию: `None`.
            config (QueueConfig, optional): Конфиг. По умолчанию: `None`.
            events (BaseEvents, optional): События. По умолчанию: `None`.
        """
        self.name = name
        self.config = config or QueueConfig()
        self.log = (
            log.with_subname("Broker")
            if log
            else Logger(
                name=self.name,
                subname="Broker",
                default_level=self.config.logs_default_level_server,
                format=self.config.logs_format,
            )
        )
        self.events = events

        self.storage = storage

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

        self.init_plugins()

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

                    По умолчанию: `0`.
                    """
            ),
        ] = 0,
        extra: Annotated[
            dict,
            Doc(
                """
                    Дополнительные параметры задачи.
                    """
            ),
        ] = 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`
        """
        pass

    @abstractmethod
    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`.
        """
        pass

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

        Args:
            kwargs (dict, optional): данные задачи типа kwargs.
        """
        pass

    @abstractmethod
    def start(
        self,
        worker: Annotated[
            "BaseWorker",
            Doc(
                """
                    Класс Воркера.

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

        Args:
            worker (BaseWorker, optional): класс Воркера. По умолчанию: `None`.
        """
        pass

    @abstractmethod
    def stop(self) -> None:
        """Останавливает брокер. Эта функция задействуется основным экземпляром `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 flush_all(self) -> None:
        """Удалить все данные."""
        pass

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

    def _dynamic_model(
        self,
        model: Annotated[
            TaskStatusNewSchema,
            Doc(
                """
                    Модель задачи.
                    """
            ),
        ],
        extra: Annotated[
            dict,
            Doc(
                """
                    Дополнительные поля.
                    """
            ),
        ],
    ):
        # Вычисляем имена стандартных полей
        task_field_names = {f.name for f in fields(TaskStatusNewSchema)}

        # Ищем дополнительные ключи
        extra_fields = []
        extra_values = {}

        for key, value in extra.items():
            if key not in task_field_names:
                # Типизация примитивная — можно улучшить
                field_type = type(value)
                extra_fields.append((key, field_type, field(default=None)))
                extra_values[key] = value

        # Создаем новый dataclass с дополнительными полями
        if extra_fields:
            NewTask = make_dataclass(
                "TaskStatusNewSchema", extra_fields, bases=(TaskStatusNewSchema,)
            )
        else:
            NewTask = TaskStatusNewSchema

        # Объединяем все аргументы
        return NewTask(**asdict(model), **extra_values)

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

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

Parameters:

Name Type Description Default
name str

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

 None
storage BaseStorage

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

 None
log Logger

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

 None
config QueueConfig

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

 None
events BaseEvents

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

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

                По умолчанию: `None`.
                """
        ),
    ] = None,
    storage: Annotated[
        Optional["BaseStorage"],
        Doc(
            """
                Хранилище `qtasks.storages.base.BaseStorage`.

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

    Args:
        name (str, optional): Имя проекта. По умолчанию: `None`.
        storage (BaseStorage, optional): Хранилище. По умолчанию: `None`.
        log (Logger, optional): Логгер. По умолчанию: `None`.
        config (QueueConfig, optional): Конфиг. По умолчанию: `None`.
        events (BaseEvents, optional): События. По умолчанию: `None`.
    """
    self.name = name
    self.config = config or QueueConfig()
    self.log = (
        log.with_subname("Broker")
        if log
        else Logger(
            name=self.name,
            subname="Broker",
            default_level=self.config.logs_default_level_server,
            format=self.config.logs_format,
        )
    )
    self.events = events

    self.storage = storage

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

    self.init_plugins()

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

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

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/base.py 
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
@abstractmethod
def add(
    self,
    task_name: Annotated[
        str,
        Doc(
            """
                Имя задачи.
                """
        ),
    ],
    priority: Annotated[
        int,
        Doc(
            """
                Приоритет задачи.

                По умолчанию: `0`.
                """
        ),
    ] = 0,
    extra: Annotated[
        dict,
        Doc(
            """
                Дополнительные параметры задачи.
                """
        ),
    ] = 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`
    """
    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/brokers/base.py 
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
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

flush_all()

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

Source code in src/qtasks/brokers/base.py 
303
304
305
def flush_all(self) -> None:
    """Удалить все данные."""
    pass

get(uuid) abstractmethod

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

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/base.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
@abstractmethod
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`.
    """
    pass

init_plugins()

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

Source code in src/qtasks/brokers/base.py 
307
308
309
def init_plugins(self):
    """Инициализация плагинов."""
    pass

start(worker=None) abstractmethod

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

Parameters:

Name Type Description Default
worker BaseWorker

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

 None
Source code in src/qtasks/brokers/base.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
@abstractmethod
def start(
    self,
    worker: Annotated[
        "BaseWorker",
        Doc(
            """
                Класс Воркера.

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

    Args:
        worker (BaseWorker, optional): класс Воркера. По умолчанию: `None`.
    """
    pass

stop() abstractmethod

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

Source code in src/qtasks/brokers/base.py 
243
244
245
246
@abstractmethod
def stop(self) -> None:
    """Останавливает брокер. Эта функция задействуется основным экземпляром `QueueTasks` после завершения функции `run_forever`."""
    pass

update(**kwargs) abstractmethod

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

Parameters:

Name Type Description Default
kwargs dict

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

 {}
Source code in src/qtasks/brokers/base.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
@abstractmethod
def update(
    self,
    **kwargs: Annotated[
        dict,
        Doc(
            """
                Аргументы обновления для хранилища типа kwargs.
                """
        ),
    ],
) -> None:
    """Обновляет информацию о задаче.

    Args:
        kwargs (dict, optional): данные задачи типа kwargs.
    """
    pass

update_config(config)

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

Parameters:

Name Type Description Default
config QueueConfig

Конфиг.

 required
Source code in src/qtasks/brokers/base.py 
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
def update_config(
    self,
    config: Annotated[
        QueueConfig,
        Doc(
            """
                Конфиг.
                """
        ),
    ],
) -> None:
    """Обновляет конфиг брокера.

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