mirror of https://github.com/coddrago/Heroku
140 lines
4.1 KiB
Python
140 lines
4.1 KiB
Python
import logging
|
|
from dataclasses import dataclass, field
|
|
from typing import Union, Any, Optional
|
|
from telethon.tl.types import Message
|
|
from . import utils
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Module:
|
|
strings = {"name": "Unknown"}
|
|
|
|
"""There is no help for this module"""
|
|
|
|
def config_complete(self):
|
|
"""Called when module.config is populated"""
|
|
|
|
async def client_ready(self, client, db):
|
|
"""Called after client is ready (after config_loaded)"""
|
|
|
|
async def on_unload(self):
|
|
"""Called after unloading / reloading module"""
|
|
|
|
async def _client_ready2(self, client, db):
|
|
"""Called after client_ready, for internal use only. Must not be used by non-core modules"""
|
|
|
|
async def on_dlmod(self, client, db):
|
|
"""
|
|
Called after the module is first time loaded with .dlmod or .loadmod
|
|
|
|
Possible use-cases:
|
|
- Send reaction to author's channel message
|
|
- Join author's channel
|
|
- Create asset folder
|
|
- ...
|
|
|
|
⚠️ Note, that any error there will not interrupt module load, and will just
|
|
send a message to logs with verbosity INFO and exception traceback
|
|
"""
|
|
|
|
|
|
class LoadError(Exception):
|
|
"""Tells user, why your module can't be loaded, if rased in `client_ready`"""
|
|
|
|
def __init__(self, error_message: str): # skipcq: PYL-W0231
|
|
self._error = error_message
|
|
|
|
def __str__(self) -> str:
|
|
return self._error
|
|
|
|
|
|
class SelfUnload(Exception):
|
|
"""Silently unloads module, if raised in `client_ready`"""
|
|
|
|
def __init__(self, error_message: Optional[str] = ""): # skipcq: PYL-W0231
|
|
self._error = error_message
|
|
|
|
def __str__(self) -> str:
|
|
return self._error
|
|
|
|
|
|
class StopLoop(Exception):
|
|
"""Stops the loop, in which is raised"""
|
|
|
|
|
|
class ModuleConfig(dict):
|
|
"""Stores config for each mod, that needs them"""
|
|
|
|
def __init__(self, *entries):
|
|
if all(isinstance(entry, ConfigValue) for entry in entries):
|
|
self._config = {config.option: config for config in entries}
|
|
else:
|
|
keys = []
|
|
values = []
|
|
defaults = []
|
|
docstrings = []
|
|
for i, entry in enumerate(entries):
|
|
if i % 3 == 0:
|
|
keys += [entry]
|
|
elif i % 3 == 1:
|
|
values += [entry]
|
|
defaults += [entry]
|
|
else:
|
|
docstrings += [entry]
|
|
|
|
self._config = {
|
|
key: ConfigValue(option=key, default=default, doc=doc)
|
|
for key, default, doc in zip(keys, defaults, docstrings)
|
|
}
|
|
|
|
super().__init__(
|
|
{option: config.value for option, config in self._config.items()}
|
|
)
|
|
|
|
def getdoc(self, key: str, message: Message = None) -> str:
|
|
"""Get the documentation by key"""
|
|
ret = self._config[key].doc
|
|
|
|
if callable(ret):
|
|
ret = ret()
|
|
|
|
return ret
|
|
|
|
def getdef(self, key: str) -> str:
|
|
"""Get the default value by key"""
|
|
return self._config[key].default
|
|
|
|
def __setitem__(self, key: str, value: Any) -> bool:
|
|
self._config[key].value = value
|
|
return dict.__setitem__(self, key, value)
|
|
|
|
def __getitem__(self, key: str) -> Any:
|
|
try:
|
|
return self._config[key].value
|
|
except KeyError:
|
|
return None
|
|
|
|
|
|
class _Placeholder:
|
|
"""Placeholder to determine if the default value is going to be set"""
|
|
|
|
|
|
@dataclass(repr=True)
|
|
class ConfigValue:
|
|
option: str
|
|
default: Any = None
|
|
value: Any = field(default_factory=_Placeholder)
|
|
doc: Union[callable, str] = "No description"
|
|
|
|
def __post_init__(self):
|
|
if isinstance(self.value, _Placeholder):
|
|
self.value = self.default
|
|
|
|
def __setattr__(self, key: str, value: Any) -> bool:
|
|
if key == "value":
|
|
# This attribute will tell the `Loader` to save this value in db
|
|
self._save_marker = True
|
|
|
|
object.__setattr__(self, key, value)
|