Settings update #7

cd-FileX · 2024-04-15T07:55:06Z

Added new settings and changed old for new functions
Changed order and grouped settings
Changed config.md to new version & html for correct display
Added settings help button for additional descriptions of config.md

Partly connected to future pull requests

- Added new settings and changed old for new functions - Changed order and grouped settings - Changed config.md to new version & html for correct display - Added settings help button for additional descriptions

- Delete previous log file content upon opening - Saves time when closing anki and storage - Added button to settings to view log file

tatsumoto-ren · 2024-04-15T13:56:24Z

__init__.py

+# Roadmap:
+# - Improve upper part of search window (more options(?), fast switch for online, collapsible(?))
+# - Improve online request (to-card-converter, importer)
+# - Update search UI to immersion kit like style and add option to merge local and online cards into one search
+


I think it's better move these lines to Issues instead of committing them in code.

If anything, this should be in a different PR.

tatsumoto-ren · 2024-04-15T13:57:59Z

common.py

+            # clear before writing to avoid large logfiles and their consequences
+            open(DEBUG_LOG_FILE_PATH, 'w').close()
            self._logfile = open(DEBUG_LOG_FILE_PATH, "a")


I'm not sure if it's desirable to delete the contents of the log file when Anki opens. The user might need the logs from previous runs. If the user doesn't want to keep a debug log, it's better to have it disabled. (set enable_debug_log to false in Options.)

open(DEBUG_LOG_FILE_PATH, 'w').close() and open(DEBUG_LOG_FILE_PATH, "a") can be simplified to open(DEBUG_LOG_FILE_PATH, 'w')

In that case we should maybe build in something like splitted logfiles, a button to clear the log file or making the view opened in "Open Logfile" editable.
It is a bit of a pain if you are using anki for a long time and it needs a few moments to cool down and close the log.

In that case we should maybe build in something like splitted logfiles, a button to clear the log file or making the view opened in "Open Logfile" editable. It is a bit of a pain if you are using anki for a long time and it needs a few moments to cool down and close the log.

The existing logging code was written by Russel Simmons a long time ago. Later I refactored it a bit, but the logic is mostly still the same. Today we should just do:

from aqt.addons import AddonManager logger = AddonManager.get_logger(__name__) logger.info("my message")

If we use Anki's logging, it will automatically clear old logs (older than 10 days by default).

See #8

tatsumoto-ren · 2024-04-15T14:13:10Z

common.py

+    def read(self):
+        if not self._logfile:
+            return ""
+        with open(self._logfile.name, 'r') as lf:
+            return lf.read()
+


I don't understand why it's done like this, but I think this would be easier

def read(self): with open(DEBUG_LOG_FILE_PATH, 'r', encoding='utf-8') as lf: return lf.read()

tatsumoto-ren · 2024-04-15T14:20:45Z

config.json

-  "max_displayed_notes": 500,
-  "exported_tag": "cropro_exported",
+  "notes_per_page": 100,
  "hidden_fields": [
    "furigana",
    "image",
    "audio"
  ],
  "skip_duplicates": true,
  "copy_tags": true,
+  "show_note_preview": true,
+  "search_online": false,
+  "show_extended_filters": true,
+  "show_help_buttons": true,
+
+  "import_source_info": false,
+  "fetch_anki_card_media": false,
+
  "allow_empty_search": false,
-  "preview_on_right_side": true,
  "copy_card_data": false,
-  "call_add_cards_hook": false,
+  "exported_tag": "cropro_exported",
+
+  "timeout_seconds": 60,
  "enable_debug_log": false,
-  "search_the_web": false,
-  "timeout_seconds": 60
+  "call_add_cards_hook": false


If you rename existing config keys, the users will lose their settings. Additionally, it makes the diff very hard to read and understand what's changed.

tatsumoto-ren · 2024-04-15T14:51:55Z

config.py

+
+    @property
+    def enable_debug_log(self) -> bool:
+        return self["enable_debug_log"]


The positions of the existing settings are changed. This makes the diff more difficult to read.

tatsumoto-ren · 2024-04-15T16:28:12Z

settings_dialog.py

+        self.button_box = QDialogButtonBox(
+            (BUT_HELP | BUT_OK | BUT_CANCEL) if config.show_help_buttons else (BUT_OK | BUT_CANCEL)
+        )


Do we really need to be able to disable the help button? If it's always visible, it won't harm anybody.

