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

BaseTaskExecutor - пишем свой исполнитель задачи

Base Task Executor.

BaseTaskExecutor

Bases: ABC

BaseTaskExecutor - Абстрактный класс, который является фундаментом для классов исполнителей задач.

Пример

from qtasks.executors.base import BaseTaskExecutor

class MyTaskExecutor(BaseTaskExecutor):
    def __init__(self, name: str):
        super().__init__(name=name)
        pass
Source code in src/qtasks/executors/base.py 
 15
 16
 17
 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
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
class BaseTaskExecutor(ABC):
    """
    `BaseTaskExecutor` - Абстрактный класс, который является фундаментом для классов исполнителей задач.

    ## Пример

    ```python
    from qtasks.executors.base import BaseTaskExecutor

    class MyTaskExecutor(BaseTaskExecutor):
        def __init__(self, name: str):
            super().__init__(name=name)
            pass
    ```
    """

    def __init__(
        self,
        task_func: Annotated[
            TaskExecSchema,
            Doc(
                """
                    `TaskExecSchema` схема.
                    """
            ),
        ],
        task_broker: Annotated[
            TaskPrioritySchema,
            Doc(
                """
                    `TaskPrioritySchema` схема.
                    """
            ),
        ],
        log: Annotated[
            Optional[Logger],
            Doc(
                """
                    Логгер.

                    По умолчанию: `qtasks.logs.Logger`.
                    """
            ),
        ] = None,
        plugins: Annotated[
            Optional[Dict[str, List[Type["BasePlugin"]]]],
            Doc(
                """
                    Массив Плагинов.

                    По умолчанию: `Пустой массив`.
                    """
            ),
        ] = None,
    ):
        """Инициализация класса. Происходит внутри `Worker` перед обработкой задачи.

        Args:
            task_func (TaskExecSchema): Схема `TaskExecSchema`.
            task_broker (TaskPrioritySchema): Схема `TaskPrioritySchema`.
            log (Logger, optional): класс `qtasks.logs.Logger`. По умолчанию: `qtasks._state.log_main`.
            plugins (Dict[str, List[Type[BasePlugin]]], optional): Словарь плагинов. По умолчанию: `Пустой словарь`.
        """
        self.task_func = task_func
        self.task_broker = task_broker
        self._args = self.task_broker.args.copy()
        self._kwargs = self.task_broker.kwargs.copy()
        self._result: Any = None
        self.echo = None

        self.log = log
        if self.log is None:
            import qtasks._state

            self.log = qtasks._state.log_main
        self.log = self.log.with_subname(self.__class__.__name__)

        self.plugins = plugins or {}

    def before_execute(self):
        """Вызывается перед выполнением задачи."""
        pass

    def after_execute(self):
        """Вызывается после выполнения задачи."""
        pass

    def execute_middlewares_before(self):
        """Вызов мидлварей до выполнения задачи."""
        pass

    def execute_middlewares_after(self):
        """Вызов мидлварей после выполнения задачи."""
        pass

    def run_task(self) -> Any:
        """Вызов задачи.

        Returns:
            Any: Результат задачи.
        """
        pass

    @abstractmethod
    def execute(self, decode: bool = True) -> Union[Any, str]:
        """Обработка задачи.

        Args:
            decode (bool, optional): Декодирование. По умолчанию: `True`.

        Returns:
            Any|str: Результат задачи.
        """
        pass

    def decode(self) -> str:
        """Декодирование задачи.

        Returns:
            str: Результат задачи.
        """
        pass

    def add_plugin(
        self,
        plugin: Annotated[
            "BasePlugin",
            Doc(
                """
                    Плагин.
                    """
            ),
        ],
        trigger_names: Annotated[
            Optional[List[str]],
            Doc(
                """
                    Имя триггеров для плагина.

                    По умолчанию: По умолчанию: будет добавлен в `Globals`.
                    """
            ),
        ] = None,
    ) -> None:
        """Добавить плагин в класс.

        Args:
            plugin (BasePlugin): Плагин
            trigger_names (List[str], optional): Имя триггеров для плагина. По умолчанию: будет добавлен в `Globals`.
        """
        trigger_names = trigger_names or ["Globals"]

        for name in trigger_names:
            if name not in self.plugins:
                self.plugins.update({name: [plugin]})
            else:
                self.plugins[name].append(plugin)
        return

    def _extract_args_kwargs_from_func(self, func: Any) -> Tuple[list, dict]:
        """
        Извлекает значения аргументов из функции, если они заданы как значения по умолчанию.

        Args:
            func (Callable): Функция, из которой извлекаются args и kwargs.

        Returns:
            Tuple[list, dict]: args и kwargs, готовые для передачи в `_build_args_info`.
        """
        sig = inspect.signature(func)
        args = []
        kwargs = {}

        for name, param in sig.parameters.items():
            if param.default is not inspect.Parameter.empty:
                # Именованный аргумент (имеет значение по умолчанию)
                kwargs[name] = param.default
            elif param.kind in (
                inspect.Parameter.POSITIONAL_ONLY,
                inspect.Parameter.POSITIONAL_OR_KEYWORD,
            ):
                # Позиционный аргумент без значения по умолчанию (просто None)
                args.append(None)

        return args, kwargs

    def _build_args_info(self, args: list, kwargs: dict) -> List[ArgMeta]:
        """Строит список ArgMeta из args и kwargs на основе аннотаций функции.

        Args:
            args (list): Позиционные аргументы.
            kwargs (dict): Именованные аргументы.

        Returns:
            List[ArgMeta]: Список метаданных аргументов.
        """
        args_info: List[ArgMeta] = []
        func = self.task_func.func

        try:
            sig = inspect.signature(func)
            parameters = list(sig.parameters.items())
        except (ValueError, TypeError):
            parameters = []

        annotations = getattr(func, "__annotations__", {})

        # Обработка позиционных аргументов
        for idx, value in enumerate(args):
            param_name = parameters[idx][0] if idx < len(parameters) else f"arg{idx}"
            annotation = annotations.get(param_name)
            origin = get_origin(annotation)
            raw_type = get_args(annotation)[0] if get_args(annotation) else annotation
            args_info.append(ArgMeta(
                name=param_name,
                value=value,
                origin=origin,
                raw_type=raw_type,
                annotation=annotation,
                is_kwarg=False,
                index=idx
            ))

        # Обработка именованных аргументов
        for key, value in kwargs.items():
            annotation = annotations.get(key)
            origin = get_origin(annotation)
            raw_type = get_args(annotation)[0] if get_args(annotation) else annotation
            args_info.append(ArgMeta(
                name=key,
                value=value,
                origin=origin,
                raw_type=raw_type,
                annotation=annotation,
                is_kwarg=True,
                key=key
            ))

        return args_info

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

