Merge pull request #562 from tangkong/bug_notes_blank_env

BUG/TST: allow new note to be written if no data exists, add unit test

docs/source/upcoming_release_notes/562-bug_notes_blank_env.rst

@@ -0,0 +1,22 @@
+562 bug_notes_blank_env
+#######################
+
+API Changes
+-----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- Creates new notes file if requested note file does not exist
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- tangkong

typhos/notes.py

@@ -98,8 +98,13 @@ def insert_into_yaml(path: Path, device_name: str, data: dict[str, str]) -> None
     try:
         with open(path, 'r') as f:
             device_notes = yaml.full_load(f)
+    except FileNotFoundError:
+        logger.info(f'No existing device notes found at {path}. '
+                    'Creating new notes file.')
+        device_notes = {}
     except Exception as ex:
-        logger.warning(f'unable to open existing device info: {ex}')
+        logger.warning(f'Unable to open existing device notes, aborting: {ex}')
+        return
 
     device_notes[device_name] = data
 

typhos/tests/test_notes.py

@@ -41,6 +41,23 @@ def env_notes_path(tmp_path: Path):
     os.environ.pop(NOTES_VAR)
 
 
+def test_new_note(qtbot: QtBot, tmp_path: Path, monkeypatch):
+    monkeypatch.setattr(platformdirs, 'user_data_path',
+                        lambda: tmp_path)
+
+    user_path = tmp_path / 'device_notes.yaml'
+    assert not user_path.exists()
+
+    notes_edit = TyphosNotesEdit()
+    qtbot.addWidget(notes_edit)
+    notes_edit.setup_data('Syn:Motor')
+
+    notes_edit.setText('hello new text')
+    notes_edit.save_note()
+
+    assert user_path.exists()
+
+
 def test_note_shadowing(qtbot: QtBot, user_notes_path: Path, env_notes_path: Path):
     # user data shadows all other sources
     notes_edit = TyphosNotesEdit()