langfingaz/anki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add type hints for a few more methods commonly accessed by add-ons

Browse Source
This commit is contained in:
Glutanimate 2019-12-22 00:12:09 +01:00
parent a9d745ab5f
commit cb9d04a0eb
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
aqt/addons.py
View File

@ -389,7 +389,7 @@ and have been disabled: %(found)s") % dict(name=self.addonName(dir), found=addon
# Add-on Config API
######################################################################
def getConfig(self, module):
def getConfig(self, module: str) -> Optional[dict]:
addon = self.addonFromModule(module)
# get default config
config = self.addonConfigDefaults(addon)
@ -401,15 +401,15 @@ and have been disabled: %(found)s") % dict(name=self.addonName(dir), found=addon
config.update(userConf)
return config
def setConfigAction(self, module, fn):
def setConfigAction(self, module: str, fn: Callable[[], Optional[bool]]):
addon = self.addonFromModule(module)
self._configButtonActions[addon] = fn
def setConfigUpdatedAction(self, module, fn):
def setConfigUpdatedAction(self, module: str, fn: Callable[[Any], None]):
addon = self.addonFromModule(module)
self._configUpdatedActions[addon] = fn
def writeConfig(self, module, conf):
def writeConfig(self, module: str, conf: dict):
addon = self.addonFromModule(module)
meta = self.addonMeta(addon)
meta['config'] = conf
@ -442,7 +442,7 @@ and have been disabled: %(found)s") % dict(name=self.addonName(dir), found=addon
_webExports: Dict[str, str] = {}
def setWebExports(self, module, pattern):
def setWebExports(self, module: str, pattern: str):
addon = self.addonFromModule(module)
self._webExports[addon] = pattern

18
aqt/editor.py
View File

@ -11,6 +11,7 @@ import urllib.error
import urllib.parse
import urllib.request
import warnings
from typing import Optional, Callable, List, Tuple
import requests
from bs4 import BeautifulSoup
@ -74,7 +75,7 @@ class Editor:
self.web.onBridgeCmd = self.onBridgeCmd
self.outerLayout.addWidget(self.web, 1)
righttopbtns = list()
righttopbtns: List[str] = list()
righttopbtns.append(self._addButton('text_bold', 'bold', _("Bold text (Ctrl+B)"), id='bold'))
righttopbtns.append(self._addButton('text_italic', 'italic', _("Italic text (Ctrl+I)"), id='italic'))
righttopbtns.append(self._addButton('text_under', 'underline', _("Underline text (Ctrl+U)"), id='underline'))
@ -131,20 +132,23 @@ class Editor:
return 'data:%s;base64,%s' % (mime, data64.decode('ascii'))
def addButton(self, icon, cmd, func, tip="", label="",
id=None, toggleable=False, keys=None, disables=True):
def addButton(self, icon: str, cmd: str, func: Callable[["Editor"], None],
tip: str = "", label: str = "", id: str = None,
toggleable: bool = False, keys: str = None,
disables: bool = True):
"""Assign func to bridge cmd, register shortcut, return button"""
if cmd not in self._links:
self._links[cmd] = func
if keys:
QShortcut(QKeySequence(keys), self.widget,
activated = lambda s=self: func(s))
activated=lambda s=self: func(s))
btn = self._addButton(icon, cmd, tip=tip, label=label,
id=id, toggleable=toggleable, disables=disables)
return btn
def _addButton(self, icon, cmd, tip="", label="", id=None, toggleable=False,
disables=True):
def _addButton(self, icon: str, cmd: str, tip: str = "", label: str = "",
id: Optional[str] = None, toggleable: bool = False,
disables: bool = True):
if icon:
if icon.startswith("qrc:/"):
iconstr = icon
@ -180,7 +184,7 @@ class Editor:
def setupShortcuts(self):
# if a third element is provided, enable shortcut even when no field selected
cuts = [
cuts: List[Tuple] = [
("Ctrl+L", self.onCardLayout, True),
("Ctrl+B", self.toggleBold),
("Ctrl+I", self.toggleItalic),