made small adjustments to 'recalc on sync' (#33)

Author: mortii

ankimorphs/__init__.py

@@ -48,6 +48,7 @@
 
 last_undo_step_handled: int = -1
 db_initialized: bool = False
+startup_sync: bool = True
 
 
 def main() -> None:
@@ -66,9 +67,10 @@ def main() -> None:
 
     gui_hooks.webview_will_show_context_menu.append(add_name_action)
 
-    gui_hooks.profile_will_close.append(clear_seen_morphs)
     gui_hooks.sync_will_start.append(recalc_on_sync)
 
+    gui_hooks.profile_will_close.append(clear_seen_morphs)
+
 
 def init_toolbar_items(links: list[str], toolbar: Toolbar) -> None:
     # Adds the 'U: A:' and 'Recalc' to the toolbar
@@ -295,6 +297,20 @@ def replace_reviewer_functions() -> None:
     )
 
 
+def recalc_on_sync() -> None:
+    # Sync automatically happens on Anki startup, so we have
+    # to check for that before we run recalc
+
+    global startup_sync
+
+    if startup_sync:
+        startup_sync = False
+    else:
+        am_config = AnkiMorphsConfig()
+        if am_config.recalc_on_sync:
+            recalc.recalc()
+
+
 def create_am_tool_menu() -> QMenu:
     assert mw is not None
     am_tool_menu = QMenu("AnkiMorphs", mw)
@@ -393,12 +409,6 @@ def add_name_action(web_view: AnkiWebView, menu: QMenu) -> None:
     menu.addAction(action)
 
 
-def recalc_on_sync() -> None:
-    am_config = AnkiMorphsConfig()
-    if am_config.recalc_on_sync:
-        recalc.recalc()
-
-
 def test_function() -> None:
     assert mw is not None
     assert mw.col.db is not None

ankimorphs/config.py

@@ -75,9 +75,6 @@ def __init__(self, is_default: bool = False) -> None:
         self.recalc_interval_for_known: int = _get_int_config(
             "recalc_interval_for_known", is_default
         )
-        # self.recalc_before_sync: bool = _get_bool_config(
-        #     "recalc_before_sync", is_default
-        # )
         self.recalc_prioritize_collection: bool = _get_bool_config(
             "recalc_prioritize_collection", is_default
         )
@@ -102,7 +99,7 @@ def __init__(self, is_default: bool = False) -> None:
         self.parse_ignore_suspended_cards_content: bool = _get_bool_config(
             "parse_ignore_suspended_cards_content", is_default
         )
-        self.recalc_on_sync: bool = _get_recalc_on_sync("recalc_on_sync", is_default)
+        self.recalc_on_sync: bool = _get_bool_config("recalc_on_sync", is_default)
         self.tag_ready: str = _get_string_config("tag_ready", is_default)
         self.tag_not_ready: str = _get_string_config("tag_not_ready", is_default)
         self.tag_known: str = _get_string_config("tag_known", is_default)
@@ -231,15 +228,6 @@ def _get_bool_config(key: str, is_default: bool = False) -> bool:
     return config_item
 
 
-def _get_recalc_on_sync(key: str, is_default: bool = False) -> bool:
-    if is_default:
-        config_item = get_default_config(key)
-    else:
-        config_item = _get_config(key)
-    assert isinstance(config_item, bool)
-    return config_item
-
-
 def _get_filter_str(_filter: FilterTypeAlias, key: str) -> str:
     filter_item = _filter[key]
     assert isinstance(filter_item, str)

ankimorphs/recalc.py

@@ -625,7 +625,7 @@ def on_success(result: Any) -> None:
 
     mw.toolbar.draw()  # updates stats
     mw.progress.finish()
-    tooltip("Finished Recalc")
+    tooltip("Finished Recalc", parent=mw)
     if start_time is not None:
         end_time: float = time.time()
         print(f"Recalc duration: {round(end_time - start_time, 3)} seconds")

ankimorphs/settings_dialog.py

@@ -56,7 +56,7 @@ def __init__(self, parent: Optional[QMainWindow] = None) -> None:
         self.ui.tabWidget.currentChanged.connect(self.tab_change)
 
         # Semantic Versioning https://semver.org/
