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

SyncStarter

Sync Starter.

SyncStarter

Bases: BaseStarter, SyncPluginMixin

Стартер, запускающий Компоненты.

Пример

from qtasks import QueueTasks
from qtasks.brokers import SyncRedisBroker
from qtasks.workers import SyncWorker
from qtasks.starters import SyncStarter

broker = SyncRedisBroker(name="QueueTasks", url="redis://localhost:6379/2")
worker = SyncWorker(name="QueueTasks", broker=broker)

app = QueueTasks(worker=worker, broker=broker)

starter = SyncStarter(name="QueueTasks", worker=worker, broker=broker)
app.run_forever(starter=starter)
Source code in src/qtasks/starters/sync_starter.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
class SyncStarter(BaseStarter, SyncPluginMixin):
    """
    Стартер, запускающий Компоненты.

    ## Пример

    ```python
    from qtasks import QueueTasks
    from qtasks.brokers import SyncRedisBroker
    from qtasks.workers import SyncWorker
    from qtasks.starters import SyncStarter

    broker = SyncRedisBroker(name="QueueTasks", url="redis://localhost:6379/2")
    worker = SyncWorker(name="QueueTasks", broker=broker)

    app = QueueTasks(worker=worker, broker=broker)

    starter = SyncStarter(name="QueueTasks", worker=worker, broker=broker)
    app.run_forever(starter=starter)
    ```
    """

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

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

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
        worker: Annotated[
            Optional["BaseWorker"],
            Doc(
                """
                    Воркер.

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

                    По умолчанию: `qtasks.events.SyncEvents`.
                    """
            ),
        ] = None,
    ):
        """Инициализация асинхронного стартера.

        Args:
            name (str, optional): Имя проекта. По умолчанию: None.
            broker (BaseBroker, optional): Брокер. По умолчанию: None.
            worker (BaseWorker, optional): Воркер. По умолчанию: None.
            log (Logger, optional): Логгер. По умолчанию: `qtasks.logs.Logger`.
            config (QueueConfig, optional): Конфиг. По умолчанию: `qtasks.configs.config.QueueConfig`.
            events (BaseEvents, optional): События. По умолчанию: `qtasks.events.SyncEvents`.
        """
        super().__init__(
            name=name, broker=broker, worker=worker, log=log, config=config, events=events
        )
        self.events = self.events or SyncEvents()

        self._started_plugins: set[int] = set()

    def start(
        self,
        num_workers: Annotated[
            int,
            Doc(
                """
                    Количество запущенных воркеров.

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

                    По умолчанию: `True`.
                    """
            ),
        ] = True,
        plugins: Annotated[
            Optional[Dict[str, "BasePlugin"]],
            Doc(
                """
                    Плагины для воркера и брокера.

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

        Args:
            num_workers (int, optional): Количество воркеров. По умолчанию: 4.
            reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
            plugins (Dict[str, BasePlugin] | None, optional): Плагины. По умолчанию: None.
        """
        self.log.info("Запуск QueueTasks...")

        if plugins:
            self.plugins.update(plugins)

        if reset_config:
            self.update_configs(self.config)

        try:
            self._start(num_workers=num_workers)
        except KeyboardInterrupt:
            self.stop()

    def _start(self, num_workers=4):
        """Запуск Стартера синхронно.

        Args:
            num_workers (int, optional): Количество воркеров. По умолчанию: 4.
        """
        self._plugin_trigger("starter_start", starter=self)
        for plugin in [i for y in self.plugins.values() for i in y]:
            if plugin not in self._started_plugins:
                self._started_plugins.add(plugin)
                plugin.start()

        self.events.fire("starting", starter=self, worker=self.worker, broker=self.broker)

        self.worker.start(num_workers)
        self.broker.start(self.worker)

        try:
            while True:
                pass  # Бесконечный цикл выполнения
        except KeyboardInterrupt:
            self.stop()

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

        if self.broker:
            self.broker.stop()
        if self.worker:
            self.worker.stop()
        if self.broker.storage:
            self.broker.storage.stop()
        if self.broker.storage.global_config:
            self.broker.storage.global_config.stop()

        self.events.fire("stopping", starter=self, worker=self.worker, broker=self.broker)

        for model_plugin in [i for y in self.plugins.values() for i in y]:
            model_plugin.stop()

        for plugin in self._started_plugins:
            plugin.stop()
        self._started_plugins.clear()

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

Инициализация асинхронного стартера.

Parameters:

Name Type Description Default
name str

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

 None
broker BaseBroker

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

 None
worker BaseWorker

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

 None
log Logger

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

 None
config QueueConfig

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

 None
events BaseEvents

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

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

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

                По умолчанию: `None`.
                """
        ),
    ] = None,
    worker: Annotated[
        Optional["BaseWorker"],
        Doc(
            """
                Воркер.

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

                По умолчанию: `qtasks.events.SyncEvents`.
                """
        ),
    ] = None,
):
    """Инициализация асинхронного стартера.

    Args:
        name (str, optional): Имя проекта. По умолчанию: None.
        broker (BaseBroker, optional): Брокер. По умолчанию: None.
        worker (BaseWorker, optional): Воркер. По умолчанию: None.
        log (Logger, optional): Логгер. По умолчанию: `qtasks.logs.Logger`.
        config (QueueConfig, optional): Конфиг. По умолчанию: `qtasks.configs.config.QueueConfig`.
        events (BaseEvents, optional): События. По умолчанию: `qtasks.events.SyncEvents`.
    """
    super().__init__(
        name=name, broker=broker, worker=worker, log=log, config=config, events=events
    )
    self.events = self.events or SyncEvents()

    self._started_plugins: set[int] = set()

start(num_workers=4, reset_config=True, plugins=None)

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

Parameters:

Name Type Description Default
num_workers int

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

 4
reset_config bool

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

 True
plugins Dict[str, BasePlugin] | None

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

 None
Source code in src/qtasks/starters/sync_starter.py 
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
def start(
    self,
    num_workers: Annotated[
        int,
        Doc(
            """
                Количество запущенных воркеров.

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

                По умолчанию: `True`.
                """
        ),
    ] = True,
    plugins: Annotated[
        Optional[Dict[str, "BasePlugin"]],
        Doc(
            """
                Плагины для воркера и брокера.

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

    Args:
        num_workers (int, optional): Количество воркеров. По умолчанию: 4.
        reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
        plugins (Dict[str, BasePlugin] | None, optional): Плагины. По умолчанию: None.
    """
    self.log.info("Запуск QueueTasks...")

    if plugins:
        self.plugins.update(plugins)

    if reset_config:
        self.update_configs(self.config)

    try:
        self._start(num_workers=num_workers)
    except KeyboardInterrupt:
        self.stop()

stop()

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

Source code in src/qtasks/starters/sync_starter.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
def stop(self):
    """Останавливает все компоненты."""
    self.log.info("Остановка QueueTasks...")
    self._plugin_trigger("starter_stop", starter=self)

    if self.broker:
        self.broker.stop()
    if self.worker:
        self.worker.stop()
    if self.broker.storage:
        self.broker.storage.stop()
    if self.broker.storage.global_config:
        self.broker.storage.global_config.stop()

    self.events.fire("stopping", starter=self, worker=self.worker, broker=self.broker)

    for model_plugin in [i for y in self.plugins.values() for i in y]:
        model_plugin.stop()

    for plugin in self._started_plugins:
        plugin.stop()
    self._started_plugins.clear()