v0.1.2 ( minor bug fixes )

- better file save error handling
- adding numerics to section names allowed regex
- minor adjustments

Author: Pavel.Prudky

README.md

@@ -14,6 +14,7 @@ Notes application written in Python 3.8 & KivyMD
 ## version history
 | version | date | description |
 | :---: | :---: | :---: |
+| 0.1.2 | 10/10/2022 | minor bugfixes |
 | 0.1.1  | 12/7/2022  | removing item drawer menu highlight, improving diff feature, bugfixes |
 | 0.1.0  | 19/6/2022  | initial release |
 

notes_app/controller/notes_controller.py

@@ -47,9 +47,13 @@ def save_file_data(self, data) -> None:
         """
         save_file_data saves provided data to the file with location set in model.file_path
         """
-        f = open(self.model.file_path, "w")
-        f.write(data)
-        f.close()
+        if len(data) == 0:
+            return
+        try:
+            with open(self.model.file_path, "w") as f:
+                f.write(data)
+        except Exception as exc:
+            raise exc
 
         self.model.update()
         self.model.dump()

notes_app/defaults.py

@@ -2,7 +2,7 @@ class Defaults:
     DEFAULT_MODEL_STORE_FILE_NAME = "file_metadata.json"
     DEFAULT_NOTES_FILE_NAME = "my_first_file.txt"
     DEFAULT_SECTION_FILE_SEPARATOR = "<section={name}> "
-    DEFAULT_SECTION_FILE_SEPARATOR_REGEX = "<section=[a-z A-Z]+> "
+    DEFAULT_SECTION_FILE_SEPARATOR_REGEX = "<section=[a-z A-Z0-9]+> "
     DEFAULT_SECTION_FILE_SEPARATOR_GROUP_SUBSTR_REGEX = "<section=(.+?)> "
     DEFAULT_NOTES_FILE_CONTENT = f"{DEFAULT_SECTION_FILE_SEPARATOR.format(name='first')} Your first section. Here you can write your notes."
     DEFAULT_AUTO_SAVE_TEXT_INPUT_CHANGE_COUNT = 5

notes_app/search.py

@@ -78,13 +78,13 @@ def search_full_words(self):
     def search_full_words(self, value):
         self._search_full_words = value
 
-    def search_for_occurrences(self, pattern, file, current_section_identifier):
+    def search_for_occurrences(self, pattern, file, current_section):
         found_occurrences = dict()
 
         if self.search_all_sections:
             sections_separators_to_search_in = file.section_separators_sorted
         else:
-            sections_separators_to_search_in = [current_section_identifier]
+            sections_separators_to_search_in = [current_section]
 
         for section_separator in sections_separators_to_search_in:
             text = file.get_section_content(section_separator=section_separator)

notes_app/version.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = "0.1.2"

notes_app/view/notes_view.py

@@ -538,11 +538,10 @@ def execute_search(self, *args):
 
         self.dialog.content_cls.results_list.clear_widgets()
 
-        # TODO rename current_section_identifier param to current_section
         found_occurrences = self.search.search_for_occurrences(
             pattern=self.last_searched_string,
             file=self.file,
-            current_section_identifier=self.current_section,
+            current_section=self.current_section,
         )
 
         if not found_occurrences:
@@ -679,49 +678,54 @@ def cancel_dialog(self, *args):
     def save_current_section_to_file(self):
         merged_current_section_text_data = None
 
