Skip to content

SyncTaskExecutor

Sync Task Executor.

SyncTaskExecutor

Bases: BaseTaskExecutor, SyncPluginMixin

SyncTaskExecutor - Synchronous task executor class. Used by default in SyncThreadWorker.

Example

from qtasks.executors import SyncTaskExecutor

task_func = TaskExecSchema(...)
task_broker = TaskPrioritySchema(...)
executor = SyncTaskExecutor(task_func, task_broker)
result = executor.execute()
Source code in src/qtasks/executors/sync_task_executor.py 
 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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
class SyncTaskExecutor(BaseTaskExecutor, SyncPluginMixin):
    """
    `SyncTaskExecutor` - Synchronous task executor class. Used by default in `SyncThreadWorker`.

    ## Example

    ```python
    from qtasks.executors import SyncTaskExecutor

    task_func = TaskExecSchema(...)
    task_broker = TaskPrioritySchema(...)
    executor = SyncTaskExecutor(task_func, task_broker)
    result = executor.execute()
    ```
    """

    def __init__(
        self,
        task_func: Annotated[
            TaskExecSchema,
            Doc("""
                    `TaskExecSchema` schema.
                    """),
        ],
        task_broker: Annotated[
            TaskPrioritySchema,
            Doc("""
                    `TaskPrioritySchema` schema.
                    """),
        ],
        log: Annotated[
            Logger | None,
            Doc("""
                    Logger.

                    Default: `qtasks.logs.Logger`.
                    """),
        ] = None,
        plugins: Annotated[
            dict[str, list[BasePlugin]] | None,
            Doc("""
                    Array of Plugins.

                    Default: `Empty array`.
                    """),
        ] = None,
    ):
        """
        Initializing the class. Occurs inside a `Worker` before a task is processed.

        Args:
            task_func (TaskExecSchema): Schema `TaskExecSchema`.
            task_broker(TaskPrioritySchema): Schema `TaskPrioritySchema`.
            log (Logger, optional): class `qtasks.logs.Logger`. Default: `qtasks._state.log_main`.
            plugins (Dict[str, List[BasePlugin]], optional): Plugin dictionary. Default: `Empty dictionary`.
        """
        super().__init__(
            task_func=task_func,
            task_broker=task_broker,
            log=log,
            plugins=plugins,
        )

    def before_execute(self):
        """Called before a task is executed."""
        if self.task_func.echo:
            self.echo = SyncTask(
                task_name=self.task_broker.name,
                priority=self.task_broker.priority,
                echo=self.task_func.echo,
                retry=self.task_func.retry,
                retry_on_exc=self.task_func.retry_on_exc,
                decode=self.task_func.decode,
                tags=self.task_func.tags,
                description=self.task_func.description,
                executor=self.task_func.executor,
                middlewares_before=self.task_func.middlewares_before,
                middlewares_after=self.task_func.middlewares_after,
                extra=self.task_func.extra,
            )
            self.echo.ctx._update(task_uuid=self.task_broker.uuid)
            self._args.insert(0, self.echo)

        args_from_func = self._extract_args_kwargs_from_func(self.task_func.func)
        args_info = self._build_args_info(args_from_func[0], args_from_func[1])
        new_args = self._plugin_trigger(
            "task_executor_args_replace",
            task_executor=self,
            **{
                "args": self._args,
                "kw": self._kwargs,
                "args_info": args_info,
            },
            return_last=True,
        )
        if new_args:
            kw: dict = new_args.get("kw")  # type: ignore
            if not kw:
                self._args = kw.get("args", self._args)
                self._kwargs = kw.get("kw", self._kwargs)

        self._plugin_trigger("task_executor_before_execute", task_executor=self)

    def after_execute(self):
        """Called after a task has completed."""
        self._plugin_trigger("task_executor_after_execute", task_executor=self)
        result = self._plugin_trigger(
            "task_executor_after_execute_result_replace",
            task_executor=self,
            result=self._result,
            return_last=True,
        )
        if result:
            self._result = result.get("result", self._result)
        return

    def execute_middlewares_before(self):
        """Calling middleware before the task is completed."""
        self._plugin_trigger(
            "task_executor_middlewares_execute",
            task_executor=self,
            middlewares_before=self.task_func.middlewares_before,
        )
        for m in self.task_func.middlewares_before:
            m = m(self)
            new_task_executor: BaseTaskExecutor = m()
            if new_task_executor:
                self = new_task_executor
            self.log.debug(f"Middleware {m.name} for {self.task_func.name} was called.")

    def execute_middlewares_after(self):
        """Calling middleware after completing a task."""
        self._plugin_trigger(
            "task_executor_middlewares_execute",
            task_executor=self,
            middlewares_after=self.task_func.middlewares_after,
        )
        for m in self.task_func.middlewares_after:
            m = m(self)
            new_task_executor: BaseTaskExecutor = m()
            if new_task_executor:
                self = new_task_executor
            self.log.debug(f"Middleware {m.name} for {self.task_func.name} was called.")

    def run_task(self) -> Any | list:
        """
        Calling a task.

        Returns:
            Any: Result of the task.
        """
        if self._args and self._kwargs:
            result = self.task_func.func(*self._args, **self._kwargs)
        elif self._args:
            result = self.task_func.func(*self._args)
        elif self._kwargs:
            result = self.task_func.func(**self._kwargs)
        else:
            result = self.task_func.func()

        if self.task_func.generating:
            return self.run_task_gen(result)

        new_result = self._plugin_trigger(
            "task_executor_run_task", task_executor=self, result=result
        )
        if new_result:
            result = new_result.get("result", result)

        return result

    def run_task_gen(self, func: Generator) -> list[Any]:
        """
        Calling the task generator.

        Args:
            func(FunctionType): Function.

        Raises:
            RuntimeError: Unable to run synchronous task generator in synchronous form!

        Returns:
            Any: Result of the task.
        """
        if self.echo:
            self.echo.ctx._update(generate_handler=self.task_func.generate_handler)

        results = []
        if self.task_func.generating == "async":
            raise RuntimeError(
                "Cannot run an async task generator in synchronous mode!"
            )

        elif self.task_func.generating == "sync":
            try:
                while True:
                    result = next(func)
                    if self.task_func.generate_handler:
                        result = self.task_func.generate_handler(result)
                    results.append(result)
            except StopIteration:
                pass

        new_results = self._plugin_trigger(
            "task_executor_run_task_gen", task_executor=self, results=results
        )
        if new_results:
            results = new_results.get("results", results)
        return results

    def execute(self, decode: bool = True) -> Any | str:
        """
        Calling a task.

        Args:
            decode (bool, optional): Decoding the result of the task. Default: True.

        Returns:
            Any|str: Result of the task.
        """
        if self.log:
            self.log.debug(f"Called execute for {self.task_func.name}")

        self.before_execute()
        self.execute_middlewares_before()
        try:
            if self.task_func.max_time:
                with ThreadPoolExecutor(max_workers=1) as executor:
                    future = executor.submit(self.run_task)
                    self._result = future.result(timeout=self.task_func.max_time)
            else:
                self._result = self.run_task()
        except TaskPluginTriggerError as e:
            new_result = self._plugin_trigger(
                "task_executor_run_task_trigger_error",
                task_executor=self,
                task_func=self.task_func,
                task_broker=self.task_broker,
                e=e,
                return_last=True,
            )
            if new_result:
                self._result = new_result.get("result", self._result)
            else:
                raise e
        except TimeoutError as exc:
            msg = f"Time limit exceeded for task {self.task_func.name}: {self.task_func.max_time} seconds"
            if self.log:
                self.log.error(msg)
            raise TimeoutError(msg) from exc

        self.after_execute()
        self.execute_middlewares_after()
        if decode:
            self._result = self.decode()

        self._plugin_trigger(
            "task_executor_task_close",
            task_executor=self,
            task_func=self.task_func,
            task_broker=self.task_broker
        )
        return self._result

    def decode(self) -> Any:
        """
        Decoding the task.

        Returns:
            Any: Result of the task.
        """
        if self.task_func.decode is not None:
            result = self.task_func.decode(self._result)
        else:
            result = json.dumps(self._result, ensure_ascii=False)
        new_result = self._plugin_trigger(
            "task_executor_decode", task_executor=self, result=result
        )
        if new_result:
            result = new_result.get("result", result)
        return result

