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

SyncTimer

Sync timer for scheduling tasks.

SyncTimer

Bases: BaseTimer

Таймер, работающий через apscheduler, запускающий задачи.

Пример

from qtasks import QueueTasks
from qtasks.timers import SyncTimer

app = QueueTasks()
timer = SyncTimer(app=app)

trigger = CronTrigger(second="*/10") # Запуск каждые 10 секунд
timer.add_task(task_name="test", trigger=trigger)

timer.run_forever()
Source code in src/qtasks/timers/sync_timer.py 
 18
 19
 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
220
221
222
223
224
225
class SyncTimer(BaseTimer):
    """
    Таймер, работающий через apscheduler, запускающий задачи.

    ## Пример

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

    app = QueueTasks()
    timer = SyncTimer(app=app)

    trigger = CronTrigger(second="*/10") # Запуск каждые 10 секунд
    timer.add_task(task_name="test", trigger=trigger)

    timer.run_forever()
    ```
    """

    def __init__(
        self,
        app: Annotated[
            "QueueTasks",
            Doc(
                """
                    Приложение.
                    """
            ),
        ],
        log: Annotated[
            Optional[Logger],
            Doc(
                """
                    Логгер.

                    По умолчанию: `qtasks.logs.Logger`.
                    """
            ),
        ] = None,
        config: Annotated[
            Optional[QueueConfig],
            Doc(
                """
                    Конфиг.

                    По умолчанию: `qtasks.configs.config.QueueConfig`.
                    """
            ),
        ] = None,
    ):
        """Инициализация таймера.

        Args:
            app (QueueTasks): Приложение.
            log (Logger, optional): Логгер. По умолчанию: `qtasks.logs.Logger`.
            config (QueueConfig, optional): Конфиг. По умолчанию: `qtasks.configs.config.QueueConfig`.
        """
        super().__init__(app=app, log=log, config=config)
        self.app: "QueueTasks"
        self.scheduler = BackgroundScheduler()
        self.tasks = {}

    def add_task(
        self,
        *args: Annotated[
            Optional[tuple],
            Doc(
                """
                    args задачи.

                    По умолчанию: `()`.
                    """
            ),
        ],
        task_name: Annotated[
            str,
            Doc(
                """
                    Имя задачи.
                    """
            ),
        ],
        priority: Annotated[
            Optional[int],
            Doc(
                """
                    Приоритет у задачи.

                    По умолчанию: Значение приоритета у задачи.
                    """
            ),
        ] = None,
        timeout: Annotated[
            Optional[float],
            Doc(
                """
                    Таймаут задачи.

                    Если указан, задача возвращается через `qtasks.results.AsyncTask`.
                    """
            ),
        ] = None,
        trigger: Annotated[
            Any,
            Doc(
                """
                    Триггер задачи.
                    """
            ),
        ],
        **kwargs: Annotated[
            Optional[dict],
            Doc(
                """
                    kwargs задачи.

                    По умолчанию: `{}`.
                    """
            ),
        ]
    ) -> Job:
        """Добавление задачи.

        Args:
            task_name (str): Имя задачи.
            priority (int, optional): Приоритет задачи. По умолчанию `0`.
            args (tuple, optional): args задачи. По умолчанию `()`.
            kwargs (dict, optional): kwags задачи. По умолчанию `{}`.

        Returns:
            Any|None: Задача.
        """
        self.tasks[task_name] = trigger

        # Добавляем синхронную задачу
        return self.scheduler.add_job(
            self._add_task_sync,
            trigger=trigger,
            args=(task_name, priority, args, kwargs),
        )

    def _add_task_sync(
        self,
        task_name: Annotated[
            str,
            Doc(
                """
                    Название задачи.
                    """
            ),
        ],
        priority: Annotated[
            int,
            Doc(
                """
                    Приоритет задачи.

                    По умолчанию: `0`.
                    """
            ),
        ] = 0,
        args: Annotated[
            Optional[tuple],
            Doc(
                """
                    args задачи.

                    По умолчанию: `()`.
                    """
            ),
        ] = None,
        kwargs: Annotated[
            Optional[dict],
            Doc(
                """
                    kwargs задачи.

                    По умолчанию: `{}`.
                    """
            ),
        ] = None,
    ):
        """Запуск добавленной задачи синхронно.

        Args:
            task_name (str): Имя задачи.
            priority (int, optional): Приоритет задачи. По умолчанию `0`.
            args (tuple, optional): args задачи. По умолчанию `()`.
            kwargs (dict, optional): kwags задачи. По умолчанию `{}`.
        """
        task = self.app.add_task(
            *args, task_name=task_name, priority=priority, **kwargs
        )
        self.log.info(f"Отправлена задача {task_name}: {task.uuid}...")

    def run_forever(self):
        """Запуск Таймера."""
        self.log.info("Запуск...")

        try:
            self.scheduler.start()  # Запускаем планировщик
            while True:
                sleep(1)
                pass  # Держим основной поток активным
        except KeyboardInterrupt:
            self.log.info("Остановка...")
            self.scheduler.shutdown()

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