-        if self.model.external_update:
-            self.file.reload()
-            try:
-                current_section_text_before = self.file.get_section_content(
-                    section_separator=self.text_section_view.section_file_separator
-                )
-            # KeyError raised if the current section was removed or renamed by a external update
-            except KeyError:
-                # merge_strings prioritizes current_section_text_after over current_section_text_before
-                # so empty string placeholder is set to current_section_text_before
-                current_section_text_before = ""
-                # self.file.reload() will remove the current section separator from self.file.section_separators
-                # in case it was deleted or renamed so the current section identifier is added back
-                # si = SectionIdentifier(section_file_separator=self.text_section_view.section_file_separator, defaults=self.defaults)
-                #
-                self.file.set_section_content(
-                    section_separator=self.text_section_view.section_file_separator,
-                    section_content=SECTION_FILE_NEW_SECTION_PLACEHOLDER,
-                )
+        try:
+            if self.model.external_update:
+                self.file.reload()
+                try:
+                    current_section_text_before = self.file.get_section_content(
+                        section_separator=self.text_section_view.section_file_separator
+                    )
+                # KeyError raised if the current section was removed or renamed by a external update
+                except KeyError:
+                    # merge_strings prioritizes current_section_text_after over current_section_text_before
+                    # so empty string placeholder is set to current_section_text_before
+                    current_section_text_before = ""
+                    # self.file.reload() will remove the current section separator from self.file.section_separators
+                    # in case it was deleted or renamed so the current section identifier is added back
+                    # si = SectionIdentifier(section_file_separator=self.text_section_view.section_file_separator, defaults=self.defaults)
+                    #
+                    self.file.set_section_content(
+                        section_separator=self.text_section_view.section_file_separator,
+                        section_content=SECTION_FILE_NEW_SECTION_PLACEHOLDER,
+                    )
 
-            current_section_text_after = self.text_section_view.text
+                current_section_text_after = self.text_section_view.text
 
-            merged_current_section_text_data = merge_strings(
-                before=current_section_text_before, after=current_section_text_after
-            )
+                merged_current_section_text_data = merge_strings(
+                    before=current_section_text_before, after=current_section_text_after
+                )
 
-            self.text_section_view.text = merged_current_section_text_data
-            # un-focus the TextInput so that the cursor is not offset by the external update
-            self.text_section_view.focus = False
+                self.text_section_view.text = merged_current_section_text_data
+                # un-focus the TextInput so that the cursor is not offset by the external update
+                self.text_section_view.focus = False
 