Инициализация класса. Происходит внутри Worker перед обработкой задачи.

Parameters:

Name Type Description Default
task_func TaskExecSchema

Схема TaskExecSchema.

 required
task_broker TaskPrioritySchema

Схема TaskPrioritySchema.

 required
log Logger

класс qtasks.logs.Logger. По умолчанию: qtasks._state.log_main.

 None
plugins Dict[str, List[Type[BasePlugin]]]

Словарь плагинов. По умолчанию: Пустой словарь.

 None
Source code in src/qtasks/executors/base.py 
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
def __init__(
    self,
    task_func: Annotated[
        TaskExecSchema,
        Doc(
            """
                `TaskExecSchema` схема.
                """
        ),
    ],
    task_broker: Annotated[
        TaskPrioritySchema,
        Doc(
            """
                `TaskPrioritySchema` схема.
                """
        ),
    ],
    log: Annotated[
        Optional[Logger],
        Doc(
            """
                Логгер.

                По умолчанию: `qtasks.logs.Logger`.
                """
        ),
    ] = None,
    plugins: Annotated[
        Optional[Dict[str, List[Type["BasePlugin"]]]],
        Doc(
            """
                Массив Плагинов.

                По умолчанию: `Пустой массив`.
                """
        ),
    ] = None,
):
    """Инициализация класса. Происходит внутри `Worker` перед обработкой задачи.

    Args:
        task_func (TaskExecSchema): Схема `TaskExecSchema`.
        task_broker (TaskPrioritySchema): Схема `TaskPrioritySchema`.
        log (Logger, optional): класс `qtasks.logs.Logger`. По умолчанию: `qtasks._state.log_main`.
        plugins (Dict[str, List[Type[BasePlugin]]], optional): Словарь плагинов. По умолчанию: `Пустой словарь`.
    """
    self.task_func = task_func
    self.task_broker = task_broker
    self._args = self.task_broker.args.copy()
    self._kwargs = self.task_broker.kwargs.copy()
    self._result: Any = None
    self.echo = None

    self.log = log
    if self.log is None:
        import qtasks._state

        self.log = qtasks._state.log_main
    self.log = self.log.with_subname(self.__class__.__name__)

    self.plugins = plugins or {}

