Skip to content

AsyncStarter

Async Starter.

AsyncStarter

Bases: BaseStarter[Literal[True]], AsyncPluginMixin

Starter that starts the Components.

Example

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 
 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
class AsyncStarter(BaseStarter[Literal[True]], AsyncPluginMixin):
    """
    Starter that starts the Components.

    ## Example

    ```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[
            str | None,
            Doc("""
                    Project name. This name can be used for tags for Starters.

                    Default: `None`.
                    """),
        ] = None,
        broker: Annotated[
            Optional[BaseBroker],
            Doc("""
                    Broker.

                    Default: `None`.
                    """),
        ] = None,
        worker: Annotated[
            Optional[BaseWorker],
            Doc("""
                    Worker.

                    Default: `None`.
                    """),
        ] = None,
        log: Annotated[
            Logger | None,
            Doc("""
                    Logger.

                    Default: `qtasks.logs.Logger`.
                    """),
        ] = None,
        config: Annotated[
            QueueConfig | None,
            Doc("""
                    Config.

                    Default: `qtasks.configs.config.QueueConfig`.
                    """),
        ] = None,
        events: Annotated[
            Optional[BaseEvents],
            Doc("""
                    Events.

                    Default: `qtasks.events.AsyncEvents`.
                    """),
        ] = None,
    ):
        """
        Initialization of an asynchronous starter.

        Args:
            name (str, optional): Project name. Default: None.
            broker (BaseBroker, optional): Broker. Default: None.
            worker (BaseWorker, optional): Worker. Default: None.
            log (Logger, optional): Logger. Default: `qtasks.logs.Logger`.
            config (QueueConfig, optional): Config. Default: `qtasks.configs.config.QueueConfig`.
            events (BaseEvents, optional): Events. Default: `qtasks.events.AsyncEvents`.
        """
        super().__init__(
            name=name,
            broker=broker,
            worker=worker,
            log=log,
            config=config,
            events=events,
        )
        self.events: BaseEvents[Literal[True]] = self.events or AsyncEvents()
        self.worker: BaseWorker[Literal[True]]
        self.broker: BaseBroker[Literal[True]]

        self._global_loop: asyncio.AbstractEventLoop | None = None
        self._started_plugins: set[BasePlugin] = set()

    def start(
        self,
        loop: Annotated[
            asyncio.AbstractEventLoop | None,
            Doc("""
                    Asynchronous loop.

                    Default: `None`.
                    """),
        ] = None,
        num_workers: Annotated[
            int,
            Doc("""
                    Number of running workers.

                    Default: `4`.
                    """),
        ] = 4,
        reset_config: Annotated[
            bool,
            Doc("""
                    Update the config of the worker and broker.

                    Default: `True`.
                    """),
        ] = True,
        plugins: Annotated[
            dict[str, list[BasePlugin]] | None,
            Doc("""
                    Plugins for worker and broker.

                    Default: `None`.
                    """),
        ] = None,
    ) -> None:
        """
        Starter launch. This function is enabled by the main `QueueTasks` instance via `run_forever`.

        Args:
            loop (asyncio.AbstractEventLoop, optional): Asynchronous loop. Default: None.
            num_workers (int, optional): Number of workers. Default: 4.
            reset_config (bool, optional): Update the config of the worker and broker. Default: True.
            plugins (Dict[str, List[BasePlugin]] | None, optional): Plugins. Default: None.
        """
        if self.log:
            self.log.info("Starting 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:
            with contextlib.suppress(RuntimeError, KeyboardInterrupt):
                self._global_loop.run_until_complete(self.stop())

    async def _start(self, num_workers=4):
        """
        Launching the Starter asynchronously.

        Args:
            num_workers (int, optional): Number of workers. Default: 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:
                plugin: BasePlugin[Literal[True]]
                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):
        """Stops all components."""
        if self.log:
            self.log.info("Stopping 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]:
            model_plugin: BasePlugin[Literal[True]]
            await model_plugin.stop()

        for plugin in self._started_plugins:
            plugin: BasePlugin[Literal[True]]
            await plugin.stop()
        self._started_plugins.clear()

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

Initialization of an asynchronous starter.

Parameters:

Name Type Description Default
name str

Project name. Default: None.

 None
broker BaseBroker

Broker. Default: None.

 None
worker BaseWorker

Worker. Default: None.

 None
log Logger

Logger. Default: qtasks.logs.Logger.

 None
config QueueConfig

Config. Default: qtasks.configs.config.QueueConfig.

 None
events BaseEvents

Events. Default: qtasks.events.AsyncEvents.

 None
Source code in src/qtasks/starters/async_starter.py 
 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
def __init__(
    self,
    name: Annotated[
        str | None,
        Doc("""
                Project name. This name can be used for tags for Starters.

                Default: `None`.
                """),
    ] = None,
    broker: Annotated[
        Optional[BaseBroker],
        Doc("""
                Broker.

                Default: `None`.
                """),
    ] = None,
    worker: Annotated[
        Optional[BaseWorker],
        Doc("""
                Worker.

                Default: `None`.
                """),
    ] = None,
    log: Annotated[
        Logger | None,
        Doc("""
                Logger.

                Default: `qtasks.logs.Logger`.
                """),
    ] = None,
    config: Annotated[
        QueueConfig | None,
        Doc("""
                Config.

                Default: `qtasks.configs.config.QueueConfig`.
                """),
    ] = None,
    events: Annotated[
        Optional[BaseEvents],
        Doc("""
                Events.

                Default: `qtasks.events.AsyncEvents`.
                """),
    ] = None,
):
    """
    Initialization of an asynchronous starter.

    Args:
        name (str, optional): Project name. Default: None.
        broker (BaseBroker, optional): Broker. Default: None.
        worker (BaseWorker, optional): Worker. Default: None.
        log (Logger, optional): Logger. Default: `qtasks.logs.Logger`.
        config (QueueConfig, optional): Config. Default: `qtasks.configs.config.QueueConfig`.
        events (BaseEvents, optional): Events. Default: `qtasks.events.AsyncEvents`.
    """
    super().__init__(
        name=name,
        broker=broker,
        worker=worker,
        log=log,
        config=config,
        events=events,
    )
    self.events: BaseEvents[Literal[True]] = self.events or AsyncEvents()
    self.worker: BaseWorker[Literal[True]]
    self.broker: BaseBroker[Literal[True]]

    self._global_loop: asyncio.AbstractEventLoop | None = None
    self._started_plugins: set[BasePlugin] = set()

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

Starter launch. This function is enabled by the main QueueTasks instance via run_forever.

Parameters:

Name Type Description Default
loop AbstractEventLoop

Asynchronous loop. Default: None.

 None
num_workers int

Number of workers. Default: 4.

 4
reset_config bool

Update the config of the worker and broker. Default: True.

 True
plugins Dict[str, List[BasePlugin]] | None

Plugins. Default: None.

 None
Source code in src/qtasks/starters/async_starter.py 
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
def start(
    self,
    loop: Annotated[
        asyncio.AbstractEventLoop | None,
        Doc("""
                Asynchronous loop.

                Default: `None`.
                """),
    ] = None,
    num_workers: Annotated[
        int,
        Doc("""
                Number of running workers.

                Default: `4`.
                """),
    ] = 4,
    reset_config: Annotated[
        bool,
        Doc("""
                Update the config of the worker and broker.

                Default: `True`.
                """),
    ] = True,
    plugins: Annotated[
        dict[str, list[BasePlugin]] | None,
        Doc("""
                Plugins for worker and broker.

                Default: `None`.
                """),
    ] = None,
) -> None:
    """
    Starter launch. This function is enabled by the main `QueueTasks` instance via `run_forever`.

    Args:
        loop (asyncio.AbstractEventLoop, optional): Asynchronous loop. Default: None.
        num_workers (int, optional): Number of workers. Default: 4.
        reset_config (bool, optional): Update the config of the worker and broker. Default: True.
        plugins (Dict[str, List[BasePlugin]] | None, optional): Plugins. Default: None.
    """
    if self.log:
        self.log.info("Starting 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:
        with contextlib.suppress(RuntimeError, KeyboardInterrupt):
            self._global_loop.run_until_complete(self.stop())

stop() async

Stops all components.

Source code in src/qtasks/starters/async_starter.py 
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
async def stop(self):
    """Stops all components."""
    if self.log:
        self.log.info("Stopping 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]:
        model_plugin: BasePlugin[Literal[True]]
        await model_plugin.stop()

    for plugin in self._started_plugins:
        plugin: BasePlugin[Literal[True]]
        await plugin.stop()
    self._started_plugins.clear()