-            self.set_drawer_items(
-                section_separators=self.file.section_separators_sorted
+                self.set_drawer_items(
+                    section_separators=self.file.section_separators_sorted
+                )
+
+            self.file.set_section_content(
+                section_separator=self.text_section_view.section_file_separator,
+                section_content=merged_current_section_text_data
+                or self.text_section_view.text,
             )
 
-        self.file.set_section_content(
-            section_separator=self.text_section_view.section_file_separator,
-            section_content=merged_current_section_text_data
-            or self.text_section_view.text,
-        )
+            raw_text_data = self.file.transform_data_by_sections_to_raw_data_content()
 
-        text_data = self.file.transform_data_by_sections_to_raw_data_content()
+            self.controller.save_file_data(data=raw_text_data)
 
-        self.controller.save_file_data(data=text_data)
+        except Exception as exc:
+            self.show_error_bar(error_message=f"Error while saving file, details: {exc}")
+            return
 
     def press_menu_item_save_file(self, *args):
         self.save_current_section_to_file()

tests/test_unit_controller.py

@@ -1,3 +1,5 @@
+import pytest
+
 from time import sleep
 from datetime import datetime
 from os import path, remove
@@ -70,6 +72,50 @@ def test_save_file_data(self, get_app):
         assert controller.model.file_size > 0
         assert datetime.fromtimestamp(controller.model.last_updated_on) >= _epoch_before
 
+    def test_save_file_data_handle_error(self, get_app):
+        # test case to cover scenario when data write fails no data is lost
+        controller = get_app.controller
+
+        assert controller.model.file_size == 0
+        _epoch_before = datetime.fromtimestamp(controller.model.last_updated_on)
+        assert _epoch_before
+
+        # asserting the default notes file contains data
+        with open(get_app.controller.defaults.DEFAULT_NOTES_FILE_NAME, mode="r") as f:
+            assert f.readlines() == ['<section=first> Quod equidem non reprehendo\n',
+                                     '<section=second> Quis istum dolorem timet']
+
+        controller.save_file_data(
+                data="""<section=first> Quod equidem non reprehendo
+<section=second> Quis istum dolorem timet
+"""
+        )
+
+        assert isinstance(controller.model.file_size, int)
+        # assert the model file_size is still > 0
+        assert controller.model.file_size > 0  # exact file size differs between OS types
+
+        # setting model file path as empty string is invalid enough to raise file write error exc
+        controller.model.file_path = ""
+
+        # writing to file through save_file_data raises Exception
+        with pytest.raises(Exception):
+            controller.save_file_data(
+                data="""<section=first> Quod equidem non reprehendo
+<section=second> Quis istum dolorem timet <section=third> !
+"""
+            )
+
+        # assert the file still contains the data
+        with open(get_app.controller.defaults.DEFAULT_NOTES_FILE_NAME, mode="r") as f:
+            assert f.readlines() == ['<section=first> Quod equidem non reprehendo\n',
+                                     '<section=second> Quis istum dolorem timet\n']
+
+        assert isinstance(controller.model.file_size, int)
+        # assert the model file_size is still > 0
+        assert controller.model.file_size > 0  # exact file size differs between OS types
+        assert datetime.fromtimestamp(controller.model.last_updated_on) >= _epoch_before
+
     def test_get_screen(self, get_app):
         controller = get_app.controller
         assert isinstance(controller.get_screen(), NotesView)

tests/test_unit_search.py

@@ -101,7 +101,7 @@ def test_search_default(self, get_file):
         search.search_full_words = False
 
         assert search.search_for_occurrences(
-            pattern="do", file=get_file, current_section_identifier="<section=first> ",
+            pattern="do", file=get_file, current_section="<section=first> ",
         ) == {"<section=first> ": [25]}
 
     def test_search_case_sensitive(self, get_file):
@@ -112,14 +112,14 @@ def test_search_case_sensitive(self, get_file):
         search.search_full_words = False
 
         assert search.search_for_occurrences(
-            pattern="do", file=get_file, current_section_identifier="<section=first> ",
+            pattern="do", file=get_file, current_section="<section=first> ",
         ) == {"<section=first> ": [25]}
 
         assert (
             search.search_for_occurrences(
                 pattern="dO",
                 file=get_file,
-                current_section_identifier="<section=first> ",
+                current_section="<section=first> ",
             )
             == {}
         )
@@ -132,7 +132,7 @@ def test_search_all_sections(self, get_file):
         search.search_full_words = False
 
         assert search.search_for_occurrences(
-            pattern="do", file=get_file, current_section_identifier="<section=first> ",
+            pattern="do", file=get_file, current_section="<section=first> ",
         ) == {"<section=first> ": [25], "<section=second> ": [11]}
 
     def test_search_full_words(self, get_file):
@@ -143,14 +143,14 @@ def test_search_full_words(self, get_file):
         search.search_full_words = True
 
         assert search.search_for_occurrences(
-            pattern="non", file=get_file, current_section_identifier="<section=first> ",
+            pattern="non", file=get_file, current_section="<section=first> ",
         ) == {"<section=first> ": [13]}
 
         assert (
             search.search_for_occurrences(
                 pattern="nonx",
                 file=get_file,
-                current_section_identifier="<section=first> ",
+                current_section="<section=first> ",
             )
             == {}
         )

tests/test_unit_view.py

@@ -858,6 +858,36 @@ def test_save_current_section_to_file_is_external_update_with_changes_to_differe
             == """<section=first> Quod equidem non reprehendo\n<section=second> Quis istum dolorem timet<section=test> test data"""
         )
 
+    def test_save_current_section_to_file_handle_error(self, get_app):
+        # setting model._last_updated_on manually will guarantee model.external_update returns False
+        get_app.controller.model._last_updated_on = int(time.time())
+
+        screen = get_app.controller.get_screen()
+
+        assert (
+            screen.file.get_raw_data_content()
+            == """<section=first> Quod equidem non reprehendo\n<section=second> Quis istum dolorem timet"""
+        )
+
+        screen.text_section_view.section_file_separator = "<section=a> "
+
+        screen.text_section_view.text = "test text"
+
+        # setting model file path as empty string is invalid enough to raise file write error exc
+        get_app.controller.model.file_path = ""
+
+        assert screen.save_current_section_to_file() is None
+
+        # assert `<section=a> test text` was not added to the file,
+        # however the file content still contains data before the write failure
+        assert (
+            screen.file.get_raw_data_content()
+            == """<section=first> Quod equidem non reprehendo\n<section=second> Quis istum dolorem timet"""
+        )
+
+        assert isinstance(screen.snackbar, CustomSnackbar)
+        assert screen.snackbar.text.startswith("Error while saving file, details:")
+
     def test_press_menu_item_save_file_is_not_external_update(self, get_app):
         # setting model._last_updated_on manually will guarantee model.external_update returns False
         get_app.controller.model._last_updated_on = int(time.time())