Merge pull request #126 from ConstantinGahr/remove-duplicate-phantoms

Remove duplicate phantoms

Author: sschuhmann

helium.py

@@ -5,7 +5,6 @@
 Copyright (c) 2016-2018, NEGORO Tetsuya (https://github.com/ngr-t)
 """
 
-import bisect
 import json
 import os
 import re
@@ -18,7 +17,7 @@
 from sublime_plugin import EventListener, TextCommand, ViewEventListener
 
 from .lib.kernel import KernelConnection
-from .lib.utils import add_path, chain_callbacks
+from .lib.utils import add_path, chain_callbacks, get_cell
 
 with add_path(os.path.join(os.path.dirname(__file__), "lib/client")):
     # Import jupyter_client related functions and classes.
@@ -33,6 +32,7 @@
 HANDLER = StreamHandler()
 HANDLER.setLevel(INFO)
 
+
 if len(HELIUM_LOGGER.handlers) == 0:
     HELIUM_LOGGER.setLevel(INFO)
     HELIUM_LOGGER.addHandler(HANDLER)
@@ -716,30 +716,6 @@ def get_block(view: sublime.View, s: sublime.Region) -> (str, sublime.Region):
     return (view.substr(block_region), block_region)
 
 
-def get_cell(
-    view: sublime.View, region: sublime.Region, *, logger=HELIUM_LOGGER
-) -> (str, sublime.Region):
-    """Get the code cell under the cursor.
-
-    Cells are separated by markers.
-    Those are defined in `cell_delimiter_pattern` in the config file.
-
-    If `s` is a selected region, the code cell is it.
-    """
-    if not region.empty():
-        return (view.substr(region), region)
-    cell_delimiter_pattern = sublime.load_settings("Helium.sublime-settings").get(
-        "cell_delimiter_pattern"
-    )
-    separators = view.find_all(cell_delimiter_pattern)
-    separators.append(sublime.Region(view.size() + 1, view.size() + 1))
-    r = sublime.Region(region.begin() + 1, region.begin() + 1)
-    start_point = separators[bisect.bisect(separators, r) - 1].end() + 1
-    end_point = separators[bisect.bisect(separators, r)].begin() - 1
-    cell_region = sublime.Region(start_point, end_point)
-    return (view.substr(cell_region), cell_region)
-
-
 @chain_callbacks
 def _execute_block(view, *, logger=HELIUM_LOGGER):
     try:

lib/kernel.py

@@ -7,14 +7,12 @@
 import re
 from collections import defaultdict
 from datetime import datetime
-from threading import Event, Thread, RLock
 from queue import Empty, Queue
+from threading import Event, RLock, Thread
 
 import sublime
 
-from .utils import show_password_input
-from .utils import get_png_dimensions
-
+from .utils import get_cell, get_png_dimensions, show_password_input
 
 JUPYTER_PROTOCOL_VERSION = "5.0"
 
@@ -149,6 +147,7 @@ class IOPubMessageReceiver(MessageReceiver):
         def run(self):
             """Run main routine."""
             # TODO: log, handle other message types.
+
             while not self.exit.is_set():
                 try:
                     msg = self._kernel.client.get_iopub_msg(timeout=1)
@@ -163,6 +162,9 @@ def run(self):
                     if msg_type == MSG_TYPE_STATUS:
                         self._kernel._execution_state = content["execution_state"]
                     elif msg_type == MSG_TYPE_EXECUTE_INPUT:
+                        # if code is executed deleted all phantoms in this region
+                        self._kernel._clear_phantoms_in_region(region, view)
+
                         self._kernel._write_text_to_view("\n\n")
                         if sublime.load_settings("Helium.sublime-settings").get(
                             "output_code"
@@ -191,6 +193,7 @@ def run(self):
                         self._kernel._handle_stream(
                             content["name"], content["text"], region, view,
                         )
+
                 except Empty:
                     pass
                 except Exception as ex:
@@ -260,6 +263,7 @@ def __init__(
         self._connection_name = connection_name
         self._execution_state = "unknown"
         self._init_receivers()
+        self.phantoms = {}
 
     def __del__(self):  # noqa
         self._shell_msg_receiver.shutdown()
@@ -387,7 +391,7 @@ def _handle_stream(
             pass
 
     def _write_out_execution_count(self, execution_count) -> None:
-        self._write_text_to_view("\nOut[{}]: ".format(execution_count))
+        self._write_text_to_view("\nOut[{}]: \n".format(execution_count))
 
     def _write_text_to_view(self, text: str) -> None:
         if self._show_inline_output:
@@ -416,14 +420,18 @@ def _write_inline_html_phantom(
     ):
         if self._show_inline_output:
             id = HELIUM_FIGURE_PHANTOMS + datetime.now().isoformat()
+
             html = TEXT_PHANTOM.format(content=content)
-            view.add_phantom(
+            int_id = view.add_phantom(
                 id,
                 region,
                 html,
                 sublime.LAYOUT_BLOCK,
-                on_navigate=lambda href, id=id: view.erase_phantoms(id),
+                on_navigate=lambda href, id=id, view=view: self._erase_phantom(
+                    id, view=view
+                ),
             )
+            self.phantoms[id] = int_id
             self._logger.info("Created inline phantom {}".format(html))
 
     def _write_inline_image_phantom(
@@ -450,20 +458,40 @@ def _write_inline_image_phantom(
 
                 html = IMAGE_PHANTOM.format(data=data, width=width, height=height)
 
-            view.add_phantom(
+            int_id = view.add_phantom(
                 id,
                 region,
                 html,
                 sublime.LAYOUT_BLOCK,
-                on_navigate=lambda href, id=id: view.erase_phantoms(id),
+                on_navigate=lambda href, id=id, view=view: self._erase_phantom(
+                    id, view=view
+                ),
             )
+            self.phantoms[id] = int_id
             self._logger.info("Created inline phantom image")
 
+    def _clear_phantoms_in_region(self, region: sublime.Region, view: sublime.View):
+        _, cell = get_cell(view, region, logger="")
+        remove = [
+            pid
+            for pid, int_id in self.phantoms.items()
+            if cell.contains(view.query_phantom(int_id)[0])
+        ]
+
+        for pid in remove:
+            self._erase_phantom(pid, view=view)
+
+    def _erase_phantom(self, pid: str, *, view: sublime.View):
+        if pid in self.phantoms:
+            _ = self.phantoms.pop(pid)
+            view.erase_phantoms(pid)
+
     def _write_mime_data_to_view(
         self, mime_data: dict, region: sublime.Region, view: sublime.View
     ) -> None:
         # Now we use basically text/plain for text type.
         # Jupyter kernels often emits html whom minihtml cannot render.
+
         if "text/plain" in mime_data:
             content = mime_data["text/plain"]
             lines = "\n(display data): {content}".format(content=content)

lib/utils.py

@@ -1,8 +1,8 @@
+import bisect
 import re
 import sys
-from functools import wraps
-
 from base64 import b64decode
+from functools import wraps
 
 import sublime
 from sublime_plugin import TextCommand
@@ -108,3 +108,27 @@ def get_png_dimensions(base64):
     iwidth = int.from_bytes(wh[1:5], byteorder="big")
     iheight = int.from_bytes(wh[5:], byteorder="big")
     return (iwidth, iheight)
+
+
+def get_cell(
+    view: sublime.View, region: sublime.Region, *, logger: str
+) -> (str, sublime.Region):
+    """Get the code cell under the cursor.
+
+    Cells are separated by markers.
+    Those are defined in `cell_delimiter_pattern` in the config file.
+
+    If `s` is a selected region, the code cell is it.
+    """
+    if not region.empty():
+        return (view.substr(region), region)
+    cell_delimiter_pattern = sublime.load_settings("Helium.sublime-settings").get(
+        "cell_delimiter_pattern"
+    )
+    separators = view.find_all(cell_delimiter_pattern)
+    separators.append(sublime.Region(view.size() + 2, view.size() + 2))
+    r = sublime.Region(region.begin() + 1, region.begin() + 1)
+    start_point = separators[bisect.bisect(separators, r) - 1].end() + 1
+    end_point = separators[bisect.bisect(separators, r)].begin() - 1
+    cell_region = sublime.Region(start_point, end_point)
+    return (view.substr(cell_region), cell_region)