-        self.ui.ankimorphs_version_label.setText("AnkiMorphs version: 0.3.1-alpha")
+        self.ui.ankimorphs_version_label.setText("AnkiMorphs version: 0.4.0-alpha")
 
     def _setup_note_filters_table(
         self, config_filters: list[AnkiMorphsConfigFilter]
@@ -321,14 +321,13 @@ def restore_shortcuts_defaults(self, skip_confirmation: bool = False) -> None:
         )
 
     def _populate_recalc_tab(self) -> None:
-        # self.ui.recalc_before_sync_input.setChecked(self.config.recalc_before_sync)
         self.ui.recalc_interval_known_input.setValue(
             self.config.recalc_interval_for_known
         )
         self.ui.recalc_prioritize_collection_input.setChecked(
             self.config.recalc_prioritize_collection
         )
-        self.ui.recalc_on_sync.setChecked(self.config.recalc_on_sync)
+        self.ui.recalc_on_sync_input.setChecked(self.config.recalc_on_sync)
         # self.ui.recalc_prioritize_textfile_input.setChecked(
         #     self.config.recalc_prioritize_textfile
         # )
@@ -342,15 +341,13 @@ def restore_recalc_defaults(self, skip_confirmation: bool = False) -> None:
             if not confirmed:
                 return
 
-        # self.ui.recalc_before_sync_input.setChecked(
-        #     self._default_config.recalc_before_sync
-        # )
         self.ui.recalc_interval_known_input.setValue(
             self._default_config.recalc_interval_for_known
         )
         self.ui.recalc_prioritize_collection_input.setChecked(
             self._default_config.recalc_prioritize_collection
         )
+        self.ui.recalc_on_sync_input.setChecked(self._default_config.recalc_on_sync)
         # self.ui.recalc_prioritize_textfile_input.setChecked(
         #     self._default_config.recalc_prioritize_textfile
         # )
@@ -445,9 +442,9 @@ def save_to_config(self) -> None:  # pylint:disable=too-many-locals
             "shortcut_set_known_and_skip": self.ui.shortcut_known_and_skip_input.keySequence().toString(),
             "shortcut_learn_now": self.ui.shortcut_learn_now_input.keySequence().toString(),
             "shortcut_view_morphemes": self.ui.shortcut_view_morphs_input.keySequence().toString(),
-            # "recalc_before_sync": self.ui.recalc_before_sync_input.isChecked(),
             "recalc_interval_for_known": self.ui.recalc_interval_known_input.value(),
             "recalc_prioritize_collection": self.ui.recalc_prioritize_collection_input.isChecked(),
+            "recalc_on_sync": self.ui.recalc_on_sync_input.isChecked(),
             # "recalc_prioritize_textfile": self.ui.recalc_prioritize_textfile_input.isChecked(),
             "parse_ignore_bracket_contents": self.ui.parse_ignore_bracket_contents_input.isChecked(),
             "parse_ignore_round_bracket_contents": self.ui.parse_ignore_round_bracket_contents_input.isChecked(),
@@ -458,7 +455,6 @@ def save_to_config(self) -> None:  # pylint:disable=too-many-locals
             "skip_only_known_morphs_cards": self.ui.skip_only_known_morphs_cards_input.isChecked(),
             "skip_unknown_morph_seen_today_cards": self.ui.skip_unknown_morph_seen_today_cards_input.isChecked(),
             "skip_show_num_of_skipped_cards": self.ui.skip_show_num_of_skipped_cards_input.isChecked(),
-            "recalc_on_sync": self.ui.recalc_on_sync.isChecked(),
         }
 
         filters = []

ankimorphs/ui/settings_dialog.ui

@@ -404,6 +404,17 @@
         <layout class="QVBoxLayout" name="verticalLayout_18">
          <item>
           <layout class="QVBoxLayout" name="verticalLayout_17">
+           <item>
+            <layout class="QVBoxLayout" name="verticalLayout_21">
+             <item>
+              <widget class="QCheckBox" name="recalc_on_sync_input">
+               <property name="text">
+                <string>Recalc on sync</string>
+               </property>
+              </widget>
+             </item>
+            </layout>
+           </item>
            <item>
             <layout class="QHBoxLayout" name="horizontalLayout_6">
              <property name="topMargin">
@@ -441,13 +452,6 @@
              </item>
             </layout>
            </item>
-           <item>
-            <widget class="QCheckBox" name="recalc_on_sync">
-             <property name="text">
-              <string>Recalc on sync</string>
-             </property>
-            </widget>
-           </item>
            <item>
             <layout class="QVBoxLayout" name="verticalLayout_14">
              <property name="topMargin">

ankimorphs/ui/settings_dialog_ui.py

