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

SyncSocketBroker

Sync Socket Broker.

SyncSocketBroker

Bases: BaseBroker, SyncPluginMixin

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

Пример

from qtasks import QueueTasks
from qtasks.brokers import SyncSocketBroker

broker = SyncSocketBroker(name="QueueTasks", url="127.0.0.1")

app = QueueTasks(broker=broker)
Source code in src/qtasks/brokers/sync_socket.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
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
class SyncSocketBroker(BaseBroker, SyncPluginMixin):
    """
    Брокер, слушающий сокеты и добавляющий задачи в очередь.

    ## Пример

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

    broker = SyncSocketBroker(name="QueueTasks", url="127.0.0.1")

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

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

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

                    По умолчанию: `127.0.0.1`.
                    """
            ),
        ] = None,
        port: Annotated[
            int,
            Doc(
                """
                    Порт для подключения к сокету.

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

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

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

        Args:
            name (str, optional): Имя проекта. По умолчанию: `QueueTasks`.
            url (str, optional): URL для подключения к сокету. По умолчанию: `AsyncRedisStorage`.
            port (int, optional): Порт для подключения к сокету. По умолчанию: `8765`.
            storage (BaseStorage, optional): Хранилище. По умолчанию: `None`.
            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 "127.0.0.1"
        self.port = port
        self.events = self.events or SyncEvents()

        self.client = None
        self.storage = storage or SyncRedisStorage(
            name=name,
            log=self.log,
            config=self.config,
        )
        self.default_sleep = 0.01
        self.running = False

        self.queue = Queue()
        self._serve_task = None
        self._listen_task = None

    def handle_connection(self, reader, writer):
        """Обрабатывает входящее соединение.

        Args:
            reader: Читатель для входящих данных.
            writer: Писатель для исходящих данных.
        """
        conn = reader
        try:
            data = conn.recv(4096)
            if not data:
                return
            message = json.loads(data.decode())
            task_name = message["task_name"]
            uuid = message["uuid"]
            priority = message["priority"]
            args = message.get("args", ())
            kwargs = message.get("kwargs", {})
            created_at = message["created_at"]

            self.storage.add(
                uuid=uuid,
                task_status=TaskStatusNewSchema(
                    task_name=task_name,
                    priority=priority,
                    args=args,
                    kwargs=kwargs,
                    created_at=created_at,
                    updated_at=created_at,
                ),
            )

            self.queue.put((task_name, uuid, priority))
            conn.sendall(b"OK")
        finally:
            with contextlib.suppress(Exception):
                conn.shutdown(socket.SHUT_RDWR)
                conn.close()

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

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

        while self.running:
            try:
                item = self.queue.get(timeout=0.1)
            except Empty:
                continue
            if item is None:
                break

            task_name, uuid, priority = item
            task_data = self.get(uuid)
            args, kwargs, created_at = task_data.args, task_data.kwargs, task_data.created_at

            self.storage.add_process(f"{task_name}:{uuid}:{priority}", priority)

            model_get = 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 = 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)
            worker.add(
                name=task_name,
                uuid=uuid,
                priority=int(priority),
                args=args,
                kwargs=kwargs,
                created_at=created_at,
            )

    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`
        """
        atexit.register(self.stop)
        atexit.register(self.storage.stop)

        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 = self._plugin_trigger(
            "broker_add_before",
            broker=self,
            storage=self.storage,
            model=model
        )
        if new_model:
            model = new_model.get("model", model)

        with socket.create_connection((self.url, self.port)) as s:
            payload = asdict(model)
            payload.update({"uuid": uuid})
            s.sendall(json.dumps(payload).encode())
            try:
                s.settimeout(2.0)
                _ = s.recv(1024)
            except Exception:
                pass

        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,
        )

    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 = self.storage.get(uuid=uuid)
        new_task = self._plugin_trigger("broker_get", broker=self, task=task, return_last=True)
        if new_task:
            task = new_task.get("task", task)
        return task

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

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

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

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

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

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

        self.client = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        self.client.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        self.client.bind((self.url, self.port))
        self.client.listen(128)
        self.running = True

        self._listen_task = threading.Thread(
            target=self.listen, args=(worker,), name="broker-listen", daemon=True
        )
        self._listen_task.start()

        def _serve():
            while self.running:
                try:
                    conn, _addr = self.client.accept()
                except OSError:
                    break
                try:
                    self.handle_connection(conn, conn)
                except Exception:
                    with contextlib.suppress(Exception):
                        conn.close()

        self._serve_task = threading.Thread(target=_serve, name="broker-serve", daemon=True)
        self._serve_task.start()

        try:
            while self._serve_task.is_alive():
                self._serve_task.join(timeout=0.5)
        except KeyboardInterrupt:
            pass

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

        with contextlib.suppress(Exception):
            self.queue.put_nowait(None)

        if self.client:
            with contextlib.suppress(Exception):
                self.client.shutdown(socket.SHUT_RDWR)
                self.client.close()

            self.client = None

        if self._serve_task and self._serve_task.is_alive():
            with contextlib.suppress(Exception):
                self._serve_task.join(timeout=2.0)

        if self._listen_task and self._listen_task.is_alive():
            with contextlib.suppress(Exception):
                self._listen_task.join(timeout=2.0)

    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 = 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)

        self.storage.remove_finished_task(task_broker, model)
        return

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

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

