165 lines
4.5 KiB
Python
165 lines
4.5 KiB
Python
# Copyright: Ankitects Pty Ltd and contributors
|
|
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
"""
|
|
Code for generating parts of hooks.py
|
|
"""
|
|
|
|
import re
|
|
from dataclasses import dataclass
|
|
from operator import attrgetter
|
|
from typing import List, Optional
|
|
|
|
import stringcase
|
|
|
|
|
|
@dataclass
|
|
class Hook:
|
|
# the name of the hook. _filter or _hook is appending automatically.
|
|
name: str
|
|
# string of the typed arguments passed to the callback, eg
|
|
# ["kind: str", "val: int"]
|
|
args: List[str] = None
|
|
# string of the return type. if set, hook is a filter.
|
|
return_type: Optional[str] = None
|
|
# if add-ons may be relying on the legacy hook name, add it here
|
|
legacy_hook: Optional[str] = None
|
|
# if legacy hook takes no arguments but the new hook does, set this
|
|
legacy_no_args: bool = False
|
|
# docstring to add to hook class
|
|
doc: Optional[str] = None
|
|
|
|
def callable(self) -> str:
|
|
"Convert args into a Callable."
|
|
types = []
|
|
for arg in self.args or []:
|
|
(name, type) = arg.split(":")
|
|
if "." in type:
|
|
type = '"' + type.strip() + '"'
|
|
types.append(type)
|
|
types_str = ", ".join(types)
|
|
return f"Callable[[{types_str}], {self.return_type or 'None'}]"
|
|
|
|
def arg_names(self) -> List[str]:
|
|
names = []
|
|
for arg in self.args or []:
|
|
if not arg:
|
|
continue
|
|
(name, type) = arg.split(":")
|
|
names.append(name.strip())
|
|
return names
|
|
|
|
def full_name(self) -> str:
|
|
return f"{self.name}_{self.kind()}"
|
|
|
|
def kind(self) -> str:
|
|
if self.return_type is not None:
|
|
return "filter"
|
|
else:
|
|
return "hook"
|
|
|
|
def classname(self) -> str:
|
|
return "_" + stringcase.pascalcase(self.full_name())
|
|
|
|
def list_code(self) -> str:
|
|
return f"""\
|
|
_hooks: List[{self.callable()}] = []
|
|
"""
|
|
|
|
def code(self) -> str:
|
|
appenddoc = f"({', '.join(self.args or [])})"
|
|
if self.doc:
|
|
classdoc = f" '''{self.doc}'''\n"
|
|
else:
|
|
classdoc = ""
|
|
code = f"""\
|
|
class {self.classname()}:
|
|
{classdoc}{self.list_code()}
|
|
|
|
def append(self, cb: {self.callable()}) -> None:
|
|
'''{appenddoc}'''
|
|
self._hooks.append(cb)
|
|
|
|
def remove(self, cb: {self.callable()}) -> None:
|
|
if cb in self._hooks:
|
|
self._hooks.remove(cb)
|
|
{self.fire_code()}
|
|
{self.name} = {self.classname()}()
|
|
"""
|
|
return code
|
|
|
|
def fire_code(self) -> str:
|
|
if self.return_type is not None:
|
|
# filter
|
|
return self.filter_fire_code()
|
|
else:
|
|
# hook
|
|
return self.hook_fire_code()
|
|
|
|
def legacy_args(self) -> str:
|
|
if self.legacy_no_args:
|
|
# hook name only
|
|
return f'"{self.legacy_hook}"'
|
|
else:
|
|
return ", ".join([f'"{self.legacy_hook}"'] + self.arg_names())
|
|
|
|
def hook_fire_code(self) -> str:
|
|
arg_names = self.arg_names()
|
|
args_including_self = ["self"] + (self.args or [])
|
|
out = f"""\
|
|
def __call__({", ".join(args_including_self)}) -> None:
|
|
for hook in self._hooks:
|
|
try:
|
|
hook({", ".join(arg_names)})
|
|
except:
|
|
# if the hook fails, remove it
|
|
self._hooks.remove(hook)
|
|
raise
|
|
"""
|
|
if self.legacy_hook:
|
|
out += f"""\
|
|
# legacy support
|
|
runHook({self.legacy_args()})
|
|
"""
|
|
return out + "\n\n"
|
|
|
|
def filter_fire_code(self) -> str:
|
|
arg_names = self.arg_names()
|
|
args_including_self = ["self"] + (self.args or [])
|
|
out = f"""\
|
|
def __call__({", ".join(args_including_self)}) -> {self.return_type}:
|
|
for filter in self._hooks:
|
|
try:
|
|
{arg_names[0]} = filter({", ".join(arg_names)})
|
|
except:
|
|
# if the hook fails, remove it
|
|
self._hooks.remove(filter)
|
|
raise
|
|
"""
|
|
if self.legacy_hook:
|
|
out += f"""\
|
|
# legacy support
|
|
{arg_names[0]} = runFilter({self.legacy_args()})
|
|
"""
|
|
|
|
out += f"""\
|
|
return {arg_names[0]}
|
|
"""
|
|
return out + "\n\n"
|
|
|
|
|
|
def update_file(path: str, hooks: List[Hook]):
|
|
hooks.sort(key=attrgetter("name"))
|
|
code = ""
|
|
for hook in hooks:
|
|
code += hook.code()
|
|
|
|
orig = open(path).read()
|
|
new = re.sub(
|
|
"(?s)# @@AUTOGEN@@.*?# @@AUTOGEN@@\n",
|
|
f"# @@AUTOGEN@@\n\n{code}# @@AUTOGEN@@\n",
|
|
orig,
|
|
)
|
|
|
|
open(path, "wb").write(new.encode("utf8"))
|