Skip to content

BaseGlobalConfig - пишем свой GlobalConfig

Base Configurations.

BaseGlobalConfig

Bases: Generic[TAsyncFlag], ABC

BaseGlobalConfig - An abstract class that is the foundation for the Global Config.

Example

from qtasks import QueueTasks
from qtasks.configs.base import BaseGlobalConfig

class MyGlobalConfig(BaseGlobalConfig):
    def __init__(self, name: str = None):
        super().__init__(name=name)
        pass
Source code in src/qtasks/configs/base.py 
 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
class BaseGlobalConfig(Generic[TAsyncFlag], ABC):
    """
    `BaseGlobalConfig` - An abstract class that is the foundation for the Global Config.

    ## Example

    ```python
    from qtasks import QueueTasks
    from qtasks.configs.base import BaseGlobalConfig

    class MyGlobalConfig(BaseGlobalConfig):
        def __init__(self, name: str = None):
            super().__init__(name=name)
            pass
    ```
    """

    def __init__(
        self,
        name: Annotated[
            str | None,
            Doc("""
                    Project name. This name can be used for tags for GlobalConfig.

                    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: `None`.
                    """),
        ] = None,
    ):
        """
        Initializing the context.

        Args:
            name (str, optional): Project name. Default: `None`.
            log (Logger, optional): Logger. Default: `None`.
            config (QueueConfig, optional): Configuration. Default: `None`.
            events (BaseEvents, optional): Events. Default: `None`.
        """
        self.name = name
        self.config_name: str | None = None

        self.config = config or QueueConfig()
        self.log = (
            log.with_subname("GlobalConfig")
            if log
            else Logger(
                name=self.name or "QueueTasks",
                subname="GlobalConfig",
                default_level=self.config.logs_default_level_server,
                format=self.config.logs_format,
            )
        )
        self.events = events
        self.client = None
        self.plugins: dict[str, list[BasePlugin]] = {}

        self.init_plugins()

    @overload
    def set(self: BaseGlobalConfig[Literal[False]], **kwargs) -> None: ...

    @overload
    async def set(self: BaseGlobalConfig[Literal[True]], **kwargs) -> None: ...

    @abstractmethod
    def set(self, **kwargs) -> None | Awaitable[None]:
        """
        Add new value.

        Args:
            kwargs (dict, optional): kwags tasks. Defaults to `{}`.
        """
        pass

    @overload
    def get(self: BaseGlobalConfig[Literal[False]], key: str, name: str) -> Any: ...

    @overload
    async def get(
        self: BaseGlobalConfig[Literal[True]], key: str, name: str
    ) -> Any: ...

    @abstractmethod
    def get(self, key: str, name: str) -> Any | Awaitable[Any]:
        """
        Get value.

        Args:
            key (str): Key.
            name (str): Name.

        Returns:
            Any: Value.
        """
        pass

    @overload
    def get_all(
        self: BaseGlobalConfig[Literal[False]], key: str
    ) -> dict | list | tuple: ...

    @overload
    async def get_all(
        self: BaseGlobalConfig[Literal[True]], key: str
    ) -> dict | list | tuple: ...

    @abstractmethod
    def get_all(
        self, key: str
    ) -> dict | list | tuple | Awaitable[dict | list | tuple]:
        """
        Get all values.

        Args:
            key (str): Key.

        Returns:
            Dict[str, Any] | List[Any] | Tuple[Any]: Values.
        """
        pass

    @overload
    def get_match(self: BaseGlobalConfig[Literal[False]], match: str) -> Any: ...

    @overload
    async def get_match(self: BaseGlobalConfig[Literal[True]], match: str) -> Any: ...

    @abstractmethod
    def get_match(
        self, match: str
    ) -> dict | list | tuple | Awaitable[dict | list | tuple]:
        """
        Get values by pattern.

        Args:
            match (str): Pattern.

        Returns:
            Any | Dict[str, Any] | List[Any] | Tuple[Any]: Value or Values.
        """
        pass

    @overload
    def start(self: BaseGlobalConfig[Literal[False]]) -> None: ...

    @overload
    async def start(self: BaseGlobalConfig[Literal[True]]) -> None: ...

    @abstractmethod
    def start(self) -> None | Awaitable[None]:
        """Launching the Broker. This function is enabled by the main instance of `QueueTasks` via `run_forever."""
        pass

    @overload
    def stop(self: BaseGlobalConfig[Literal[False]]) -> None: ...

    @overload
    async def stop(self: BaseGlobalConfig[Literal[True]]) -> None: ...

    @abstractmethod
    def stop(self) -> None | Awaitable[None]:
        """Stops Global Config. This function is invoked by the main instance of `QueueTasks` after the `run_forever' function completes."""
        pass

    def update_config(
        self,
        config: Annotated[
            QueueConfig,
            Doc("""
                    Config.
                    """),
        ],
    ) -> None:
        """
        Updates the broker config.

        Args:
            config (QueueConfig): Config.
        """
        self.config = config
        return

    def add_plugin(
        self,
        plugin: Annotated[
            BasePlugin,
            Doc("""
                    Plugin.
                    """),
        ],
        trigger_names: Annotated[
            list[str] | None,
            Doc("""
                    The name of the triggers for the plugin.

                    Default: Default: will be added to `Globals`.
                    """),
        ] = None,
    ) -> None:
        """
        Add a plugin to the class.

        Args:
            plugin (BasePlugin): Plugin
            trigger_names (List[str], optional): The name of the triggers for the plugin. Default: will be added to `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 init_plugins(self):
        """Initializing plugins."""
        pass

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

Initializing the context.

Parameters:

Name Type Description Default
name str

Project name. Default: None.

 None
log Logger

Logger. Default: None.

 None
config QueueConfig

Configuration. Default: None.

 None
events BaseEvents

Events. Default: None.

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

                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: `None`.
                """),
    ] = None,
):
    """
    Initializing the context.

    Args:
        name (str, optional): Project name. Default: `None`.
        log (Logger, optional): Logger. Default: `None`.
        config (QueueConfig, optional): Configuration. Default: `None`.
        events (BaseEvents, optional): Events. Default: `None`.
    """
    self.name = name
    self.config_name: str | None = None

    self.config = config or QueueConfig()
    self.log = (
        log.with_subname("GlobalConfig")
        if log
        else Logger(
            name=self.name or "QueueTasks",
            subname="GlobalConfig",
            default_level=self.config.logs_default_level_server,
            format=self.config.logs_format,
        )
    )
    self.events = events
    self.client = None
    self.plugins: dict[str, list[BasePlugin]] = {}

    self.init_plugins()