__init__(name='QueueTasks', url=None, port=6379, storage=None, log=None, config=None, events=None)

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

Parameters:

Name Type Description Default
name str

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

'QueueTasks'
url str

URL для подключения к сокету. По умолчанию: AsyncRedisStorage.

None
port int

Порт для подключения к сокету. По умолчанию: 8765.

6379
storage BaseStorage

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

None
log Logger

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

None
config QueueConfig

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

None
events BaseEvents

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

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

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

                По умолчанию: `127.0.0.1`.
                """
        ),
    ] = None,
    port: Annotated[
        int,
        Doc(
            """
                Порт для подключения к сокету.

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

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

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

    Args:
        name (str, optional): Имя проекта. По умолчанию: `QueueTasks`.
        url (str, optional): URL для подключения к сокету. По умолчанию: `AsyncRedisStorage`.
        port (int, optional): Порт для подключения к сокету. По умолчанию: `8765`.
        storage (BaseStorage, optional): Хранилище. По умолчанию: `None`.
        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 "127.0.0.1"
    self.port = port
    self.events = self.events or SyncEvents()

    self.client = None
    self.storage = storage or SyncRedisStorage(
        name=name,
        log=self.log,
        config=self.config,
    )
    self.default_sleep = 0.01
    self.running = False

    self.queue = Queue()
    self._serve_task = None
    self._listen_task = None

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

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

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/sync_socket.py
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
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`
    """
    atexit.register(self.stop)
    atexit.register(self.storage.stop)

    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 = self._plugin_trigger(
        "broker_add_before",
        broker=self,
        storage=self.storage,
        model=model
    )
    if new_model:
        model = new_model.get("model", model)

    with socket.create_connection((self.url, self.port)) as s:
        payload = asdict(model)
        payload.update({"uuid": uuid})
        s.sendall(json.dumps(payload).encode())
        try:
            s.settimeout(2.0)
            _ = s.recv(1024)
        except Exception:
            pass

    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()

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

Source code in src/qtasks/brokers/sync_socket.py
541
542
543
544
def flush_all(self) -> None:
    """Удалить все данные."""
    self._plugin_trigger("broker_flush_all", broker=self)
    self.storage.flush_all()

get(uuid)

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

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/sync_socket.py
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
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 = self.storage.get(uuid=uuid)
    new_task = self._plugin_trigger("broker_get", broker=self, task=task, return_last=True)
    if new_task:
        task = new_task.get("task", task)
    return task

handle_connection(reader, writer)

Обрабатывает входящее соединение.

Parameters:

Name Type Description Default
reader

Читатель для входящих данных.

required
writer

Писатель для исходящих данных.

required
Source code in src/qtasks/brokers/sync_socket.py
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
def handle_connection(self, reader, writer):
    """Обрабатывает входящее соединение.

    Args:
        reader: Читатель для входящих данных.
        writer: Писатель для исходящих данных.
    """
    conn = reader
    try:
        data = conn.recv(4096)
        if not data:
            return
        message = json.loads(data.decode())
        task_name = message["task_name"]
        uuid = message["uuid"]
        priority = message["priority"]
        args = message.get("args", ())
        kwargs = message.get("kwargs", {})
        created_at = message["created_at"]

        self.storage.add(
            uuid=uuid,
            task_status=TaskStatusNewSchema(
                task_name=task_name,
                priority=priority,
                args=args,
                kwargs=kwargs,
                created_at=created_at,
                updated_at=created_at,
            ),
        )

        self.queue.put((task_name, uuid, priority))
        conn.sendall(b"OK")
    finally:
        with contextlib.suppress(Exception):
            conn.shutdown(socket.SHUT_RDWR)
            conn.close()

listen(worker)

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

Parameters:

Name Type Description Default
worker BaseWorker

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

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

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

    while self.running:
        try:
            item = self.queue.get(timeout=0.1)
        except Empty:
            continue
        if item is None:
            break

        task_name, uuid, priority = item
        task_data = self.get(uuid)
        args, kwargs, created_at = task_data.args, task_data.kwargs, task_data.created_at

        self.storage.add_process(f"{task_name}:{uuid}:{priority}", priority)

        model_get = 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 = 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)
        worker.add(
            name=task_name,
            uuid=uuid,
            priority=int(priority),
            args=args,
            kwargs=kwargs,
            created_at=created_at,
        )

remove_finished_task(task_broker, model)

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

Parameters:

Name Type Description Default
task_broker TaskPrioritySchema

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

required
model TaskStatusNewSchema | TaskStatusErrorSchema

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

required
Source code in src/qtasks/brokers/sync_socket.py
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
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 = 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)

    self.storage.remove_finished_task(task_broker, model)
    return

start(worker)

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

Parameters:

Name Type Description Default
worker BaseWorker

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

required
Source code in src/qtasks/brokers/sync_socket.py
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
def start(
    self,
    worker: Annotated[
        "BaseWorker",
        Doc(
            """
                Класс Воркера.
                """
        ),
    ],
) -> None:
    """Запускает брокер.

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

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

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

    self.client = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    self.client.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    self.client.bind((self.url, self.port))
    self.client.listen(128)
    self.running = True

    self._listen_task = threading.Thread(
        target=self.listen, args=(worker,), name="broker-listen", daemon=True
    )
    self._listen_task.start()

    def _serve():
        while self.running:
            try:
                conn, _addr = self.client.accept()
            except OSError:
                break
            try:
                self.handle_connection(conn, conn)
            except Exception:
                with contextlib.suppress(Exception):
                    conn.close()

    self._serve_task = threading.Thread(target=_serve, name="broker-serve", daemon=True)
    self._serve_task.start()

    try:
        while self._serve_task.is_alive():
            self._serve_task.join(timeout=0.5)
    except KeyboardInterrupt:
        pass

stop()

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

Source code in src/qtasks/brokers/sync_socket.py
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
def stop(self):
    """Останавливает брокер."""
    self._plugin_trigger("broker_stop", broker=self)
    self.running = False

    with contextlib.suppress(Exception):
        self.queue.put_nowait(None)

    if self.client:
        with contextlib.suppress(Exception):
            self.client.shutdown(socket.SHUT_RDWR)
            self.client.close()

        self.client = None

    if self._serve_task and self._serve_task.is_alive():
        with contextlib.suppress(Exception):
            self._serve_task.join(timeout=2.0)

    if self._listen_task and self._listen_task.is_alive():
        with contextlib.suppress(Exception):
            self._listen_task.join(timeout=2.0)

update(**kwargs)

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

Parameters:

Name Type Description Default
kwargs dict

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

{}
Source code in src/qtasks/brokers/sync_socket.py
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
def update(
    self,
    **kwargs: Annotated[
        dict,
        Doc(
            """
                Аргументы обновления для хранилища типа kwargs.
                """
        ),
    ],
) -> None:
    """Обновляет информацию о задаче.

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