feat: add --add-guid option in export mode to include GUID meta for each note

fix #66

Author: vzhd1701

evernote_backup/cli.py

@@ -255,6 +255,14 @@ def sync(
         " (e.g. to prevent backup chunking with zero changes)"
     ),
 )
+@click.option(
+    "--add-guid",
+    is_flag=True,
+    help=(
+        "Add GUID meta field to every exported note."
+        " (GUID is a unique note identifier used internally by Evernote)"
+    ),
+)
 @click.option(
     "--overwrite",
     is_flag=True,
@@ -271,6 +279,7 @@ def export(
     single_notes: bool,
     include_trash: bool,
     no_export_date: bool,
+    add_guid: bool,
     overwrite: bool,
     output_path: Path,
 ) -> None:
@@ -281,6 +290,7 @@ def export(
         single_notes=single_notes,
         include_trash=include_trash,
         no_export_date=no_export_date,
+        add_guid=add_guid,
         overwrite=overwrite,
         output_path=output_path,
     )

evernote_backup/cli_app.py

@@ -136,6 +136,7 @@ def export(
     single_notes: bool,
     include_trash: bool,
     no_export_date: bool,
+    add_guid: bool,
     overwrite: bool,
     output_path: Path,
 ) -> None:
@@ -149,6 +150,7 @@ def export(
         single_notes=single_notes,
         export_trash=include_trash,
         no_export_date=no_export_date,
+        add_guid=add_guid,
         overwrite=overwrite,
     )
 

evernote_backup/note_exporter.py

@@ -34,6 +34,7 @@ def __init__(
         single_notes: bool,
         export_trash: bool,
         no_export_date: bool,
+        add_guid: bool,
         overwrite: bool,
     ) -> None:
         self.storage = storage
@@ -42,6 +43,7 @@ def __init__(
         self.single_notes = single_notes
         self.export_trash = export_trash
         self.no_export_date = no_export_date
+        self.add_guid = add_guid
 
     def export_notebooks(self) -> None:
         count_notes = self.storage.notes.get_notes_count()
@@ -112,18 +114,23 @@ def _output_single_notes(
         for note in notes_source:
             note_path = self.safe_paths.get_file(*parent_dir, f"{note.title}.enex")
 
-            _write_export_file(note_path, note, self.no_export_date)
+            _write_export_file(note_path, note, self.no_export_date, self.add_guid)
 
     def _output_notebook(
         self, parent_dir: List[str], notebook_name: str, notes_source: Iterable[Note]
     ) -> None:
         notebook_path = self.safe_paths.get_file(*parent_dir, f"{notebook_name}.enex")
 
-        _write_export_file(notebook_path, notes_source, self.no_export_date)
+        _write_export_file(
+            notebook_path, notes_source, self.no_export_date, self.add_guid
+        )
 
 
 def _write_export_file(
-    file_path: Path, note_source: Union[Iterable[Note], Note], no_export_date: bool
+    file_path: Path,
+    note_source: Union[Iterable[Note], Note],
+    no_export_date: bool,
+    add_guid: bool,
 ) -> None:
     with open(file_path, "w", encoding="utf-8") as f:
         logger.debug(f"Writing file {file_path}")
@@ -139,7 +146,7 @@ def _write_export_file(
                 f' application="Evernote" version="10.10.5">\n'
             )
 
-        note_formatter = NoteFormatter()
+        note_formatter = NoteFormatter(add_guid=add_guid)
 
         if isinstance(note_source, Note):
             if logger.getEffectiveLevel() == logging.DEBUG:  # pragma: no cover

evernote_backup/note_formatter.py

@@ -13,8 +13,9 @@
 class NoteFormatter(object):
     """https://xml.evernote.com/pub/evernote-export3.dtd"""
 
-    def __init__(self) -> None:
+    def __init__(self, add_guid: bool = False) -> None:
         self._raw_elements: dict = {}
+        self.add_guid = add_guid
 
     def format_note(self, note: Note) -> str:
         self._raw_elements = {}
@@ -31,6 +32,9 @@ def format_note(self, note: Note) -> str:
             }
         }
 
+        if self.add_guid:
+            note_skeleton["note"]["guid"] = note.guid
+
         if note.attributes:
             note_skeleton["note"]["note-attributes"] = {
                 "subject-date": fmt_time(note.attributes.subjectDate),

tests/test_note_formatter.py

@@ -211,3 +211,16 @@ def test_note_from_past(mocker):
 
     assert "<created>00010101T000000Z</created>" in formatted_note
     assert "<updated>03850725T070640Z</updated>" in formatted_note
+
+
+def test_formatter_add_guid(mocker):
+    formatter = NoteFormatter(add_guid=True)
+
+    note_from_future = Note(
+        guid="test-guid",
+        title="test",
+    )
+
+    formatted_note = formatter.format_note(note_from_future)
+
+    assert "<guid>test-guid</guid>" in formatted_note

tests/test_op_export.py

@@ -493,3 +493,39 @@ def test_export_no_export_date(cli_invoker, fake_storage, tmp_path):
         book1_xml = f.read()
 
     assert "export-date" not in book1_xml
+
+
+@pytest.mark.usefixtures("fake_init_db")
+def test_export_add_guid(cli_invoker, fake_storage, tmp_path):
+    test_out_path = tmp_path / "test_out"
+
+    test_notebooks = [
+        Notebook(guid="nbid1", name="name1", stack=None),
+    ]
+
+    fake_storage.notebooks.add_notebooks(test_notebooks)
+
+    fake_storage.notes.add_note(
+        Note(
+            guid="id1",
+            title="title1",
+            content="test",
+            notebookGuid="nbid1",
+            active=True,
+        )
+    )
+
+    cli_invoker(
+        "export",
+        "--add-guid",
+        "--database",
+        "fake_db",
+        str(test_out_path),
+    )
+
+    book1_path = test_out_path / "name1.enex"
+
+    with open(book1_path, "r") as f:
+        book1_xml = f.read()
+
+    assert "<guid>id1</guid>" in book1_xml