add_plugin(plugin, trigger_names=None)

Добавить плагин в класс.

Parameters:

Name Type Description Default
plugin BasePlugin

Плагин

 required
trigger_names List[str]

Имя триггеров для плагина. По умолчанию: будет добавлен в Globals.

 None
Source code in src/qtasks/executors/base.py 
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
def add_plugin(
    self,
    plugin: Annotated[
        "BasePlugin",
        Doc(
            """
                Плагин.
                """
        ),
    ],
    trigger_names: Annotated[
        Optional[List[str]],
        Doc(
            """
                Имя триггеров для плагина.

                По умолчанию: По умолчанию: будет добавлен в `Globals`.
                """
        ),
    ] = None,
) -> None:
    """Добавить плагин в класс.

    Args:
        plugin (BasePlugin): Плагин
        trigger_names (List[str], optional): Имя триггеров для плагина. По умолчанию: будет добавлен в `Globals`.
    """
    trigger_names = trigger_names or ["Globals"]

    for name in trigger_names:
        if name not in self.plugins:
            self.plugins.update({name: [plugin]})
        else:
            self.plugins[name].append(plugin)
    return

after_execute()

Вызывается после выполнения задачи.

Source code in src/qtasks/executors/base.py 
 98
 99
100
def after_execute(self):
    """Вызывается после выполнения задачи."""
    pass

before_execute()

Вызывается перед выполнением задачи.

Source code in src/qtasks/executors/base.py 
94
95
96
def before_execute(self):
    """Вызывается перед выполнением задачи."""
    pass

decode()

Декодирование задачи.

Returns:

Name Type Description
str str

Результат задачи.
Source code in src/qtasks/executors/base.py 
130
131
132
133
134
135
136
def decode(self) -> str:
    """Декодирование задачи.

    Returns:
        str: Результат задачи.
    """
    pass

execute(decode=True) abstractmethod

Обработка задачи.

Parameters:

Name Type Description Default
decode bool

Декодирование. По умолчанию: True.

 True

Returns:

Type Description
Union[Any, str]

Any|str: Результат задачи.
Source code in src/qtasks/executors/base.py 
118
119
120
121
122
123
124
125
126
127
128
@abstractmethod
def execute(self, decode: bool = True) -> Union[Any, str]:
    """Обработка задачи.

    Args:
        decode (bool, optional): Декодирование. По умолчанию: `True`.

    Returns:
        Any|str: Результат задачи.
    """
    pass

execute_middlewares_after()

Вызов мидлварей после выполнения задачи.

Source code in src/qtasks/executors/base.py 
106
107
108
def execute_middlewares_after(self):
    """Вызов мидлварей после выполнения задачи."""
    pass

execute_middlewares_before()

Вызов мидлварей до выполнения задачи.

Source code in src/qtasks/executors/base.py 
102
103
104
def execute_middlewares_before(self):
    """Вызов мидлварей до выполнения задачи."""
    pass

run_task()

Вызов задачи.

Returns:

Name Type Description
Any Any

Результат задачи.
Source code in src/qtasks/executors/base.py 
110
111
112
113
114
115
116
def run_task(self) -> Any:
    """Вызов задачи.

    Returns:
        Any: Результат задачи.
    """
    pass