@@ -1,4 +1,4 @@
-# Form implementation generated from reading ui file './settings_dialog.ui'
+# Form implementation generated from reading ui file 'ankimorphs/ui/settings_dialog.ui'
 #
 # Created by: PyQt6 UI code generator 6.4.2
 #
@@ -193,6 +193,12 @@ def setupUi(self, SettingsDialog):
         self.verticalLayout_18.setObjectName("verticalLayout_18")
         self.verticalLayout_17 = QtWidgets.QVBoxLayout()
         self.verticalLayout_17.setObjectName("verticalLayout_17")
+        self.verticalLayout_21 = QtWidgets.QVBoxLayout()
+        self.verticalLayout_21.setObjectName("verticalLayout_21")
+        self.recalc_on_sync_input = QtWidgets.QCheckBox(parent=self.recalc_tab)
+        self.recalc_on_sync_input.setObjectName("recalc_on_sync_input")
+        self.verticalLayout_21.addWidget(self.recalc_on_sync_input)
+        self.verticalLayout_17.addLayout(self.verticalLayout_21)
         self.horizontalLayout_6 = QtWidgets.QHBoxLayout()
         self.horizontalLayout_6.setContentsMargins(-1, 10, -1, -1)
         self.horizontalLayout_6.setObjectName("horizontalLayout_6")
@@ -208,9 +214,6 @@ def setupUi(self, SettingsDialog):
         spacerItem8 = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Policy.Expanding, QtWidgets.QSizePolicy.Policy.Minimum)
         self.horizontalLayout_6.addItem(spacerItem8)
         self.verticalLayout_17.addLayout(self.horizontalLayout_6)
-        self.recalc_on_sync = QtWidgets.QCheckBox(parent=self.recalc_tab)
-        self.recalc_on_sync.setObjectName("recalc_on_sync")
-        self.verticalLayout_17.addWidget(self.recalc_on_sync)
         self.verticalLayout_14 = QtWidgets.QVBoxLayout()
         self.verticalLayout_14.setContentsMargins(-1, 10, -1, -1)
         self.verticalLayout_14.setObjectName("verticalLayout_14")
@@ -372,9 +375,9 @@ def retranslateUi(self, SettingsDialog):
         self.skip_show_num_of_skipped_cards_input.setText(_translate("SettingsDialog", "Show \"skipped x cards\" notifications"))
         self.restore_skip_defaults_button.setText(_translate("SettingsDialog", "Restore Default Skip Settings"))
         self.tabWidget.setTabText(self.tabWidget.indexOf(self.skip_tab), _translate("SettingsDialog", "Skip"))
+        self.recalc_on_sync_input.setText(_translate("SettingsDialog", "Recalc on sync"))
         self.label_16.setText(_translate("SettingsDialog", "Min. interval for known morphs:"))
         self.label_17.setText(_translate("SettingsDialog", "days"))
-        self.recalc_on_sync.setText(_translate("SettingsDialog", "Recalc on sync"))
         self.label_5.setText(_translate("SettingsDialog", "Prioritize morphs based on:"))
         self.recalc_prioritize_collection_input.setText(_translate("SettingsDialog", "Frequency in card collection"))
         self.restore_recalc_defaults_button.setText(_translate("SettingsDialog", "Restore Default Recalc Settings"))
@@ -392,13 +395,3 @@ def retranslateUi(self, SettingsDialog):
         self.ankimorphs_version_label.setText(_translate("SettingsDialog", "AnkiMorphs version: x"))
         self.cancel_button.setText(_translate("SettingsDialog", "Cancel"))
         self.save_button.setText(_translate("SettingsDialog", "Save"))
-
-
-if __name__ == "__main__":
-    import sys
-    app = QtWidgets.QApplication(sys.argv)
-    SettingsDialog = QtWidgets.QDialog()
-    ui = Ui_SettingsDialog()
-    ui.setupUi(SettingsDialog)
-    SettingsDialog.show()
-    sys.exit(app.exec())

docs/src/user_guide/roadmap.md

@@ -11,6 +11,5 @@
 6. Remake tests
 7. Update guide
 8. **Release AnkiMorphs stable version**
-9. Implement optional "automatic recalc before sync"
-10. Remake statistics page
-11. Implement "cloze"-option [(#12)](https://github.com/mortii/anki-morphs/discussions/12)
+9. Remake statistics page
+10. Implement "cloze"-option [(#12)](https://github.com/mortii/anki-morphs/discussions/12)