Skip to content

AsyncTimer

Async timer for scheduling tasks.

AsyncTimer

Bases: BaseTimer[Literal[True]]

A timer running through apscheduler that starts tasks.

Example

from qtasks import QueueTasks
from qtasks.timers import AsyncTimer

app = QueueTasks()
timer = AsyncTimer(app=app)

trigger = CronTrigger(second="*/10") # Trigger every 10 seconds
timer.add_task(task_name="test", trigger=trigger)

timer.run_forever()
Source code in src/qtasks/timers/async_timer.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
class AsyncTimer(BaseTimer[Literal[True]]):
    """
    A timer running through apscheduler that starts tasks.

    ## Example

    ```python
    from qtasks import QueueTasks
    from qtasks.timers import AsyncTimer

    app = QueueTasks()
    timer = AsyncTimer(app=app)

    trigger = CronTrigger(second="*/10") # Trigger every 10 seconds
    timer.add_task(task_name="test", trigger=trigger)

    timer.run_forever()
    ```
    """

    def __init__(
        self,
        app: Annotated[
            QueueTasks,
            Doc("""
                    Application.
                    """),
        ],
        log: Annotated[
            Logger | None,
            Doc("""
                    Logger.

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

                    Default: `qtasks.configs.config.QueueConfig`.
                    """),
        ] = None,
    ):
        """
        Timer initialization.

        Args:
            app (QueueTasks): Application.
            log (Logger, optional): Logger. Default: `qtasks.logs.Logger`.
            config (QueueConfig, optional): Config. Default: `qtasks.configs.config.QueueConfig`.
        """
        super().__init__(app=app, log=log, config=config)
        self.app: QueueTasks

        self.scheduler = AsyncIOScheduler()
        self.tasks = {}

    def add_task(
        self,
        *args: Annotated[
            Any,
            Doc("""
                    args of the task.

                    Default: `()`.
                    """),
        ],
        task_name: Annotated[
            str,
            Doc("""
                    Task name.
                    """),
        ],
        priority: Annotated[
            int | None,
            Doc("""
                    The task has priority.

                    Default: Task priority value.
                    """),
        ] = None,
        timeout: Annotated[
            float | None,
            Doc("""
                    Task timeout.

                    If specified, the task is returned via `qtasks.results.AsyncTask`.
                    """),
        ] = None,
        trigger: Annotated[
            Any,
            Doc("""
                    Task trigger.
                    """),
        ],
        **kwargs: Annotated[
            Any,
            Doc("""
                    kwargs tasks.

                    Default: `{}`.
                    """),
        ],
    ) -> Job:
        """
        Adding a task.

        Args:
            task_name (str): The name of the task.
            priority (int, optional): Task priority. Default is `0`.
            args (tuple, optional): task args. Defaults to `()`.
            kwargs (dict, optional): kwags tasks. Defaults to `{}`.

        Returns:
            Any|None: Task.
        """
        self.tasks[task_name] = trigger

        return self.scheduler.add_job(
            self._add_task_async,
            trigger=trigger,
            args=(task_name, priority, args, kwargs),
        )

    async def _add_task_async(
        self,
        task_name: Annotated[
            str,
            Doc("""
                    Task name.
                    """),
        ],
        priority: Annotated[
            int,
            Doc("""
                    Task priority.

                    Default: `0`.
                    """),
        ] = 0,
        args: Annotated[
            tuple | None,
            Doc("""
                    args of the task.

                    Default: `()`.
                    """),
        ] = None,
        kwargs: Annotated[
            dict | None,
            Doc("""
                    kwargs tasks.

                    Default: `{}`.
                    """),
        ] = None,
    ):
        """
        Run the added task asynchronously.

        Args:
            task_name (str): The name of the task.
            priority (int, optional): Task priority. Default is `0`.
            args (tuple, optional): task args. Defaults to `()`.
            kwargs (dict, optional): kwags tasks. Defaults to `{}`.
        """
        args, kwargs = args or (), kwargs or {}
        task = await self.app.add_task(
            *args, task_name=task_name, priority=priority, timeout=None, **kwargs
        )
        self.log.info(f"Task {task_name} sent with UUID: {task.uuid}")

    def run_forever(self):
        """Start Timer."""
        self.log.info("Starting...")
        try:
            asyncio.run(
                self._start_scheduler()
            )
        except KeyboardInterrupt:
            self.log.info("Stopping...")

    async def _start_scheduler(self):
        """Start Timer asynchronously."""
        self.scheduler.start()
        while True:
            await asyncio.sleep(1)

__init__(app, log=None, config=None)

Timer initialization.

Parameters:

Name Type Description Default
app QueueTasks

Application.

 required
log Logger

Logger. Default: qtasks.logs.Logger.

 None
config QueueConfig

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

 None
Source code in src/qtasks/timers/async_timer.py 
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
def __init__(
    self,
    app: Annotated[
        QueueTasks,
        Doc("""
                Application.
                """),
    ],
    log: Annotated[
        Logger | None,
        Doc("""
                Logger.

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

                Default: `qtasks.configs.config.QueueConfig`.
                """),
    ] = None,
):
    """
    Timer initialization.

    Args:
        app (QueueTasks): Application.
        log (Logger, optional): Logger. Default: `qtasks.logs.Logger`.
        config (QueueConfig, optional): Config. Default: `qtasks.configs.config.QueueConfig`.
    """
    super().__init__(app=app, log=log, config=config)
    self.app: QueueTasks

    self.scheduler = AsyncIOScheduler()
    self.tasks = {}

add_task(*args, task_name, priority=None, timeout=None, trigger, **kwargs)

Adding a task.

Parameters:

Name Type Description Default
task_name str

The name of the task.

 required
priority int

Task priority. Default is 0.

 None
args tuple

task args. Defaults to ().

 ()
kwargs dict

kwags tasks. Defaults to {}.

 {}

Returns:

Type Description
Job

Any|None: Task.
Source code in src/qtasks/timers/async_timer.py 
 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
def add_task(
    self,
    *args: Annotated[
        Any,
        Doc("""
                args of the task.

                Default: `()`.
                """),
    ],
    task_name: Annotated[
        str,
        Doc("""
                Task name.
                """),
    ],
    priority: Annotated[
        int | None,
        Doc("""
                The task has priority.

                Default: Task priority value.
                """),
    ] = None,
    timeout: Annotated[
        float | None,
        Doc("""
                Task timeout.

                If specified, the task is returned via `qtasks.results.AsyncTask`.
                """),
    ] = None,
    trigger: Annotated[
        Any,
        Doc("""
                Task trigger.
                """),
    ],
    **kwargs: Annotated[
        Any,
        Doc("""
                kwargs tasks.

                Default: `{}`.
                """),
    ],
) -> Job:
    """
    Adding a task.

    Args:
        task_name (str): The name of the task.
        priority (int, optional): Task priority. Default is `0`.
        args (tuple, optional): task args. Defaults to `()`.
        kwargs (dict, optional): kwags tasks. Defaults to `{}`.

    Returns:
        Any|None: Task.
    """
    self.tasks[task_name] = trigger

    return self.scheduler.add_job(
        self._add_task_async,
        trigger=trigger,
        args=(task_name, priority, args, kwargs),
    )

run_forever()

Start Timer.

Source code in src/qtasks/timers/async_timer.py 
194
195
196
197
198
199
200
201
202
def run_forever(self):
    """Start Timer."""
    self.log.info("Starting...")
    try:
        asyncio.run(
            self._start_scheduler()
        )
    except KeyboardInterrupt:
        self.log.info("Stopping...")