Well, implemented without thinking about it again.
Was from the previous version where you got the a bit weirdly placed help button in the search window.
Thanks for the hint

tatsumoto-ren · 2024-04-15T16:30:18Z

settings_dialog.py

-    def _setup_ui(self) -> None:
-        self.setMinimumWidth(300)
-        self.setWindowTitle(f"{ADDON_NAME} Settings")
-        self.setLayout(self._make_layout())
-


This method was moved. It makes the diff harder to read.

it can be added in a different PR if needed

tatsumoto-ren · 2024-04-15T17:02:54Z

config.json

+  "show_extended_filters": true,
+  "show_help_buttons": true,
+  "import_source_info": false,
+  "fetch_anki_card_media": false


This config key fetch_anki_card_media appears unused. I assume it needs to be implemented in a different PR.

tatsumoto-ren · 2024-04-15T17:06:22Z

config.json

+  "timeout_seconds": 60,
+  "show_extended_filters": true,
+  "show_help_buttons": true,
+  "import_source_info": false,


This config key import_source_info appears unused. I assume it needs to be implemented in a different PR.

tatsumoto-ren · 2024-04-15T17:08:24Z

config.json

@@ -14,5 +14,9 @@
  "call_add_cards_hook": false,
  "enable_debug_log": false,
  "search_the_web": false,
-  "timeout_seconds": 60
+  "timeout_seconds": 60,
+  "show_extended_filters": true,


This config key show_extended_filters appears unused. I assume it needs to be implemented in a different PR.

tatsumoto-ren · 2024-04-15T17:16:43Z

I have removed the config options that were not implemented. They need to be added in separate pull requests.

tatsumoto-ren · 2024-04-15T17:17:30Z

Also removed the roadmap and config deletion (see the review).

cd-FileX and others added 21 commits April 15, 2024 16:18

Settings update

932e6f1

- Added new settings and changed old for new functions - Changed order and grouped settings - Changed config.md to new version & html for correct display - Added settings help button for additional descriptions

Log improvement

66138b3

- Delete previous log file content upon opening - Saves time when closing anki and storage - Added button to settings to view log file

Merge branch 'main' into main

d46d621

temp remove

ecbcafc

temp remove

d372ba8

simplify

11d8ee8

fix typing

4266149

restore key name

54e583e

restore key name

9c04554

restore key name

9a8bbb4

Merge branch 'main' into cd-FileX/main

6d396cb

move key

fd289ee

move key

350f594

move key

fc9c575

move key

4bc2f64

move keys

c53a210

add exception handling

a657b41

resotre original positions of keys

d21dd00

Merge branch 'main' into cd-FileX/main

5907a8a

format code

dcd20e8

alter config help

38af9c3

tatsumoto-ren reviewed Apr 15, 2024

View reviewed changes

restore original name

8f3da41

tatsumoto-ren reviewed Apr 15, 2024

View reviewed changes

tatsumoto-ren added 5 commits April 15, 2024 19:35

move methods

91e9858

use common function

e3f97a3

move loop

b5184e4

remove config key show_help_buttons

8529cc4

it can be added in a different PR if needed

Merge branch 'main' into cd-FileX/main

04511a6

tatsumoto-ren added 2 commits April 15, 2024 19:56

set and assign layout in one line

829fdaa

remove unused config key

32438ee

tatsumoto-ren reviewed Apr 15, 2024

View reviewed changes

remove unused key

6b89b05

tatsumoto-ren reviewed Apr 15, 2024

View reviewed changes

remove unused key

9c1d9e6

tatsumoto-ren reviewed Apr 15, 2024

View reviewed changes

tatsumoto-ren merged commit bdc50f2 into Ajatt-Tools:main Apr 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Settings update #7

Settings update #7

cd-FileX commented Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

cd-FileX Apr 16, 2024

tatsumoto-ren Apr 16, 2024 •

edited

Loading

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

cd-FileX Apr 16, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren Apr 15, 2024

tatsumoto-ren commented Apr 15, 2024

tatsumoto-ren commented Apr 15, 2024

Settings update #7

Settings update #7

Conversation

cd-FileX commented Apr 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tatsumoto-ren Apr 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tatsumoto-ren commented Apr 15, 2024

tatsumoto-ren commented Apr 15, 2024

tatsumoto-ren Apr 16, 2024 •

edited

Loading