GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-12-20 10:22:57 -05:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

add _ prefix to generated classes to improve code completion

Browse source
This commit is contained in:
Damien Elmes 2020-01-15 08:58:27 +10:00
parent 2fa662f7ae
commit cb14963066
3 changed files with 57 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
pylib/anki/hooks.py
View file

@ -34,7 +34,7 @@ from anki.types import QAData
# @@AUTOGEN@@ # @@AUTOGEN@@
class CreateExportersListHook: class _CreateExportersListHook:
_hooks: List[Callable[[List[Tuple[str, Any]]], None]] = [] _hooks: List[Callable[[List[Tuple[str, Any]]], None]] = []
def append(self, cb: Callable[[List[Tuple[str, Any]]], None]) -> None: def append(self, cb: Callable[[List[Tuple[str, Any]]], None]) -> None:
@ -56,10 +56,10 @@ class CreateExportersListHook:
runHook("exportersList", exporters) runHook("exportersList", exporters)
create_exporters_list_hook = CreateExportersListHook() create_exporters_list_hook = _CreateExportersListHook()
class DeckCreatedHook: class _DeckCreatedHook:
_hooks: List[Callable[[Dict[str, Any]], None]] = [] _hooks: List[Callable[[Dict[str, Any]], None]] = []
def append(self, cb: Callable[[Dict[str, Any]], None]) -> None: def append(self, cb: Callable[[Dict[str, Any]], None]) -> None:
@ -81,10 +81,10 @@ class DeckCreatedHook:
runHook("newDeck") runHook("newDeck")
deck_created_hook = DeckCreatedHook() deck_created_hook = _DeckCreatedHook()
class ExportedMediaFilesHook: class _ExportedMediaFilesHook:
_hooks: List[Callable[[int], None]] = [] _hooks: List[Callable[[int], None]] = []
def append(self, cb: Callable[[int], None]) -> None: def append(self, cb: Callable[[int], None]) -> None:
@ -104,10 +104,10 @@ class ExportedMediaFilesHook:
raise raise
exported_media_files_hook = ExportedMediaFilesHook() exported_media_files_hook = _ExportedMediaFilesHook()
class FieldReplacementFilter: class _FieldReplacementFilter:
_hooks: List[Callable[[str, str, str, Dict[str, str]], str]] = [] _hooks: List[Callable[[str, str, str, Dict[str, str]], str]] = []
def append(self, cb: Callable[[str, str, str, Dict[str, str]], str]) -> None: def append(self, cb: Callable[[str, str, str, Dict[str, str]], str]) -> None:
@ -130,10 +130,10 @@ class FieldReplacementFilter:
return field_text return field_text
field_replacement_filter = FieldReplacementFilter() field_replacement_filter = _FieldReplacementFilter()
class HttpDataReceivedHook: class _HttpDataReceivedHook:
_hooks: List[Callable[[int], None]] = [] _hooks: List[Callable[[int], None]] = []
def append(self, cb: Callable[[int], None]) -> None: def append(self, cb: Callable[[int], None]) -> None:
@ -153,10 +153,10 @@ class HttpDataReceivedHook:
raise raise
http_data_received_hook = HttpDataReceivedHook() http_data_received_hook = _HttpDataReceivedHook()
class HttpDataSentHook: class _HttpDataSentHook:
_hooks: List[Callable[[int], None]] = [] _hooks: List[Callable[[int], None]] = []
def append(self, cb: Callable[[int], None]) -> None: def append(self, cb: Callable[[int], None]) -> None:
@ -176,10 +176,10 @@ class HttpDataSentHook:
raise raise
http_data_sent_hook = HttpDataSentHook() http_data_sent_hook = _HttpDataSentHook()
class LeechHook: class _LeechHook:
_hooks: List[Callable[[Card], None]] = [] _hooks: List[Callable[[Card], None]] = []
def append(self, cb: Callable[[Card], None]) -> None: def append(self, cb: Callable[[Card], None]) -> None:
@ -201,10 +201,10 @@ class LeechHook:
runHook("leech", card) runHook("leech", card)
leech_hook = LeechHook() leech_hook = _LeechHook()
class ModSchemaFilter: class _ModSchemaFilter:
_hooks: List[Callable[[bool], bool]] = [] _hooks: List[Callable[[bool], bool]] = []
def append(self, cb: Callable[[bool], bool]) -> None: def append(self, cb: Callable[[bool], bool]) -> None:
@ -225,10 +225,10 @@ class ModSchemaFilter:
return proceed return proceed
mod_schema_filter = ModSchemaFilter() mod_schema_filter = _ModSchemaFilter()
class ModifyFieldsForRenderingHook: class _ModifyFieldsForRenderingHook:
_hooks: List[Callable[[Dict[str, str], Dict[str, Any], QAData], None]] = [] _hooks: List[Callable[[Dict[str, str], Dict[str, Any], QAData], None]] = []
def append( def append(
@ -254,10 +254,10 @@ class ModifyFieldsForRenderingHook:
raise raise
modify_fields_for_rendering_hook = ModifyFieldsForRenderingHook() modify_fields_for_rendering_hook = _ModifyFieldsForRenderingHook()
class NoteTypeCreatedHook: class _NoteTypeCreatedHook:
_hooks: List[Callable[[Dict[str, Any]], None]] = [] _hooks: List[Callable[[Dict[str, Any]], None]] = []
def append(self, cb: Callable[[Dict[str, Any]], None]) -> None: def append(self, cb: Callable[[Dict[str, Any]], None]) -> None:
@ -279,10 +279,10 @@ class NoteTypeCreatedHook:
runHook("newModel") runHook("newModel")
note_type_created_hook = NoteTypeCreatedHook() note_type_created_hook = _NoteTypeCreatedHook()
class OdueInvalidHook: class _OdueInvalidHook:
_hooks: List[Callable[[], None]] = [] _hooks: List[Callable[[], None]] = []
def append(self, cb: Callable[[], None]) -> None: def append(self, cb: Callable[[], None]) -> None:
@ -302,10 +302,10 @@ class OdueInvalidHook:
raise raise
odue_invalid_hook = OdueInvalidHook() odue_invalid_hook = _OdueInvalidHook()
class OriginalCardTemplateFilter: class _OriginalCardTemplateFilter:
_hooks: List[Callable[[str, bool], str]] = [] _hooks: List[Callable[[str, bool], str]] = []
def append(self, cb: Callable[[str, bool], str]) -> None: def append(self, cb: Callable[[str, bool], str]) -> None:
@ -326,10 +326,10 @@ class OriginalCardTemplateFilter:
return template return template
original_card_template_filter = OriginalCardTemplateFilter() original_card_template_filter = _OriginalCardTemplateFilter()
class PrepareSearchesHook: class _PrepareSearchesHook:
_hooks: List[Callable[[Dict[str, Callable]], None]] = [] _hooks: List[Callable[[Dict[str, Callable]], None]] = []
def append(self, cb: Callable[[Dict[str, Callable]], None]) -> None: def append(self, cb: Callable[[Dict[str, Callable]], None]) -> None:
@ -351,10 +351,10 @@ class PrepareSearchesHook:
runHook("search", searches) runHook("search", searches)
prepare_searches_hook = PrepareSearchesHook() prepare_searches_hook = _PrepareSearchesHook()
class RemoveNotesHook: class _RemoveNotesHook:
_hooks: List[Callable[["anki.storage._Collection", List[int]], None]] = [] _hooks: List[Callable[["anki.storage._Collection", List[int]], None]] = []
def append( def append(
@ -380,10 +380,10 @@ class RemoveNotesHook:
runHook("remNotes", col, ids) runHook("remNotes", col, ids)
remove_notes_hook = RemoveNotesHook() remove_notes_hook = _RemoveNotesHook()
class RenderedCardTemplateFilter: class _RenderedCardTemplateFilter:
_hooks: List[ _hooks: List[
Callable[ Callable[
[ [
@ -452,10 +452,10 @@ class RenderedCardTemplateFilter:
return text return text
rendered_card_template_filter = RenderedCardTemplateFilter() rendered_card_template_filter = _RenderedCardTemplateFilter()
class SyncProgressMessageHook: class _SyncProgressMessageHook:
_hooks: List[Callable[[str], None]] = [] _hooks: List[Callable[[str], None]] = []
def append(self, cb: Callable[[str], None]) -> None: def append(self, cb: Callable[[str], None]) -> None:
@ -477,10 +477,10 @@ class SyncProgressMessageHook:
runHook("syncMsg", msg) runHook("syncMsg", msg)
sync_progress_message_hook = SyncProgressMessageHook() sync_progress_message_hook = _SyncProgressMessageHook()
class SyncStageHook: class _SyncStageHook:
_hooks: List[Callable[[str], None]] = [] _hooks: List[Callable[[str], None]] = []
def append(self, cb: Callable[[str], None]) -> None: def append(self, cb: Callable[[str], None]) -> None:
@ -502,10 +502,10 @@ class SyncStageHook:
runHook("sync", stage) runHook("sync", stage)
sync_stage_hook = SyncStageHook() sync_stage_hook = _SyncStageHook()
class TagCreatedHook: class _TagCreatedHook:
_hooks: List[Callable[[str], None]] = [] _hooks: List[Callable[[str], None]] = []
def append(self, cb: Callable[[str], None]) -> None: def append(self, cb: Callable[[str], None]) -> None:
@ -527,7 +527,7 @@ class TagCreatedHook:
runHook("newTag") runHook("newTag")
tag_created_hook = TagCreatedHook() tag_created_hook = _TagCreatedHook()
# @@AUTOGEN@@ # @@AUTOGEN@@
# Legacy hook handling # Legacy hook handling

2
pylib/anki/hooks_gen.py
View file

@ -57,7 +57,7 @@ class Hook:
return "hook" return "hook"
def classname(self) -> str: def classname(self) -> str:
return stringcase.pascalcase(self.full_name()) return "_" + stringcase.pascalcase(self.full_name())
def list_code(self) -> str: def list_code(self) -> str:
return f"""\ return f"""\

40
qt/aqt/gui_hooks.py
View file

@ -22,7 +22,7 @@ from aqt.qt import QMenu
# @@AUTOGEN@@ # @@AUTOGEN@@
class BrowserContextMenuHook: class _BrowserContextMenuHook:
_hooks: List[Callable[["aqt.browser.Browser", QMenu], None]] = [] _hooks: List[Callable[["aqt.browser.Browser", QMenu], None]] = []
def append(self, cb: Callable[["aqt.browser.Browser", QMenu], None]) -> None: def append(self, cb: Callable[["aqt.browser.Browser", QMenu], None]) -> None:
@ -44,10 +44,10 @@ class BrowserContextMenuHook:
runHook("browser.onContextMenu", browser, menu) runHook("browser.onContextMenu", browser, menu)
browser_context_menu_hook = BrowserContextMenuHook() browser_context_menu_hook = _BrowserContextMenuHook()
class BrowserRowChangedHook: class _BrowserRowChangedHook:
_hooks: List[Callable[["aqt.browser.Browser"], None]] = [] _hooks: List[Callable[["aqt.browser.Browser"], None]] = []
def append(self, cb: Callable[["aqt.browser.Browser"], None]) -> None: def append(self, cb: Callable[["aqt.browser.Browser"], None]) -> None:
@ -69,10 +69,10 @@ class BrowserRowChangedHook:
runHook("browser.rowChanged", browser) runHook("browser.rowChanged", browser)
browser_row_changed_hook = BrowserRowChangedHook() browser_row_changed_hook = _BrowserRowChangedHook()
class BrowserSetupMenusHook: class _BrowserSetupMenusHook:
_hooks: List[Callable[["aqt.browser.Browser"], None]] = [] _hooks: List[Callable[["aqt.browser.Browser"], None]] = []
def append(self, cb: Callable[["aqt.browser.Browser"], None]) -> None: def append(self, cb: Callable[["aqt.browser.Browser"], None]) -> None:
@ -94,10 +94,10 @@ class BrowserSetupMenusHook:
runHook("browser.setupMenus", browser) runHook("browser.setupMenus", browser)
browser_setup_menus_hook = BrowserSetupMenusHook() browser_setup_menus_hook = _BrowserSetupMenusHook()
class CardTextFilter: class _CardTextFilter:
_hooks: List[Callable[[str, Card, str], str]] = [] _hooks: List[Callable[[str, Card, str], str]] = []
def append(self, cb: Callable[[str, Card, str], str]) -> None: def append(self, cb: Callable[[str, Card, str], str]) -> None:
@ -120,10 +120,10 @@ class CardTextFilter:
return text return text
card_text_filter = CardTextFilter() card_text_filter = _CardTextFilter()
class CurrentNoteTypeChangedHook: class _CurrentNoteTypeChangedHook:
_hooks: List[Callable[[Dict[str, Any]], None]] = [] _hooks: List[Callable[[Dict[str, Any]], None]] = []
def append(self, cb: Callable[[Dict[str, Any]], None]) -> None: def append(self, cb: Callable[[Dict[str, Any]], None]) -> None:
@ -145,10 +145,10 @@ class CurrentNoteTypeChangedHook:
runHook("currentModelChanged") runHook("currentModelChanged")
current_note_type_changed_hook = CurrentNoteTypeChangedHook() current_note_type_changed_hook = _CurrentNoteTypeChangedHook()
class MpvIdleHook: class _MpvIdleHook:
_hooks: List[Callable[[], None]] = [] _hooks: List[Callable[[], None]] = []
def append(self, cb: Callable[[], None]) -> None: def append(self, cb: Callable[[], None]) -> None:
@ -168,10 +168,10 @@ class MpvIdleHook:
raise raise
mpv_idle_hook = MpvIdleHook() mpv_idle_hook = _MpvIdleHook()
class MpvWillPlayHook: class _MpvWillPlayHook:
_hooks: List[Callable[[str], None]] = [] _hooks: List[Callable[[str], None]] = []
def append(self, cb: Callable[[str], None]) -> None: def append(self, cb: Callable[[str], None]) -> None:
@ -193,10 +193,10 @@ class MpvWillPlayHook:
runHook("mpvWillPlay", file) runHook("mpvWillPlay", file)
mpv_will_play_hook = MpvWillPlayHook() mpv_will_play_hook = _MpvWillPlayHook()
class ReviewerShowingAnswerHook: class _ReviewerShowingAnswerHook:
_hooks: List[Callable[[Card], None]] = [] _hooks: List[Callable[[Card], None]] = []
def append(self, cb: Callable[[Card], None]) -> None: def append(self, cb: Callable[[Card], None]) -> None:
@ -218,10 +218,10 @@ class ReviewerShowingAnswerHook:
runHook("showAnswer") runHook("showAnswer")
reviewer_showing_answer_hook = ReviewerShowingAnswerHook() reviewer_showing_answer_hook = _ReviewerShowingAnswerHook()
class ReviewerShowingQuestionHook: class _ReviewerShowingQuestionHook:
_hooks: List[Callable[[Card], None]] = [] _hooks: List[Callable[[Card], None]] = []
def append(self, cb: Callable[[Card], None]) -> None: def append(self, cb: Callable[[Card], None]) -> None:
@ -243,10 +243,10 @@ class ReviewerShowingQuestionHook:
runHook("showQuestion") runHook("showQuestion")
reviewer_showing_question_hook = ReviewerShowingQuestionHook() reviewer_showing_question_hook = _ReviewerShowingQuestionHook()
class WebviewContextMenuHook: class _WebviewContextMenuHook:
_hooks: List[Callable[["aqt.webview.AnkiWebView", QMenu], None]] = [] _hooks: List[Callable[["aqt.webview.AnkiWebView", QMenu], None]] = []
def append(self, cb: Callable[["aqt.webview.AnkiWebView", QMenu], None]) -> None: def append(self, cb: Callable[["aqt.webview.AnkiWebView", QMenu], None]) -> None:
@ -268,5 +268,5 @@ class WebviewContextMenuHook:
runHook("AnkiWebView.contextMenuEvent", webview, menu) runHook("AnkiWebView.contextMenuEvent", webview, menu)
webview_context_menu_hook = WebviewContextMenuHook() webview_context_menu_hook = _WebviewContextMenuHook()
# @@AUTOGEN@@ # @@AUTOGEN@@