Инициализация таймера.

Parameters:

Name Type Description Default
app QueueTasks

Приложение.

 required
log Logger

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

 None
config QueueConfig

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

 None
Source code in src/qtasks/timers/sync_timer.py 
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
def __init__(
    self,
    app: Annotated[
        "QueueTasks",
        Doc(
            """
                Приложение.
                """
        ),
    ],
    log: Annotated[
        Optional[Logger],
        Doc(
            """
                Логгер.

                По умолчанию: `qtasks.logs.Logger`.
                """
        ),
    ] = None,
    config: Annotated[
        Optional[QueueConfig],
        Doc(
            """
                Конфиг.

                По умолчанию: `qtasks.configs.config.QueueConfig`.
                """
        ),
    ] = None,
):
    """Инициализация таймера.

    Args:
        app (QueueTasks): Приложение.
        log (Logger, optional): Логгер. По умолчанию: `qtasks.logs.Logger`.
        config (QueueConfig, optional): Конфиг. По умолчанию: `qtasks.configs.config.QueueConfig`.
    """
    super().__init__(app=app, log=log, config=config)
    self.app: "QueueTasks"
    self.scheduler = BackgroundScheduler()
    self.tasks = {}

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

Добавление задачи.

Parameters:

Name Type Description Default
task_name str

Имя задачи.

 required
priority int

Приоритет задачи. По умолчанию 0.

 None
args tuple

args задачи. По умолчанию ().

 ()
kwargs dict

kwags задачи. По умолчанию {}.

 {}

Returns:

Type Description
Job

Any|None: Задача.
Source code in src/qtasks/timers/sync_timer.py 
 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
def add_task(
    self,
    *args: Annotated[
        Optional[tuple],
        Doc(
            """
                args задачи.

                По умолчанию: `()`.
                """
        ),
    ],
    task_name: Annotated[
        str,
        Doc(
            """
                Имя задачи.
                """
        ),
    ],
    priority: Annotated[
        Optional[int],
        Doc(
            """
                Приоритет у задачи.

                По умолчанию: Значение приоритета у задачи.
                """
        ),
    ] = None,
    timeout: Annotated[
        Optional[float],
        Doc(
            """
                Таймаут задачи.

                Если указан, задача возвращается через `qtasks.results.AsyncTask`.
                """
        ),
    ] = None,
    trigger: Annotated[
        Any,
        Doc(
            """
                Триггер задачи.
                """
        ),
    ],
    **kwargs: Annotated[
        Optional[dict],
        Doc(
            """
                kwargs задачи.

                По умолчанию: `{}`.
                """
        ),
    ]
) -> Job:
    """Добавление задачи.

    Args:
        task_name (str): Имя задачи.
        priority (int, optional): Приоритет задачи. По умолчанию `0`.
        args (tuple, optional): args задачи. По умолчанию `()`.
        kwargs (dict, optional): kwags задачи. По умолчанию `{}`.

    Returns:
        Any|None: Задача.
    """
    self.tasks[task_name] = trigger

    # Добавляем синхронную задачу
    return self.scheduler.add_job(
        self._add_task_sync,
        trigger=trigger,
        args=(task_name, priority, args, kwargs),
    )

run_forever()

Запуск Таймера.

Source code in src/qtasks/timers/sync_timer.py 
214
215
216
217
218
219
220
221
222
223
224
225
def run_forever(self):
    """Запуск Таймера."""
    self.log.info("Запуск...")

    try:
        self.scheduler.start()  # Запускаем планировщик
        while True:
            sleep(1)
            pass  # Держим основной поток активным
    except KeyboardInterrupt:
        self.log.info("Остановка...")
        self.scheduler.shutdown()