jupyter-ydoc 3.1.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

jupyter_ydoc/_version.py

@@ -1,4 +1,4 @@
 # This file is auto-generated by Hatchling. As such, do not:
 #   - modify
 #   - track in version control e.g. be sure to add to .gitignore
-__version__ = VERSION = '3.1.0'
+__version__ = VERSION = '3.2.0'

jupyter_ydoc/ynotebook.py

@@ -3,7 +3,7 @@
 
 import copy
 from functools import partial
-from typing import Any, Callable, Dict, Optional
+from typing import Any, Callable, Dict, List, Optional
 from uuid import uuid4
 
 from pycrdt import Array, Awareness, Doc, Map, Text
@@ -102,8 +102,11 @@ class YNotebook(YBaseDoc):
         :return: A cell.
         :rtype: Dict[str, Any]
         """
+        return self._cell_to_py(self._ycells[index])
+
+    def _cell_to_py(self, ycell: Map) -> Dict[str, Any]:
         meta = self._ymeta.to_py()
-        cell = self._ycells[index].to_py()
+        cell = ycell.to_py()
         cell.pop("execution_state", None)
         cast_all(cell, float, int)  # cells coming from Yjs have e.g. execution_count as float
         if "id" in cell and meta["nbformat"] == 4 and meta["nbformat_minor"] <= 4:
@@ -234,7 +237,7 @@ class YNotebook(YBaseDoc):
         nb_without_cells = {key: value[key] for key in value.keys() if key != "cells"}
         nb = copy.deepcopy(nb_without_cells)
         cast_all(nb, int, float)  # Yjs expects numbers to be floating numbers
-        cells = value["cells"] or [
+        new_cells = value["cells"] or [
             {
                 "cell_type": "code",
                 "execution_count": None,
@@ -245,24 +248,69 @@ class YNotebook(YBaseDoc):
                 "id": str(uuid4()),
             }
         ]
+        old_ycells_by_id = {ycell["id"]: ycell for ycell in self._ycells}
 
         with self._ydoc.transaction():
-            # clear document
-            self._ymeta.clear()
-            self._ycells.clear()
-            for key in [k for k in self._ystate.keys() if k not in ("dirty", "path")]:
+            new_cell_list: List[dict] = []
+            retained_cells = set()
+
+            # Determine cells to be retained
+            for new_cell in new_cells:
+                cell_id = new_cell.get("id")
+                if cell_id and (old_ycell := old_ycells_by_id.get(cell_id)):
+                    old_cell = self._cell_to_py(old_ycell)
+                    if old_cell == new_cell:
+                        new_cell_list.append(old_cell)
+                        retained_cells.add(cell_id)
+                        continue
+                # New or changed cell
+                new_cell_list.append(new_cell)
+
+            # First delete all non-retained cells
+            if not retained_cells:
+                # fast path if no cells were retained
+                self._ycells.clear()
+            else:
+                index = 0
+                for old_ycell in list(self._ycells):
+                    if old_ycell["id"] not in retained_cells:
+                        self._ycells.pop(index)
+                    else:
+                        index += 1
+
+            # Now add new cells
+            index = 0
+            for new_cell in new_cell_list:
+                if len(self._ycells) > index:
+                    if self._ycells[index]["id"] == new_cell.get("id"):
+                        # retained cell
+                        index += 1
+                        continue
+                self._ycells.insert(index, self.create_ycell(new_cell))
+                index += 1
+
+            for key in [
+                k for k in self._ystate.keys() if k not in ("dirty", "path", "document_id")
+            ]:
                 del self._ystate[key]
 
-            # initialize document
-            self._ycells.extend([self.create_ycell(cell) for cell in cells])
-            self._ymeta["nbformat"] = nb.get("nbformat", NBFORMAT_MAJOR_VERSION)
-            self._ymeta["nbformat_minor"] = nb.get("nbformat_minor", NBFORMAT_MINOR_VERSION)
+            nbformat_major = nb.get("nbformat", NBFORMAT_MAJOR_VERSION)
+            nbformat_minor = nb.get("nbformat_minor", NBFORMAT_MINOR_VERSION)
+
+            if self._ymeta.get("nbformat") != nbformat_major:
+                self._ymeta["nbformat"] = nbformat_major
+
+            if self._ymeta.get("nbformat_minor") != nbformat_minor:
+                self._ymeta["nbformat_minor"] = nbformat_minor
 
+            old_y_metadata = self._ymeta.get("metadata")
+            old_metadata = old_y_metadata.to_py() if old_y_metadata else {}
             metadata = nb.get("metadata", {})
-            metadata.setdefault("language_info", {"name": ""})
-            metadata.setdefault("kernelspec", {"name": "", "display_name": ""})
 
-            self._ymeta["metadata"] = Map(metadata)
+            if metadata != old_metadata:
+                metadata.setdefault("language_info", {"name": ""})
+                metadata.setdefault("kernelspec", {"name": "", "display_name": ""})
+                self._ymeta["metadata"] = Map(metadata)
 
     def observe(self, callback: Callable[[str, Any], None]) -> None:
         """

