pyDiffTools 0.1.46__tar.gz → 0.1.48__tar.gz

{pydifftools-0.1.46 → pydifftools-0.1.48}/MANIFEST.in

@@ -4,6 +4,7 @@ include LICENSE.md
 include pydifftools/diff-doc.js
 include pydifftools/xml2xlsx.vbs
 include pydifftools/comments.css
+include pydifftools/comments_author_colors.css
 include pydifftools/comment_tags.lua
 include pydifftools/comment_tags_margin.lua
 include pydifftools/comment_tags_no_comments.lua

{pydifftools-0.1.46/pyDiffTools.egg-info → pydifftools-0.1.48}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.46
+Version: 0.1.48
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck

{pydifftools-0.1.46 → pydifftools-0.1.48/pyDiffTools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.46
+Version: 0.1.48
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck

{pydifftools-0.1.46 → pydifftools-0.1.48}/pyDiffTools.egg-info/SOURCES.txt

@@ -58,6 +58,7 @@ pydifftools/comment_tags_margin.lua
 pydifftools/comment_tags_no_comments.lua
 pydifftools/comment_toggle.js
 pydifftools/comments.css
+pydifftools/comments_author_colors.css
 pydifftools/continuous.py
 pydifftools/copy_files.py
 pydifftools/diff-doc.js

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/bibliography.py

@@ -64,9 +64,9 @@ class BibEntry:
         return f"@{self.kind}{{{key or self.key},\n{body}\n}}"
 
 
-def bib_entries(text):
-    """Index entry spans and raw fields without reserializing them."""
-    entries = {}
+def bib_entry_list(text):
+    """Every entry's span and raw fields in order, including repeated keys."""
+    entries = []
     position = 0
     while position < len(text):
         position = scan_bibtex(text, position, "@")
@@ -106,9 +106,17 @@ def bib_entries(text):
                 raise ValueError(f"duplicate BibTeX field {name} in {key}")
             fields[name] = body[offset:boundary].strip()
             offset = boundary + 1
-        if key in entries:
-            raise ValueError(f"duplicate BibTeX key {key}")
-        entries[key] = BibEntry(start, end + 1, kind, key, fields)
+        entries.append(BibEntry(start, end + 1, kind, key, fields))
+    return entries
+
+
+def bib_entries(text):
+    """Index entry spans and raw fields without reserializing them."""
+    entries = {}
+    for entry in bib_entry_list(text):
+        if entry.key in entries:
+            raise ValueError(f"duplicate BibTeX key {entry.key}")
+        entries[entry.key] = entry
     return entries
 
 
@@ -118,6 +126,8 @@ def normalized_text(value):
     return "".join(char for char in text if char.isalnum())
 
 
+# also used by: tests/test_bibliography.py, which checks these duplicate
+# rules directly (cpb calls it from zotero.recover_bibliography)
 def duplicate_reason(existing, incoming):
     """Identify likely duplicates for human review using Pandoc CSL records.
 
@@ -210,6 +220,8 @@ def markdown_ast(text, renames=None):
     return tree
 
 
+# also used by: tests/test_bibliography.py, which checks citation rewriting
+# directly (cpb calls it from zotero.recover_bibliography)
 def rewrite_citations(markdown, renames):
     """Replace citation tokens, accepting edits only when Pandoc confirms them.
 
@@ -241,6 +253,8 @@ def rewrite_citations(markdown, renames):
     return text.encode("utf-8")
 
 
+# also used by: tests/test_bibliography.py, which checks the all-or-nothing
+# replacement directly (cpb calls it from zotero.recover_bibliography)
 def replace_bibliography_files(changes):
     """Stage validated replacements and roll back if a later replacement fails.
 

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/browser_lifecycle.py

@@ -2,6 +2,17 @@ import os
 import shutil
 import subprocess
 
+# callbacks that run before any dialog needs the user; cpb registers one
+# that closes its live preview, so issues are dealt with before it reopens
+dialog_callbacks = []
+
+
+def prepare_for_dialog():
+    """Let watch commands close their preview before a dialog appears."""
+    for callback in list(dialog_callbacks):
+        callback()
+
+
 def browser_window_is_alive(browser):
     # Keep all browser liveness checks in one place so watch commands share
     # the same shutdown behavior when a user closes the browser window.
@@ -29,6 +40,8 @@ def close_browser_window(browser):
         pass
 
 
+# also used by: notebook/fast_build.py (qmdb's forward search), besides
+# cpb in continuous.py; tests/test_continuous_shutdown.py monkeypatches it
 def forward_search_in_browser(browser, search_text):
     # Reuse the same browser-side find logic across cpb and qmdb.
     if browser is None or not search_text:

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/citation_dialog.py

@@ -21,20 +21,49 @@ from PySide6.QtWidgets import (
 class DuplicateDialog(QDialog):
     """Choose an entry or merge fields; default to existing values and key."""
 
-    def __init__(self, matches, incoming, source):
+    def __init__(self, matches, incoming, source, mode="zotero"):
         super().__init__()
         self.matches = matches
         self.incoming = incoming
         self.decision = None
-        self.setWindowTitle("pydifft cpb — Possible duplicate citation")
         self.resize(1000, 650)
         layout = QVBoxLayout(self)
-        explanation = QLabel(
-            f"Review the imported citation for {source}.\n"
-            "Keeping or merging a duplicate also replaces @UNCHOSEN with "
-            "@CHOSEN in this Markdown file. Other documents are not edited.\n"
-            "For a merge, choose each field below, including the citation key."
-        )
+        if mode == "bibliography":
+            # {{{ two entries in the bibliography share one citation key
+            self.setWindowTitle("pydifft cpb — Duplicate citation key")
+            text = (
+                f"{source} defines @{incoming['key']} twice, so no missing "
+                "citations can be added until one entry is chosen.\n"
+                "Keep one entry, or merge them field by field; the other "
+                "entry is removed from the bibliography."
+            )
+            self.labels = ["First entry", "Second entry"]
+            actions = [
+                ("Keep first", "existing"),
+                ("Keep second", "incoming"),
+                ("Merge selected fields", "merge"),
+                ("Leave both (add no citations)", "skip"),
+            ]
+            # }}}
+        else:
+            self.setWindowTitle("pydifft cpb — Possible duplicate citation")
+            text = (
+                f"Review the imported citation for {source}.\n"
+                "Keeping or merging a duplicate also replaces @UNCHOSEN with "
+                "@CHOSEN in this Markdown file. Other documents are not "
+                "edited.\n"
+                "For a merge, choose each field below, including the citation "
+                "key."
+            )
+            self.labels = ["Existing", "Zotero"]
+            actions = [
+                ("Keep existing", "existing"),
+                ("Keep Zotero", "incoming"),
+                ("Merge selected fields", "merge"),
+                ("Not a duplicate: keep both", "both"),
+                ("Skip this import", "skip"),
+            ]
+        explanation = QLabel(text)
         explanation.setWordWrap(True)
         layout.addWidget(explanation)
         self.match_selector = QComboBox()
@@ -44,7 +73,16 @@ class DuplicateDialog(QDialog):
         self.table = QTableWidget()
         self.table.setColumnCount(4)
         self.table.setHorizontalHeaderLabels(
-            ["Field", "Existing bibliography", "Zotero", "Merge uses"]
+            [
+                "Field",
+                (
+                    "Existing bibliography"
+                    if mode == "zotero"
+                    else self.labels[0]
+                ),
+                self.labels[1],
+                "Merge uses",
+            ]
         )
         self.table.horizontalHeader().setSectionResizeMode(
             QHeaderView.ResizeMode.Stretch
@@ -52,13 +90,7 @@ class DuplicateDialog(QDialog):
         layout.addWidget(self.table)
         buttons = QHBoxLayout()
         self.buttons = {}
-        for label, action in [
-            ("Keep existing", "existing"),
-            ("Keep Zotero", "incoming"),
-            ("Merge selected fields", "merge"),
-            ("Not a duplicate: keep both", "both"),
-            ("Skip this import", "skip"),
-        ]:
+        for label, action in actions:
             button = QPushButton(label)
             button.setAutoDefault(False)
             button.clicked.connect(
@@ -94,9 +126,9 @@ class DuplicateDialog(QDialog):
                 self.table.setItem(row, column, cell)
             selector = QComboBox()
             if name in self.left:
-                selector.addItem("Existing", self.left[name])
+                selector.addItem(self.labels[0], self.left[name])
             if name in self.right:
-                selector.addItem("Zotero", self.right[name])
+                selector.addItem(self.labels[1], self.right[name])
             self.table.setCellWidget(row, 3, selector)
             self.selectors[name] = selector
         self.table.resizeRowsToContents()

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/comment_migration.py

@@ -11,6 +11,8 @@ import textwrap
 
 import yaml
 
+from .browser_lifecycle import prepare_for_dialog
+
 _FRONT_MATTER_RE = re.compile(
     r"\A(\ufeff?---[ \t]*\r?\n)(.*?)(\r?\n(?:---|\.\.\.)[ \t]*(?:\r?\n|$))",
     re.DOTALL,
@@ -78,6 +80,8 @@ def _most_distant_hue(colors):
     return (start + gap_size / 2) % 360
 
 
+# also used by: tests/test_comment_migration.py, which compiles its Qt
+# script and monkeypatches it (cpb calls it from prepare_comment_source)
 def _migration_dialog(filename, colors, legacy):
     """Ask Qt for all migrations and return decisions without editing files."""
     script = r"""
@@ -280,6 +284,7 @@ if result["accepted"]:
 
 print(json.dumps(result))
 """
+    prepare_for_dialog()
     completed = subprocess.run(
         # the dialog reads the document from its file, since the text of a
         # large document exceeds the operating system's argument limit

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/comment_tags.lua

@@ -34,6 +34,24 @@ local OPENERS = {
 }
 local AUTHOR_COLORS = {}
 
+local function author_color_style(color)
+  local red = tonumber(color:sub(2, 3), 16)
+  local green = tonumber(color:sub(4, 5), 16)
+  local blue = tonumber(color:sub(6, 7), 16)
+  local function tint(component)
+    return math.floor(component * 0.13 + 255 * 0.87 + 0.5)
+  end
+  local background = string.format(
+    "#%02x%02x%02x", tint(red), tint(green), tint(blue)
+  )
+  return string.format(
+    "--comment-accent-color: %s; "
+      .. "--comment-accent-background-color: %s; "
+      .. "border-color: %s; background-color: %s;",
+    color, background, color, background
+  )
+end
+
 local comment_id = 0
 local function next_id()
   comment_id = comment_id + 1
@@ -43,7 +61,7 @@ end
 local function make_inline_comment(side, content_inlines, spec)
   local attributes = {}
   if spec and spec.color then
-    attributes["style"] = "--comment-accent-color: " .. spec.color .. ";"
+    attributes["style"] = author_color_style(spec.color)
     attributes["data-comment-author"] = spec.author
   end
   local inner = pandoc.Span(
@@ -66,7 +84,7 @@ local function make_block_overlay(side, id, content_blocks, spec)
       ["data-comment-id"] = id,
       ["data-comment-author"] = spec and spec.author or nil,
       ["style"] = spec and spec.color
-        and ("--comment-accent-color: " .. spec.color .. ";") or nil,
+        and author_color_style(spec.color) or nil,
     })
   )
 end
@@ -402,7 +420,7 @@ function Div(el)
       if #style > 0 and not style:match(";%s*$") then
         style = style .. ";"
       end
-      el.attributes.style = style .. "--comment-accent-color: " .. color .. ";"
+      el.attributes.style = style .. author_color_style(color)
       el.attributes["data-comment-author"] = author
     end
   end

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/comment_tags_margin.lua

@@ -35,6 +35,24 @@ local OPENERS = {
 }
 local AUTHOR_COLORS = {}
 
+local function author_color_style(color)
+  local red = tonumber(color:sub(2, 3), 16)
+  local green = tonumber(color:sub(4, 5), 16)
+  local blue = tonumber(color:sub(6, 7), 16)
+  local function tint(component)
+    return math.floor(component * 0.13 + 255 * 0.87 + 0.5)
+  end
+  local background = string.format(
+    "#%02x%02x%02x", tint(red), tint(green), tint(blue)
+  )
+  return string.format(
+    "--comment-accent-color: %s; "
+      .. "--comment-accent-background-color: %s; "
+      .. "border-color: %s; background-color: %s;",
+    color, background, color, background
+  )
+end
+
 local comment_id = 0
 local function next_id()
   comment_id = comment_id + 1
@@ -69,7 +87,7 @@ local function make_inline_comment(side, content_inlines, spec)
           ["data-comment-author"] = spec and spec.author or nil,
           ["style"] = "font-size: 6pt;"
             .. (spec and spec.color
-              and (" --comment-accent-color: " .. spec.color .. ";") or ""),
+              and (" " .. author_color_style(spec.color)) or ""),
         }
       )
     )
@@ -101,7 +119,7 @@ local function make_block_overlay(side, id, content_blocks, spec)
         ["data-comment-author"] = spec and spec.author or nil,
         ["style"] = "font-size: 6pt;"
           .. (spec and spec.color
-            and (" --comment-accent-color: " .. spec.color .. ";") or ""),
+            and (" " .. author_color_style(spec.color)) or ""),
       }
     )
   )
@@ -441,7 +459,7 @@ function Div(el)
       if #style > 0 and not style:match(";%s*$") then
         style = style .. ";"
       end
-      el.attributes.style = style .. "--comment-accent-color: " .. color .. ";"
+      el.attributes.style = style .. author_color_style(color)
       el.attributes["data-comment-author"] = author
     end
   end

pydifftools-0.1.48/pydifftools/comments_author_colors.css

@@ -0,0 +1,20 @@
+/* Keep comment pointer triangles in sync with per-author bubble colors. */
+span.comment-pin > span.comment-right::before,
+.comment-overlay.comment-right::before {
+  border-color: transparent var(--comment-accent-color, #5aa0ff) transparent transparent;
+}
+
+span.comment-pin > span.comment-right::after,
+.comment-overlay.comment-right::after {
+  border-color: transparent var(--comment-accent-background-color, #eaf3ff) transparent transparent;
+}
+
+span.comment-pin > span.comment-left::before,
+.comment-overlay.comment-left::before {
+  border-color: transparent transparent transparent var(--comment-accent-color, #5aa0ff);
+}
+
+span.comment-pin > span.comment-left::after,
+.comment-overlay.comment-left::after {
+  border-color: transparent transparent transparent var(--comment-accent-background-color, #eaf3ff);
+}

{pydifftools-0.1.46 → pydifftools-0.1.48}/pydifftools/continuous.py

@@ -23,7 +23,9 @@ from .comment_migration import prepare_comment_source
 from .browser_lifecycle import (
     browser_window_is_alive,
     close_browser_window,
+    dialog_callbacks,
     forward_search_in_browser,
+    prepare_for_dialog,
 )
 from .forward_search import (
     CPB_FORWARD_SEARCH_PORT,
@@ -63,6 +65,9 @@ def _comment_filter_mode(path, packaged_filters=None):
 
 
 # Kept separate so its prompt choices can be unit-tested.
+# also used by: tests/test_wrap_check.py and tests/cli/test_commands.py,
+# which call it directly or monkeypatch it to answer the prompt (cpb calls
+# it from run_pandoc)
 def confirm_restore_comment_filter(active_mode):
     if active_mode == "none":
         message = (
@@ -70,19 +75,24 @@ def confirm_restore_comment_filter(active_mode):
             "but you ran without the --no-comments flag.\n\n"
             "Note that you have not locally edited the filter relative to "
             "the library default.\n\n"
-            "Do you want to show comments, or continue with no comments?"
+            "Do you want to update the filter and comment styles to the "
+            "library versions and show comments, or keep no comments?"
         )
         default_choice = "restore"
+        update_label = "update filter and styles; show comments"
+        keep_label = "keep no comments"
     elif active_mode == "custom":
         message = (
-            "The current lua filter does not match the pyDiffTools library "
-            "default or the no-comments filter, but you ran without the "
-            "--no-comments flag.\n\n"
-            "Note that this looks like a locally edited filter.\n\n"
-            "Do you want to show comments using the library default, or "
-            "continue with no comments?"
+            "The current lua filter differs from the pyDiffTools library "
+            "filters, but you ran without the --no-comments flag. It may be "
+            "an older distributed filter or a local edit.\n\n"
+            "Do you want to update the filter and comment styles to the "
+            "library versions and show comments, or keep the current "
+            "filter and styles?"
         )
         default_choice = "keep"
+        update_label = "update filter and styles; show comments"
+        keep_label = "keep current filter"
     else:
         raise ValueError(
             "Comment filter restore prompt is only valid for custom or "
@@ -97,12 +107,8 @@ box = QMessageBox()
 box.setWindowTitle("pydifft cpb")
 box.setIcon(QMessageBox.Icon.Question)
 box.setText(sys.argv[1])
-keep_button = box.addButton(
-    "no comments", QMessageBox.ButtonRole.RejectRole
-)
-restore_button = box.addButton(
-    "show comments", QMessageBox.ButtonRole.AcceptRole
-)
+keep_button = box.addButton(sys.argv[3], QMessageBox.ButtonRole.RejectRole)
+restore_button = box.addButton(sys.argv[4], QMessageBox.ButtonRole.AcceptRole)
 if sys.argv[2] == "restore":
     box.setDefaultButton(restore_button)
 else:
@@ -112,8 +118,12 @@ if box.clickedButton() is restore_button:
     sys.exit(0)
 sys.exit(1)
 """
+    prepare_for_dialog()
     result = subprocess.run(
-        [sys.executable, "-c", prompt_script, message, default_choice],
+        [
+            sys.executable, "-c", prompt_script, message, default_choice,
+            keep_label, update_label,
+        ],
         capture_output=True,
         text=True,
     )
@@ -127,6 +137,8 @@ sys.exit(1)
     raise RuntimeError("pydifft cpb filter dialog failed.")
 
 
+# also used by: tests/test_wrap_check.py, which drives this window directly
+# (cpb calls it from run_pandoc)
 def show_markdown_fix_dialog(report):
     """Show automatic fixes and any source edits that still need a user."""
     from html import escape
@@ -148,6 +160,7 @@ def show_markdown_fix_dialog(report):
     layout = report.get("layout", [])
     if not fixes and not warnings and not layout:
         return
+    prepare_for_dialog()
 
     # a QApplication must exist before any widget is constructed
     application = QApplication.instance() or QApplication([])
@@ -362,6 +375,8 @@ def show_markdown_fix_dialog(report):
     return user_says_fixed
 
 
+# also used by: tests/test_wrap_check.py, which drives this window directly
+# (cpb calls it from run_pandoc)
 def show_markdown_reload_dialog():
     """Ask the user to reload a source file changed by automatic fixes."""
     from PySide6.QtWidgets import (
@@ -372,6 +387,7 @@ def show_markdown_reload_dialog():
         QVBoxLayout,
     )
 
+    prepare_for_dialog()
     # a QApplication must exist before any widget is constructed
     application = QApplication.instance() or QApplication([])
     dialog = QDialog()
@@ -421,6 +437,10 @@ def run_pandoc(
         break
 
     if automatic_fixes_were_made:
+        # a corrected comment tag (e.g. <XYcomm> -> <XYcom>) can name an
+        # author with no XYcolor yet, so migrate comments again now rather
+        # than on the next save
+        prepare_comment_source(filename)
         show_markdown_reload_dialog()
     # }}}
 
@@ -514,6 +534,10 @@ def run_pandoc(
                     shutil.copy2(
                         packaged_filters["default"], active_filter
                     )
+                    shutil.copy2(
+                        os.path.join(package_dir, "comments.css"),
+                        os.path.join(source_dir, "comments.css"),
+                    )
                     effective_filter_mode = "default"
                 else:
                     effective_filter_mode = active_mode
@@ -565,7 +589,10 @@ def run_pandoc(
         # }}}
         # Only copy the comment UI assets when comments should be rendered.
         if effective_filter_mode != "none":
-            for asset_name in ["comments.css", "comment_toggle.js"]:
+            for asset_name in [
+                "comments.css", "comments_author_colors.css",
+                "comment_toggle.js",
+            ]:
                 target_path = os.path.join(source_dir, asset_name)
                 if not os.path.exists(target_path):
                     shutil.copy2(
@@ -909,7 +936,6 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
         daemon=True,
     )
     chrome = None
-    notice = None
     observer = None
     observer_started = False
     socket_thread_started = False
@@ -924,6 +950,9 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
         # orphaned browser session. Remember the source version from before
         # the build so an edit during a slow Pandoc run remains pending.
         source_missing = object()
+        # every dialog is dealt with (OK pressed) before Pandoc runs or
+        # Chrome opens
+        zotero_notice()
         prepare_comment_source(filename)
         initial_source_stat = os.stat(source_path)
         handled_signature = (
@@ -940,7 +969,6 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
             wrapnumber=wrapnumber,
         )
         append_autorefresh(html_file)
-        notice = zotero_notice()
 
         # Selenium is deliberately initialized once, after the first
         # successful build. Nothing in recovery constructs a browser.
@@ -992,6 +1020,16 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
         # immediately after Chrome loads can become polling's initial snapshot
         # and never be reported as a change.
         chrome.get("file://" + os.path.abspath(html_file))
+
+        def close_for_dialog():
+            # a rebuild needs the user, so close the preview while the
+            # issues are dealt with; it reopens once the rebuild is done
+            nonlocal chrome
+            if chrome is not None:
+                close_browser_window(chrome)
+                chrome = None
+
+        dialog_callbacks.append(close_for_dialog)
         rebuild_pending = False
         stable_signature = None
         stable_since = None
@@ -1102,18 +1140,26 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
                                 traceback.print_exc()
                         else:
                             handled_signature = attempted_signature
-                            if not browser_window_is_alive(chrome):
-                                break
-                            try:
-                                chrome.refresh()
-                            except WebDriverException:
-                                print(
-                                    "pydifft cpb: Chrome is no longer "
-                                    "available; stopping without reopening "
-                                    "it.",
-                                    file=sys.stderr,
-                                )
-                                break
+                            if chrome is not None:
+                                if not browser_window_is_alive(chrome):
+                                    break
+                                try:
+                                    chrome.refresh()
+                                except WebDriverException:
+                                    print(
+                                        "pydifft cpb: Chrome is no longer "
+                                        "available; stopping without "
+                                        "reopening it.",
+                                        file=sys.stderr,
+                                    )
+                                    break
+                        if chrome is None:
+                            # {{{ reopen the preview a dialog closed
+                            chrome = webdriver.Chrome()
+                            chrome.get(
+                                "file://" + os.path.abspath(html_file)
+                            )
+                            # }}}
             # }}}
             time.sleep(MAIN_LOOP_INTERVAL_SECONDS)
     except KeyboardInterrupt:
@@ -1127,10 +1173,7 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
         if socket_thread_started:
             socket_thread.join()
         close_browser_window(chrome)
-        if notice is not None:
-            if notice.poll() is None:
-                notice.terminate()
-            notice.wait()
+        dialog_callbacks.clear()
 
 
 if __name__ == "__main__":