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

AsyncStarter

Async Starter.

AsyncStarter

Bases: BaseStarter, AsyncPluginMixin

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

Пример

from qtasks import QueueTasks
from qtasks.brokers import AsyncRedisBroker
from qtasks.workers import AsyncWorker
from qtasks.starters import AsyncStarter

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

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

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

    ## Пример

    ```python
    from qtasks import QueueTasks
    from qtasks.brokers import AsyncRedisBroker
    from qtasks.workers import AsyncWorker
    from qtasks.starters import AsyncStarter

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

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

    starter = AsyncStarter(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.AsyncEvents`.
                    """
            ),
        ] = 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.AsyncEvents`.
        """
        super().__init__(
            name=name, broker=broker, worker=worker, log=log, config=config, events=events
        )
        self.events = self.events or AsyncEvents()

        self._global_loop: Union[asyncio.AbstractEventLoop, None] = None
        self._started_plugins: set[int] = set()

    def start(
        self,
        loop: Annotated[
            Optional[asyncio.AbstractEventLoop],
            Doc(
                """
                    Асинхронный loop.

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
        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:
            loop (asyncio.AbstractEventLoop, optional): Асинхронный loop. По умолчанию: None.
            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)

        if loop:
            self._global_loop = loop
        else:
            try:
                self._global_loop = asyncio.new_event_loop()
                asyncio.set_event_loop(self._global_loop)
            except RuntimeError:
                self._global_loop = asyncio.get_event_loop()

        try:
            self._global_loop.run_until_complete(self._start(num_workers))
        except KeyboardInterrupt:
            self._global_loop.run_until_complete(self.stop())

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

        Args:
            num_workers (int, optional): Количество воркеров. По умолчанию: 4.
        """
        await 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)
                await plugin.start()

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

        worker_task = asyncio.create_task(self.worker.start(num_workers))
        broker_task = asyncio.create_task(self.broker.start(self.worker))

        with contextlib.suppress(asyncio.CancelledError):
            await asyncio.gather(broker_task, worker_task)

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

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

        if self._global_loop and self._global_loop.is_running():
            self._global_loop.stop()

        await 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]:
            await model_plugin.stop()

        for plugin in self._started_plugins:
            await 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.AsyncEvents.

 None
Source code in src/qtasks/starters/async_starter.py 
 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
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.AsyncEvents`.
                """
        ),
    ] = 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.AsyncEvents`.
    """
    super().__init__(
        name=name, broker=broker, worker=worker, log=log, config=config, events=events
    )
    self.events = self.events or AsyncEvents()

    self._global_loop: Union[asyncio.AbstractEventLoop, None] = None
    self._started_plugins: set[int] = set()

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

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

Parameters:

Name Type Description Default
loop AbstractEventLoop

Асинхронный loop. По умолчанию: None.

 None
num_workers int

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

 4
reset_config bool

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

 True
plugins Dict[str, BasePlugin] | None

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

 None
Source code in src/qtasks/starters/async_starter.py 
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
def start(
    self,
    loop: Annotated[
        Optional[asyncio.AbstractEventLoop],
        Doc(
            """
                Асинхронный loop.

                По умолчанию: `None`.
                """
        ),
    ] = None,
    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:
        loop (asyncio.AbstractEventLoop, optional): Асинхронный loop. По умолчанию: None.
        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)

    if loop:
        self._global_loop = loop
    else:
        try:
            self._global_loop = asyncio.new_event_loop()
            asyncio.set_event_loop(self._global_loop)
        except RuntimeError:
            self._global_loop = asyncio.get_event_loop()

    try:
        self._global_loop.run_until_complete(self._start(num_workers))
    except KeyboardInterrupt:
        self._global_loop.run_until_complete(self.stop())

stop() async

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

Source code in src/qtasks/starters/async_starter.py 
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
async def stop(self):
    """Останавливает все компоненты."""
    self.log.info("Остановка QueueTasks...")
    await self._plugin_trigger("starter_stop", starter=self)

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

    if self._global_loop and self._global_loop.is_running():
        self._global_loop.stop()

    await 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]:
        await model_plugin.stop()

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