__init__(task_func, task_broker, log=None, plugins=None)

Initializing the class. Occurs inside a Worker before a task is processed.

Parameters:

Name Type Description Default
task_func TaskExecSchema

Schema TaskExecSchema.

 required
task_broker TaskPrioritySchema

Schema TaskPrioritySchema.

 required
log Logger

class qtasks.logs.Logger. Default: qtasks._state.log_main.

 None
plugins Dict[str, List[BasePlugin]]

Plugin dictionary. Default: Empty dictionary.

 None
Source code in src/qtasks/executors/sync_task_executor.py 
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
def __init__(
    self,
    task_func: Annotated[
        TaskExecSchema,
        Doc("""
                `TaskExecSchema` schema.
                """),
    ],
    task_broker: Annotated[
        TaskPrioritySchema,
        Doc("""
                `TaskPrioritySchema` schema.
                """),
    ],
    log: Annotated[
        Logger | None,
        Doc("""
                Logger.

                Default: `qtasks.logs.Logger`.
                """),
    ] = None,
    plugins: Annotated[
        dict[str, list[BasePlugin]] | None,
        Doc("""
                Array of Plugins.

                Default: `Empty array`.
                """),
    ] = None,
):
    """
    Initializing the class. Occurs inside a `Worker` before a task is processed.

    Args:
        task_func (TaskExecSchema): Schema `TaskExecSchema`.
        task_broker(TaskPrioritySchema): Schema `TaskPrioritySchema`.
        log (Logger, optional): class `qtasks.logs.Logger`. Default: `qtasks._state.log_main`.
        plugins (Dict[str, List[BasePlugin]], optional): Plugin dictionary. Default: `Empty dictionary`.
    """
    super().__init__(
        task_func=task_func,
        task_broker=task_broker,
        log=log,
        plugins=plugins,
    )