add_plugin(plugin, trigger_names=None)

Add a plugin to the class.

Parameters:

Name Type Description Default
plugin BasePlugin

Plugin

 required
trigger_names List[str]

The name of the triggers for the plugin. Default: will be added to Globals.

 None
Source code in src/qtasks/configs/base.py 
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
def add_plugin(
    self,
    plugin: Annotated[
        BasePlugin,
        Doc("""
                Plugin.
                """),
    ],
    trigger_names: Annotated[
        list[str] | None,
        Doc("""
                The name of the triggers for the plugin.

                Default: Default: will be added to `Globals`.
                """),
    ] = None,
) -> None:
    """
    Add a plugin to the class.

    Args:
        plugin (BasePlugin): Plugin
        trigger_names (List[str], optional): The name of the triggers for the plugin. Default: will be added to `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

get(key, name) abstractmethod 

get(key: str, name: str) -> Any

get(key: str, name: str) -> Any

Get value.

Parameters:

Name Type Description Default
key str

Key.

 required
name str

Name.

 required

Returns:

Name Type Description
Any Any | Awaitable[Any]

Value.
Source code in src/qtasks/configs/base.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
@abstractmethod
def get(self, key: str, name: str) -> Any | Awaitable[Any]:
    """
    Get value.

    Args:
        key (str): Key.
        name (str): Name.

    Returns:
        Any: Value.
    """
    pass

get_all(key) abstractmethod 

get_all(key: str) -> dict | list | tuple

get_all(key: str) -> dict | list | tuple

Get all values.

Parameters:

Name Type Description Default
key str

Key.

 required

Returns:

Type Description
dict | list | tuple | Awaitable[dict | list | tuple]

Dict[str, Any] | List[Any] | Tuple[Any]: Values.
Source code in src/qtasks/configs/base.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
@abstractmethod
def get_all(
    self, key: str
) -> dict | list | tuple | Awaitable[dict | list | tuple]:
    """
    Get all values.

    Args:
        key (str): Key.

    Returns:
        Dict[str, Any] | List[Any] | Tuple[Any]: Values.
    """
    pass

get_match(match) abstractmethod 

get_match(match: str) -> Any

get_match(match: str) -> Any

Get values by pattern.

Parameters:

Name Type Description Default
match str

Pattern.

 required

Returns:

Type Description
dict | list | tuple | Awaitable[dict | list | tuple]

Any | Dict[str, Any] | List[Any] | Tuple[Any]: Value or Values.
Source code in src/qtasks/configs/base.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
@abstractmethod
def get_match(
    self, match: str
) -> dict | list | tuple | Awaitable[dict | list | tuple]:
    """
    Get values by pattern.

    Args:
        match (str): Pattern.

    Returns:
        Any | Dict[str, Any] | List[Any] | Tuple[Any]: Value or Values.
    """
    pass

init_plugins()

Initializing plugins.

Source code in src/qtasks/configs/base.py 
265
266
267
def init_plugins(self):
    """Initializing plugins."""
    pass

set(**kwargs) abstractmethod 

set(**kwargs) -> None

set(**kwargs) -> None

Add new value.

Parameters:

Name Type Description Default
kwargs dict

kwags tasks. Defaults to {}.

 {}
Source code in src/qtasks/configs/base.py 
114
115
116
117
118
119
120
121
122
@abstractmethod
def set(self, **kwargs) -> None | Awaitable[None]:
    """
    Add new value.

    Args:
        kwargs (dict, optional): kwags tasks. Defaults to `{}`.
    """
    pass

start() abstractmethod 

start() -> None

start() -> None

Launching the Broker. This function is enabled by the main instance of QueueTasks via `run_forever.

Source code in src/qtasks/configs/base.py 
198
199
200
201
@abstractmethod
def start(self) -> None | Awaitable[None]:
    """Launching the Broker. This function is enabled by the main instance of `QueueTasks` via `run_forever."""
    pass

stop() abstractmethod 

stop() -> None

stop() -> None

Stops Global Config. This function is invoked by the main instance of QueueTasks after the `run_forever' function completes.

Source code in src/qtasks/configs/base.py 
209
210
211
212
@abstractmethod
def stop(self) -> None | Awaitable[None]:
    """Stops Global Config. This function is invoked by the main instance of `QueueTasks` after the `run_forever' function completes."""
    pass

update_config(config)

Updates the broker config.

Parameters:

Name Type Description Default
config QueueConfig

Config.

 required
Source code in src/qtasks/configs/base.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
def update_config(
    self,
    config: Annotated[
        QueueConfig,
        Doc("""
                Config.
                """),
    ],
) -> None:
    """
    Updates the broker config.

    Args:
        config (QueueConfig): Config.
    """
    self.config = config
    return