GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-19 14:32:22 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

add optional docstring to hooks

Browse source
This commit is contained in:
Damien Elmes 2020-01-15 12:14:32 +10:00
parent dbca596b41
commit f021d616dd
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
pylib/tools/hookslib.py
View file

@ -26,6 +26,8 @@ class Hook:
legacy_hook: Optional[str] = None legacy_hook: Optional[str] = None
# if legacy hook takes no arguments but the new hook does, set this # if legacy hook takes no arguments but the new hook does, set this
legacy_no_args: bool = False legacy_no_args: bool = False
# docstring to add to hook class
doc: Optional[str] = None
def callable(self) -> str: def callable(self) -> str:
"Convert args into a Callable." "Convert args into a Callable."
@ -61,17 +63,21 @@ class Hook:
def list_code(self) -> str: def list_code(self) -> str:
return f"""\ return f"""\
_hooks: List[{self.callable()}] = [] _hooks: List[{self.callable()}] = []
""" """
def code(self) -> str: def code(self) -> str:
doc = f"({', '.join(self.args or [])})" appenddoc = f"({', '.join(self.args or [])})"
if self.doc:
classdoc = f" '''{self.doc}'''\n"
else:
classdoc = ""
code = f"""\ code = f"""\
class {self.classname()}: class {self.classname()}:
{self.list_code()} {classdoc}{self.list_code()}
def append(self, cb: {self.callable()}) -> None: def append(self, cb: {self.callable()}) -> None:
'''{doc}''' '''{appenddoc}'''
self._hooks.append(cb) self._hooks.append(cb)
def remove(self, cb: {self.callable()}) -> None: def remove(self, cb: {self.callable()}) -> None: