BaseGlobalConfig - Пишем свой глобальный конфиг
Base Configurations.
BaseGlobalConfig
¶
Bases: ABC
BaseGlobalConfig
- Абстрактный класс, который является фундаментом для Глобального Конфига.
Пример¶
from qtasks import QueueTasks
from qtasks.configs.base import BaseGlobalConfig
class MyGlobalConfig(BaseGlobalConfig):
def __init__(self, name: str = None):
super().__init__(name=name)
pass
__init__(name=None, log=None, config=None)
¶
Инициализация контекста.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name
|
str
|
Имя проекта. По умолчанию: |
None
|
log
|
Logger
|
Логгер. По умолчанию: |
None
|
config
|
QueueConfig
|
Конфигурация. По умолчанию: |
None
|
add_plugin(plugin, trigger_names=None)
¶
Добавить плагин в класс.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
plugin
|
BasePlugin
|
Плагин |
required |
trigger_names
|
List[str]
|
Имя триггеров для плагина. По умолчанию: будет добавлен в |
None
|
get(key, name)
abstractmethod
¶
Получить значение.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
Ключ. |
required |
name
|
str
|
Имя. |
required |
Returns:
Name | Type | Description |
---|---|---|
Any |
Any
|
Значение. |
get_all(key)
abstractmethod
¶
Получить все значения.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
Ключ. |
required |
Returns:
Type | Description |
---|---|
dict[Any] | list[Any] | tuple[Any]
|
dict[Any] | list[Any] | tuple[Any]: Значения. |
get_match(match)
abstractmethod
¶
Получить значения по паттерну.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
match
|
str
|
Паттерн. |
required |
Returns:
Type | Description |
---|---|
Any | dict[Any] | list[Any] | tuple[Any]
|
Any | dict[Any] | list[Any] | tuple[Any]: Значение или Значения. |
init_plugins()
¶
Инициализация плагинов.
set(**kwargs)
abstractmethod
¶
Добавить новое значение.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kwargs
|
dict
|
kwags задачи. По умолчанию |
{}
|
start()
abstractmethod
¶
Запуск Брокера. Эта функция задействуется основным экземпляром QueueTasks
через `run_forever.
stop()
abstractmethod
¶
Останавливает Глобальный Конфиг. Эта функция задействуется основным экземпляром QueueTasks
после завершения функции `run_forever.
update_config(config)
¶
Обновляет конфиг брокера.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config
|
QueueConfig
|
Конфиг. |
required |