jupyter_ydoc/yunicode.py

@@ -63,6 +63,10 @@ class YUnicode(YBaseDoc):
         :param value: The content of the document.
         :type value: str
         """
+        if self.get() == value:
+            # no-op if the values are already the same,
+            # to avoid side-effects such as cursor jumping to the top
+            return
         with self._ydoc.transaction():
             # clear document
             self._ysource.clear()

{jupyter_ydoc-3.1.0.dist-info → jupyter_ydoc-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-ydoc
-Version: 3.1.0
+Version: 3.2.0
 Summary: Document structures for collaborative editing using Ypy
 Project-URL: Homepage, https://jupyter.org
 Project-URL: Source, https://github.com/jupyter-server/jupyter_ydoc
@@ -23,7 +23,7 @@ Provides-Extra: test
 Requires-Dist: httpx-ws>=0.5.2; extra == 'test'
 Requires-Dist: hypercorn>=0.16.0; extra == 'test'
 Requires-Dist: pre-commit; extra == 'test'
-Requires-Dist: pycrdt-websocket<0.16.0,>=0.15.0; extra == 'test'
+Requires-Dist: pycrdt-websocket<0.17.0,>=0.16.0; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-asyncio; extra == 'test'
 Description-Content-Type: text/markdown

{jupyter_ydoc-3.1.0.dist-info → jupyter_ydoc-3.2.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 jupyter_ydoc/__init__.py,sha256=cVoElIvmvfj0IECe1gKe3f5vyyO7Dq7dMB_A0s2zjs4,649
-jupyter_ydoc/_version.py,sha256=GXnjthE_UvQKNieIwdSShRd-jmkzn3bxIk73dyfZ6DY,171
+jupyter_ydoc/_version.py,sha256=vHwe_4Tu6OwXVP4fkl96hW7mdlnRCdb7oHGS6bAJ4Uk,171
 jupyter_ydoc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 jupyter_ydoc/utils.py,sha256=jnjF2uNmioh0z_4ymmMSYiB_2dAKSLmNFzVvR5V5Td0,883
 jupyter_ydoc/ybasedoc.py,sha256=RUkrlfu7xp6UfnxhKLB9tHCQyQDTAH10jmQ_AEY5Suo,5119
 jupyter_ydoc/yblob.py,sha256=44ZUakq9anNLAcaEuM9RpVN-J6Owf5kFpJJ80mTni8c,2253
 jupyter_ydoc/yfile.py,sha256=XTMtAXDWgIOLU2KUQxkLJz2cGvSPlOxpvJc4daXCV6I,198
-jupyter_ydoc/ynotebook.py,sha256=wbZiMgFMOg5xhBzLOfsFSeUiTlnXgV6yG-fsk161ZoE,8965
-jupyter_ydoc/yunicode.py,sha256=Um1BIGwne10ZQODeRA1qIi_vss-u3MKsjZNjbKodfQM,2385
-jupyter_ydoc-3.1.0.dist-info/METADATA,sha256=Wxoxi1bFx62bhtH18WaQzxjOQMa5lpv-nKw2Se4MWrw,3063
-jupyter_ydoc-3.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-jupyter_ydoc-3.1.0.dist-info/entry_points.txt,sha256=lgvRG-rpsjRKf8cy7LpO7fqwwXy0sBVMCwhGOHgn4mc,164
-jupyter_ydoc-3.1.0.dist-info/licenses/LICENSE,sha256=dqphsFbhnlzPK7Vlkc66Zc7g7PS-e1dln07GXIVpFCQ,1567
-jupyter_ydoc-3.1.0.dist-info/RECORD,,
+jupyter_ydoc/ynotebook.py,sha256=E_dN0oxd2Ic29JJKqXxHvm7Z8RVEHDVG_iiDB2aZz0U,10883
+jupyter_ydoc/yunicode.py,sha256=s-ZuzSCMVViIWmBxC-gCw9oy3CmE2jT4WG40KW9X3xM,2562
+jupyter_ydoc-3.2.0.dist-info/METADATA,sha256=lgoQrco4Gw9pTka96qcl2zCdcmIFoX8akVEJoJk1odQ,3063
+jupyter_ydoc-3.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+jupyter_ydoc-3.2.0.dist-info/entry_points.txt,sha256=lgvRG-rpsjRKf8cy7LpO7fqwwXy0sBVMCwhGOHgn4mc,164
+jupyter_ydoc-3.2.0.dist-info/licenses/LICENSE,sha256=dqphsFbhnlzPK7Vlkc66Zc7g7PS-e1dln07GXIVpFCQ,1567
+jupyter_ydoc-3.2.0.dist-info/RECORD,,