pyDiffTools 0.1.28__tar.gz → 0.1.29__tar.gz

{pydifftools-0.1.28/pyDiffTools.egg-info → pydifftools-0.1.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.28
+Version: 0.1.29
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck
@@ -41,6 +41,8 @@ Requires-Dist: watchdog
 Requires-Dist: pydot
 Requires-Dist: python-dateutil
 Requires-Dist: jinja2
+Requires-Dist: ipykernel
+Requires-Dist: matplotlib
 Requires-Dist: nbformat
 Requires-Dist: nbconvert
 Requires-Dist: pygments

{pydifftools-0.1.28 → pydifftools-0.1.29/pyDiffTools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.28
+Version: 0.1.29
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck
@@ -41,6 +41,8 @@ Requires-Dist: watchdog
 Requires-Dist: pydot
 Requires-Dist: python-dateutil
 Requires-Dist: jinja2
+Requires-Dist: ipykernel
+Requires-Dist: matplotlib
 Requires-Dist: nbformat
 Requires-Dist: nbconvert
 Requires-Dist: pygments

{pydifftools-0.1.28 → pydifftools-0.1.29}/pyDiffTools.egg-info/SOURCES.txt

@@ -81,6 +81,7 @@ pydifftools/flowchart/dot_to_yaml.py
 pydifftools/flowchart/graph.py
 pydifftools/flowchart/watch_graph.py
 pydifftools/notebook/__init__.py
+pydifftools/notebook/display.py
 pydifftools/notebook/fast_build.py
 pydifftools/notebook/tex_to_qmd.py
 tests/test_browser_lifecycle.py

{pydifftools-0.1.28 → pydifftools-0.1.29}/pyDiffTools.egg-info/requires.txt

@@ -5,6 +5,8 @@ watchdog
 pydot
 python-dateutil
 jinja2
+ipykernel
+matplotlib
 nbformat
 nbconvert
 pygments

{pydifftools-0.1.28 → pydifftools-0.1.29}/pydifftools/command_line.py

@@ -943,11 +943,82 @@ def main(argv=None):
             "argument --no-comments: not allowed with argument "
             "--comments-to-margin"
         )
+    if (
+        namespace.command == "qmdb"
+        and namespace.always_code
+        and namespace.no_code
+    ):
+        parser._pydifft_subparsers["qmdb"].error(
+            "argument --no-code: not allowed with argument --always-code"
+        )
     handler = namespace._handler
     handler_kwargs = dict(vars(namespace))
     handler_kwargs.pop("_handler", None)
     handler_kwargs.pop("command", None)
-    handler(**handler_kwargs)
+    # {{{ explain Chrome and ChromeDriver version mismatches
+    from selenium.common.exceptions import SessionNotCreatedException
+
+    try:
+        handler(**handler_kwargs)
+    except SessionNotCreatedException as exc:
+        details = str(exc)
+        driver_match = re.search(
+            r"ChromeDriver only supports Chrome version (\d+)",
+            details,
+        )
+        browser_match = re.search(
+            r"Current browser version is (\d+)",
+            details,
+        )
+        if driver_match is None or browser_match is None:
+            raise
+
+        driver_major = int(driver_match.group(1))
+        browser_major = int(browser_match.group(1))
+        print(
+            "pydifft: Chrome could not start because ChromeDriver "
+            f"{driver_major} and Chrome {browser_major} do not match.",
+            file=sys.stderr,
+        )
+        if shutil.which("apt-get") is not None:
+            if browser_major < driver_major:
+                binary_match = re.search(
+                    r"binary path ([^;\n]+)",
+                    details,
+                )
+                browser_binary = (
+                    binary_match.group(1) if binary_match is not None else ""
+                )
+                browser_package = (
+                    "chromium"
+                    if "chromium" in browser_binary
+                    else "google-chrome-stable"
+                )
+                packages = browser_package
+            elif driver_major < browser_major:
+                packages = "chromium-driver"
+            else:
+                packages = "google-chrome-stable chromium-driver"
+            print(
+                "Update the older system package:\n"
+                "  sudo apt update\n"
+                f"  sudo apt install --only-upgrade {packages}",
+                file=sys.stderr,
+            )
+        else:
+            print(
+                "Update the older Chrome or ChromeDriver installation so "
+                "their major versions match.",
+                file=sys.stderr,
+            )
+        print(
+            "Then retry. You can verify the versions with:\n"
+            "  google-chrome --version\n"
+            "  chromedriver --version",
+            file=sys.stderr,
+        )
+        raise SystemExit(1) from None
+    # }}}
 
 
 if __name__ == "__main__":

{pydifftools-0.1.28 → pydifftools-0.1.29}/pydifftools/continuous.py

@@ -52,72 +52,88 @@ def forward_search_listener(stop_event, search_queue):
     server.close()
 
 
-def _file_contains_text(path, text):
+def _comment_filter_mode(path, packaged_filters=None):
     if not os.path.exists(path):
-        return False
+        return "missing"
+    if packaged_filters is None:
+        package_dir = os.path.dirname(os.path.abspath(__file__))
+        packaged_filters = {
+            "default": os.path.join(package_dir, "comment_tags.lua"),
+            "margin": os.path.join(package_dir, "comment_tags_margin.lua"),
+            "none": os.path.join(package_dir, "comment_tags_no_comments.lua"),
+        }
     with open(path, encoding="utf-8") as fp:
-        return text in fp.read()
-
-
-def _comment_filter_mode(path):
-    if not os.path.exists(path):
-        return None
-    if _file_contains_text(path, MARGIN_COMMENTS_FILTER_MARKER):
-        return "margin"
-    if _file_contains_text(path, NO_COMMENTS_FILTER_MARKER):
-        return "none"
-    return "default"
-
+        filter_text = fp.read()
+    for mode in ["default", "margin", "none"]:
+        with open(packaged_filters[mode], encoding="utf-8") as fp:
+            if filter_text == fp.read():
+                return mode
+    return "custom"
 
-def _set_comment_filter_mode(source_dir, mode):
-    if mode not in {"default", "margin", "none"}:
-        raise ValueError(f"Unknown comment filter mode: {mode}")
-    package_dir = os.path.dirname(os.path.abspath(__file__))
-    active_filter = os.path.join(source_dir, "comment_tags.lua")
-    inactive_filter = os.path.join(source_dir, "comment_tags.lua.inactive")
-    packaged_filters = {
-        "default": os.path.join(package_dir, "comment_tags.lua"),
-        "margin": os.path.join(package_dir, "comment_tags_margin.lua"),
-        "none": os.path.join(package_dir, "comment_tags_no_comments.lua"),
-    }
 
-    active_mode = _comment_filter_mode(active_filter)
-    inactive_mode = _comment_filter_mode(inactive_filter)
-
-    if mode == "default":
-        if active_mode == "default":
-            return
-        if active_mode in {"margin", "none"}:
-            if inactive_mode == "default":
-                temp_filter = active_filter + ".swap_tmp"
-                os.replace(active_filter, temp_filter)
-                os.replace(inactive_filter, active_filter)
-                os.replace(temp_filter, inactive_filter)
-            else:
-                os.replace(active_filter, inactive_filter)
-                shutil.copy2(packaged_filters["default"], active_filter)
-            return
-        if active_mode is None:
-            if inactive_mode == "default":
-                os.replace(inactive_filter, active_filter)
-            else:
-                shutil.copy2(packaged_filters["default"], active_filter)
-            return
-        shutil.copy2(packaged_filters["default"], active_filter)
-        return
+def _confirm_restore_comment_filter(active_mode):
+    if active_mode == "none":
+        message = (
+            "The current lua filter is the one that does not show comments, "
+            "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 keep the current filter, or restore the library "
+            "default that shows comments?"
+        )
+        default_choice = "restore"
+    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 keep the current filter, or restore the library "
+            "default that shows comments?"
+        )
+        default_choice = "keep"
+    else:
+        raise ValueError(
+            "Comment filter restore prompt is only valid for custom or "
+            f"no-comments filters, not {active_mode!r}"
+        )
+    prompt_script = """
+import sys
+from PySide6.QtWidgets import QApplication, QMessageBox
 
-    if active_mode == mode:
-        return
-    if active_mode == "default":
-        os.replace(active_filter, inactive_filter)
-        shutil.copy2(packaged_filters[mode], active_filter)
-        return
-    if active_mode in {"margin", "none"}:
-        shutil.copy2(packaged_filters[mode], active_filter)
-        return
-    if active_mode is None and inactive_mode != "default":
-        shutil.copy2(packaged_filters["default"], inactive_filter)
-    shutil.copy2(packaged_filters[mode], active_filter)
+app = QApplication(sys.argv[:1])
+box = QMessageBox()
+box.setWindowTitle("pydifft cpb")
+box.setIcon(QMessageBox.Icon.Question)
+box.setText(sys.argv[1])
+keep_button = box.addButton(
+    "Keep current filter", QMessageBox.ButtonRole.RejectRole
+)
+restore_button = box.addButton(
+    "Restore library default", QMessageBox.ButtonRole.AcceptRole
+)
+if sys.argv[2] == "restore":
+    box.setDefaultButton(restore_button)
+else:
+    box.setDefaultButton(keep_button)
+box.exec()
+if box.clickedButton() is restore_button:
+    sys.exit(0)
+sys.exit(1)
+"""
+    result = subprocess.run(
+        [sys.executable, "-c", prompt_script, message, default_choice],
+        capture_output=True,
+        text=True,
+    )
+    if result.returncode == 0:
+        return True
+    if result.returncode == 1:
+        return False
+    stderr = result.stderr.strip()
+    if stderr:
+        raise RuntimeError(f"pydifft cpb filter dialog failed: {stderr}")
+    raise RuntimeError("pydifft cpb filter dialog failed.")
 
 
 def run_pandoc(
@@ -168,10 +184,87 @@ def run_pandoc(
     ):
         # Keep the active comment filter in the markdown directory so pandoc
         # picks it up alongside other user-supplied project filters.
-        _set_comment_filter_mode(source_dir, comment_filter_mode)
+        # {{{ select the active comment_tags.lua filter
+        package_dir = os.path.dirname(os.path.abspath(__file__))
+        active_filter = os.path.join(source_dir, "comment_tags.lua")
+        inactive_filter = os.path.join(
+            source_dir, "comment_tags.lua.inactive"
+        )
+        packaged_filters = {
+            "default": os.path.join(package_dir, "comment_tags.lua"),
+            "margin": os.path.join(package_dir, "comment_tags_margin.lua"),
+            "none": os.path.join(package_dir, "comment_tags_no_comments.lua"),
+        }
+        active_mode = _comment_filter_mode(active_filter, packaged_filters)
+        inactive_mode = _comment_filter_mode(inactive_filter, packaged_filters)
+
+        if comment_filter_mode == "default":
+            if active_mode == "default":
+                effective_filter_mode = "default"
+            elif active_mode == "none":
+                if _confirm_restore_comment_filter("none"):
+                    shutil.copy2(
+                        packaged_filters["default"], active_filter
+                    )
+                    effective_filter_mode = "default"
+                else:
+                    effective_filter_mode = "none"
+            elif active_mode == "custom":
+                if _confirm_restore_comment_filter("custom"):
+                    shutil.copy2(
+                        packaged_filters["default"], active_filter
+                    )
+                    effective_filter_mode = "default"
+                else:
+                    effective_filter_mode = "custom"
+            elif active_mode == "margin":
+                if inactive_mode in {"default", "custom"}:
+                    temp_filter = active_filter + ".swap_tmp"
+                    os.replace(active_filter, temp_filter)
+                    os.replace(inactive_filter, active_filter)
+                    os.replace(temp_filter, inactive_filter)
+                    effective_filter_mode = inactive_mode
+                else:
+                    os.replace(active_filter, inactive_filter)
+                    shutil.copy2(
+                        packaged_filters["default"], active_filter
+                    )
+                    effective_filter_mode = "default"
+            elif active_mode == "missing":
+                if inactive_mode in {"default", "custom"}:
+                    os.replace(inactive_filter, active_filter)
+                    effective_filter_mode = inactive_mode
+                else:
+                    shutil.copy2(
+                        packaged_filters["default"], active_filter
+                    )
+                    effective_filter_mode = "default"
+            else:
+                shutil.copy2(packaged_filters["default"], active_filter)
+                effective_filter_mode = "default"
+        else:
+            effective_filter_mode = comment_filter_mode
+            if active_mode == comment_filter_mode:
+                pass
+            elif active_mode in {"default", "custom"}:
+                os.replace(active_filter, inactive_filter)
+                shutil.copy2(
+                    packaged_filters[comment_filter_mode], active_filter
+                )
+            else:
+                if active_mode == "missing" and inactive_mode not in {
+                    "default",
+                    "custom",
+                }:
+                    shutil.copy2(
+                        packaged_filters["default"], inactive_filter
+                    )
+                shutil.copy2(
+                    packaged_filters[comment_filter_mode], active_filter
+                )
+        # }}}
         # Only copy the comment UI assets when comments should be rendered.
-        if comment_filter_mode != "none":
-            package_dir = os.path.dirname(os.path.abspath(__file__))
+        if effective_filter_mode != "none":
             for asset_name in ["comments.css", "comment_toggle.js"]:
                 target_path = os.path.join(source_dir, asset_name)
                 if not os.path.exists(target_path):
@@ -483,6 +576,4 @@ def cpb(filename, comments_to_margin=False, no_comments=False):
 
 
 if __name__ == "__main__":
-    filename = sys.argv[1]
-    cpb(filename)
-    # Open the HTML file in the default web browser
+    raise SystemExit("Use `pydifft cpb <filename.md>` instead.")

pydifftools-0.1.29/pydifftools/notebook/display.py

@@ -0,0 +1,67 @@
+"""Small display helpers for fast notebook builds."""
+
+
+class _NotebookCapture:
+    """Emit notebook content in an explicit order."""
+
+    def __init__(self):
+        self._figures = []
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc, tb):
+        for fig in self._figures:
+            self._close_figure(fig)
+        return False
+
+    def md(self, text):
+        """Display markdown text as a Jupyter Markdown MIME bundle."""
+        from IPython.display import Markdown, display
+
+        display(Markdown(text))
+
+    def fig(self, obj=None):
+        """Display a Matplotlib figure-like object and close it afterward."""
+        from io import BytesIO
+
+        from IPython.display import Image, display
+
+        fig = self._figure_from_object(obj)
+        if hasattr(fig, "savefig"):
+            data = BytesIO()
+            fig.savefig(data, format="png", bbox_inches="tight")
+            display(Image(data=data.getvalue()))
+        else:
+            display(fig)
+        self._figures.append(fig)
+        self._close_figure(fig)
+
+    def _figure_from_object(self, obj):
+        import matplotlib.pyplot as plt
+
+        if obj is None:
+            return plt.gcf()
+        if isinstance(obj, (list, tuple)):
+            if not obj:
+                raise ValueError("cannot display an empty figure object list")
+            return self._figure_from_object(obj[0])
+        if hasattr(obj, "get_figure"):
+            fig = obj.get_figure()
+            if fig is not None:
+                return fig
+        if hasattr(obj, "figure"):
+            fig = obj.figure
+            if fig is not None and fig is not obj:
+                return fig
+        return obj
+
+    def _close_figure(self, fig):
+        import matplotlib.pyplot as plt
+
+        plt.close(fig)
+
+
+def nb_capture():
+    """Return an ordered notebook output capture context."""
+    return _NotebookCapture()