after_execute()

Called after a task has completed.

Source code in src/qtasks/executors/sync_task_executor.py 
126
127
128
129
130
131
132
133
134
135
136
137
def after_execute(self):
    """Called after a task has completed."""
    self._plugin_trigger("task_executor_after_execute", task_executor=self)
    result = self._plugin_trigger(
        "task_executor_after_execute_result_replace",
        task_executor=self,
        result=self._result,
        return_last=True,
    )
    if result:
        self._result = result.get("result", self._result)
    return

before_execute()

Called before a task is executed.

Source code in src/qtasks/executors/sync_task_executor.py 
 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
def before_execute(self):
    """Called before a task is executed."""
    if self.task_func.echo:
        self.echo = SyncTask(
            task_name=self.task_broker.name,
            priority=self.task_broker.priority,
            echo=self.task_func.echo,
            retry=self.task_func.retry,
            retry_on_exc=self.task_func.retry_on_exc,
            decode=self.task_func.decode,
            tags=self.task_func.tags,
            description=self.task_func.description,
            executor=self.task_func.executor,
            middlewares_before=self.task_func.middlewares_before,
            middlewares_after=self.task_func.middlewares_after,
            extra=self.task_func.extra,
        )
        self.echo.ctx._update(task_uuid=self.task_broker.uuid)
        self._args.insert(0, self.echo)

    args_from_func = self._extract_args_kwargs_from_func(self.task_func.func)
    args_info = self._build_args_info(args_from_func[0], args_from_func[1])
    new_args = self._plugin_trigger(
        "task_executor_args_replace",
        task_executor=self,
        **{
            "args": self._args,
            "kw": self._kwargs,
            "args_info": args_info,
        },
        return_last=True,
    )
    if new_args:
        kw: dict = new_args.get("kw")  # type: ignore
        if not kw:
            self._args = kw.get("args", self._args)
            self._kwargs = kw.get("kw", self._kwargs)

    self._plugin_trigger("task_executor_before_execute", task_executor=self)

decode()

Decoding the task.

Returns:

Name Type Description
Any Any

Result of the task.
Source code in src/qtasks/executors/sync_task_executor.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
def decode(self) -> Any:
    """
    Decoding the task.

    Returns:
        Any: Result of the task.
    """
    if self.task_func.decode is not None:
        result = self.task_func.decode(self._result)
    else:
        result = json.dumps(self._result, ensure_ascii=False)
    new_result = self._plugin_trigger(
        "task_executor_decode", task_executor=self, result=result
    )
    if new_result:
        result = new_result.get("result", result)
    return result

execute(decode=True)

Calling a task.

Parameters:

Name Type Description Default
decode bool

Decoding the result of the task. Default: True.

 True

Returns:

Type Description
Any | str

Any|str: Result of the task.
Source code in src/qtasks/executors/sync_task_executor.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
def execute(self, decode: bool = True) -> Any | str:
    """
    Calling a task.

    Args:
        decode (bool, optional): Decoding the result of the task. Default: True.

    Returns:
        Any|str: Result of the task.
    """
    if self.log:
        self.log.debug(f"Called execute for {self.task_func.name}")

    self.before_execute()
    self.execute_middlewares_before()
    try:
        if self.task_func.max_time:
            with ThreadPoolExecutor(max_workers=1) as executor:
                future = executor.submit(self.run_task)
                self._result = future.result(timeout=self.task_func.max_time)
        else:
            self._result = self.run_task()
    except TaskPluginTriggerError as e:
        new_result = self._plugin_trigger(
            "task_executor_run_task_trigger_error",
            task_executor=self,
            task_func=self.task_func,
            task_broker=self.task_broker,
            e=e,
            return_last=True,
        )
        if new_result:
            self._result = new_result.get("result", self._result)
        else:
            raise e
    except TimeoutError as exc:
        msg = f"Time limit exceeded for task {self.task_func.name}: {self.task_func.max_time} seconds"
        if self.log:
            self.log.error(msg)
        raise TimeoutError(msg) from exc

    self.after_execute()
    self.execute_middlewares_after()
    if decode:
        self._result = self.decode()

    self._plugin_trigger(
        "task_executor_task_close",
        task_executor=self,
        task_func=self.task_func,
        task_broker=self.task_broker
    )
    return self._result

execute_middlewares_after()

Calling middleware after completing a task.

Source code in src/qtasks/executors/sync_task_executor.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
def execute_middlewares_after(self):
    """Calling middleware after completing a task."""
    self._plugin_trigger(
        "task_executor_middlewares_execute",
        task_executor=self,
        middlewares_after=self.task_func.middlewares_after,
    )
    for m in self.task_func.middlewares_after:
        m = m(self)
        new_task_executor: BaseTaskExecutor = m()
        if new_task_executor:
            self = new_task_executor
        self.log.debug(f"Middleware {m.name} for {self.task_func.name} was called.")

execute_middlewares_before()

Calling middleware before the task is completed.

Source code in src/qtasks/executors/sync_task_executor.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
def execute_middlewares_before(self):
    """Calling middleware before the task is completed."""
    self._plugin_trigger(
        "task_executor_middlewares_execute",
        task_executor=self,
        middlewares_before=self.task_func.middlewares_before,
    )
    for m in self.task_func.middlewares_before:
        m = m(self)
        new_task_executor: BaseTaskExecutor = m()
        if new_task_executor:
            self = new_task_executor
        self.log.debug(f"Middleware {m.name} for {self.task_func.name} was called.")

run_task()

Calling a task.

Returns:

Name Type Description
Any Any | list

Result of the task.
Source code in src/qtasks/executors/sync_task_executor.py 
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
def run_task(self) -> Any | list:
    """
    Calling a task.

    Returns:
        Any: Result of the task.
    """
    if self._args and self._kwargs:
        result = self.task_func.func(*self._args, **self._kwargs)
    elif self._args:
        result = self.task_func.func(*self._args)
    elif self._kwargs:
        result = self.task_func.func(**self._kwargs)
    else:
        result = self.task_func.func()

    if self.task_func.generating:
        return self.run_task_gen(result)

    new_result = self._plugin_trigger(
        "task_executor_run_task", task_executor=self, result=result
    )
    if new_result:
        result = new_result.get("result", result)

    return result

run_task_gen(func)

Calling the task generator.

Parameters:

Name Type Description Default
func FunctionType

Function.

 required

Raises:

Type Description
RuntimeError

Unable to run synchronous task generator in synchronous form!

Returns:

Name Type Description
Any list[Any]

Result of the task.
Source code in src/qtasks/executors/sync_task_executor.py 
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
def run_task_gen(self, func: Generator) -> list[Any]:
    """
    Calling the task generator.

    Args:
        func(FunctionType): Function.

    Raises:
        RuntimeError: Unable to run synchronous task generator in synchronous form!

    Returns:
        Any: Result of the task.
    """
    if self.echo:
        self.echo.ctx._update(generate_handler=self.task_func.generate_handler)

    results = []
    if self.task_func.generating == "async":
        raise RuntimeError(
            "Cannot run an async task generator in synchronous mode!"
        )

    elif self.task_func.generating == "sync":
        try:
            while True:
                result = next(func)
                if self.task_func.generate_handler:
                    result = self.task_func.generate_handler(result)
                results.append(result)
        except StopIteration:
            pass

    new_results = self._plugin_trigger(
        "task_executor_run_task_gen", task_executor=self, results=results
    )
    if new_results:
        results = new_results.get("results", results)
    return results