jupyter-ydoc 3.2.1__py3-none-any.whl → 3.3.0__py3-none-any.whl

jupyter_ydoc/__init__.py

@@ -1,7 +1,7 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import sys
+from importlib.metadata import entry_points
 
 from ._version import __version__ as __version__
 from .yblob import YBlob as YBlob
@@ -9,11 +9,4 @@ from .yfile import YFile as YFile
 from .ynotebook import YNotebook as YNotebook
 from .yunicode import YUnicode as YUnicode
 
-# See compatibility note on `group` keyword in
-# https://docs.python.org/3/library/importlib.metadata.html#entry-points
-if sys.version_info < (3, 10):
-    from importlib_metadata import entry_points
-else:
-    from importlib.metadata import entry_points
-
 ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}

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.2.1'
+__version__ = VERSION = '3.3.0'

jupyter_ydoc/utils.py

@@ -1,15 +1,12 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from typing import Dict, List, Type, Union
 
-INT = Type[int]
-FLOAT = Type[float]
+INT = type[int]
+FLOAT = type[float]
 
 
-def cast_all(
-    o: Union[List, Dict], from_type: Union[INT, FLOAT], to_type: Union[FLOAT, INT]
-) -> Union[List, Dict]:
+def cast_all(o: list | dict, from_type: INT | FLOAT, to_type: FLOAT | INT) -> list | dict:
     if isinstance(o, list):
         for i, v in enumerate(o):
             if type(v) is from_type:

jupyter_ydoc/ybasedoc.py

@@ -2,7 +2,8 @@
 # Distributed under the terms of the Modified BSD License.
 
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, Optional
+from collections.abc import Callable
+from typing import Any
 
 from pycrdt import Awareness, Doc, Map, Subscription, UndoManager
 
@@ -17,10 +18,10 @@ class YBaseDoc(ABC):
 
     _ydoc: Doc
     _ystate: Map
-    _subscriptions: Dict[Any, Subscription]
+    _subscriptions: dict[Any, Subscription]
     _undo_manager: UndoManager
 
-    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
+    def __init__(self, ydoc: Doc | None = None, awareness: Awareness | None = None):
         """
         Constructs a YBaseDoc.
 
@@ -100,7 +101,7 @@ class YBaseDoc(ABC):
         return self.set(value)
 
     @property
-    def dirty(self) -> Optional[bool]:
+    def dirty(self) -> bool | None:
         """
         Returns whether the document is dirty.
 
@@ -120,7 +121,7 @@ class YBaseDoc(ABC):
         self._ystate["dirty"] = value
 
     @property
-    def hash(self) -> Optional[str]:
+    def hash(self) -> str | None:
         """
         Returns the document hash as computed by contents manager.
 
@@ -140,7 +141,7 @@ class YBaseDoc(ABC):
         self._ystate["hash"] = value
 
     @property
-    def path(self) -> Optional[str]:
+    def path(self) -> str | None:
         """
         Returns document's path.
 

jupyter_ydoc/yblob.py

@@ -1,8 +1,9 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+from collections.abc import Callable
 from functools import partial
-from typing import Any, Callable, Optional
+from typing import Any
 
 from pycrdt import Awareness, Doc, Map
 
@@ -24,7 +25,7 @@ class YBlob(YBaseDoc):
         }
     """
 
-    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
+    def __init__(self, ydoc: Doc | None = None, awareness: Awareness | None = None):
         """
         Constructs a YBlob.
 
@@ -64,6 +65,9 @@ class YBlob(YBaseDoc):
         :param value: The content of the document.
         :type value: bytes
         """
+        if self.get() == value:
+            return
+
         self._ysource["bytes"] = value
 
     def observe(self, callback: Callable[[str, Any], None]) -> None:

jupyter_ydoc/ynotebook.py

@@ -2,8 +2,9 @@
 # Distributed under the terms of the Modified BSD License.
 
 import copy
+from collections.abc import Callable
 from functools import partial
-from typing import Any, Callable, Dict, List, Optional
+from typing import Any
 from uuid import uuid4
 
 from pycrdt import Array, Awareness, Doc, Map, Text
@@ -16,6 +17,8 @@ NBFORMAT_MAJOR_VERSION = 4
 # The default minor version of the notebook format.
 NBFORMAT_MINOR_VERSION = 5
 
+_CELL_KEY_TYPE_MAP = {"metadata": Map, "source": Text, "outputs": Array}
+
 
 class YNotebook(YBaseDoc):
     """
@@ -47,7 +50,7 @@ class YNotebook(YBaseDoc):
         }
     """
 
-    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
+    def __init__(self, ydoc: Doc | None = None, awareness: Awareness | None = None):
         """
         Constructs a YNotebook.
 
@@ -92,7 +95,7 @@ class YNotebook(YBaseDoc):
         """
         return len(self._ycells)
 
-    def get_cell(self, index: int) -> Dict[str, Any]:
+    def get_cell(self, index: int) -> dict[str, Any]:
         """
         Returns a cell.
 
@@ -104,7 +107,7 @@ class YNotebook(YBaseDoc):
         """
         return self._cell_to_py(self._ycells[index])
 
-    def _cell_to_py(self, ycell: Map) -> Dict[str, Any]:
+    def _cell_to_py(self, ycell: Map) -> dict[str, Any]:
         meta = self._ymeta.to_py()
         cell = ycell.to_py()
         cell.pop("execution_state", None)
@@ -120,7 +123,7 @@ class YNotebook(YBaseDoc):
             del cell["attachments"]
         return cell
 
-    def append_cell(self, value: Dict[str, Any]) -> None:
+    def append_cell(self, value: dict[str, Any]) -> None:
         """
         Appends a cell.
 
@@ -130,7 +133,7 @@ class YNotebook(YBaseDoc):
         ycell = self.create_ycell(value)
         self._ycells.append(ycell)
 
-    def set_cell(self, index: int, value: Dict[str, Any]) -> None:
+    def set_cell(self, index: int, value: dict[str, Any]) -> None:
         """
         Sets a cell into indicated position.
 
@@ -143,7 +146,7 @@ class YNotebook(YBaseDoc):
         ycell = self.create_ycell(value)
         self.set_ycell(index, ycell)
 
-    def create_ycell(self, value: Dict[str, Any]) -> Map:
+    def create_ycell(self, value: dict[str, Any]) -> Map:
         """
         Creates YMap with the content of the cell.
 
@@ -193,7 +196,7 @@ class YNotebook(YBaseDoc):
         """
         self._ycells[index] = ycell
 
-    def get(self) -> Dict:
+    def get(self) -> dict:
         """
         Returns the content of the document.
 
@@ -227,7 +230,7 @@ class YNotebook(YBaseDoc):
             nbformat_minor=int(meta.get("nbformat_minor", 0)),
         )
 
-    def set(self, value: Dict) -> None:
+    def set(self, value: dict) -> None:
         """
         Sets the content of the document.
 
@@ -248,10 +251,10 @@ class YNotebook(YBaseDoc):
                 "id": str(uuid4()),
             }
         ]
-        old_ycells_by_id = {ycell["id"]: ycell for ycell in self._ycells}
+        old_ycells_by_id: dict[str, Map] = {ycell["id"]: ycell for ycell in self._ycells}
 
         with self._ydoc.transaction():
-            new_cell_list: List[dict] = []
+            new_cell_list: list[dict] = []
             retained_cells = set()
 
             # Determine cells to be retained
@@ -259,7 +262,11 @@ class YNotebook(YBaseDoc):
                 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:
+                    updated_granularly = self._update_cell(
+                        old_cell=old_cell, new_cell=new_cell, old_ycell=old_ycell
+                    )
+
+                    if updated_granularly:
                         new_cell_list.append(old_cell)
                         retained_cells.add(cell_id)
                         continue
@@ -323,3 +330,57 @@ class YNotebook(YBaseDoc):
         self._subscriptions[self._ystate] = self._ystate.observe(partial(callback, "state"))
         self._subscriptions[self._ymeta] = self._ymeta.observe_deep(partial(callback, "meta"))
         self._subscriptions[self._ycells] = self._ycells.observe_deep(partial(callback, "cells"))
+
+    def _update_cell(self, old_cell: dict, new_cell: dict, old_ycell: Map) -> bool:
+        if old_cell == new_cell:
+            return True
+        # attempt to update cell granularly
+        old_keys = set(old_cell.keys())
+        new_keys = set(new_cell.keys())
+
+        shared_keys = old_keys & new_keys
+        removed_keys = old_keys - new_keys
+        added_keys = new_keys - old_keys
+
+        for key in shared_keys:
+            if old_cell[key] != new_cell[key]:
+                value = new_cell[key]
+                if key == "output" and value:
+                    # outputs require complex handling - some have Text type nested;
+                    # for now skip creating them; clearing all outputs is fine
+                    return False
+
+                if key in _CELL_KEY_TYPE_MAP:
+                    kind = _CELL_KEY_TYPE_MAP[key]
+
+                    if not isinstance(old_ycell[key], kind):
+                        # if our assumptions about types do not hold, fall back to hard update
+                        return False
+
+                    if kind == Text:
+                        old: Text = old_ycell[key]
+                        old.clear()
+                        old += value
+                    elif kind == Array:
+                        old: Array = old_ycell[key]
+                        old.clear()
+                        old.extend(value)
+                    elif kind == Map:
+                        old: Map = old_ycell[key]
+                        old.clear()
+                        old.update(value)
+                else:
+                    old_ycell[key] = new_cell[key]
+
+        for key in removed_keys:
+            del old_ycell[key]
+
+        for key in added_keys:
+            if key in _CELL_KEY_TYPE_MAP:
+                # we hard-reload cells when keys that require nested types get added
+                # to allow the frontend to connect observers; this could be changed
+                # in the future, once frontends learn how to observe all changes
+                return False
+            else:
+                old_ycell[key] = new_cell[key]
+        return True

jupyter_ydoc/yunicode.py

@@ -1,8 +1,9 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+from collections.abc import Callable
 from functools import partial
-from typing import Any, Callable, Optional
+from typing import Any
 
 from pycrdt import Awareness, Doc, Text
 
@@ -23,7 +24,7 @@ class YUnicode(YBaseDoc):
         }
     """
 
-    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
+    def __init__(self, ydoc: Doc | None = None, awareness: Awareness | None = None):
         """
         Constructs a YUnicode.
 
@@ -67,6 +68,7 @@ class YUnicode(YBaseDoc):
             # 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.2.1.dist-info → jupyter_ydoc-3.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-ydoc
-Version: 3.2.1
+Version: 3.3.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
@@ -8,24 +8,8 @@ Author-email: Jupyter Development Team <jupyter@googlegroups.com>
 License: BSD 3-Clause License
 License-File: LICENSE
 Keywords: jupyter,pycrdt,yjs
-Requires-Python: >=3.8
-Requires-Dist: importlib-metadata>=3.6; python_version < '3.10'
+Requires-Python: >=3.10
 Requires-Dist: pycrdt<0.13.0,>=0.10.1
-Provides-Extra: dev
-Requires-Dist: click; extra == 'dev'
-Requires-Dist: jupyter-releaser; extra == 'dev'
-Requires-Dist: pre-commit; extra == 'dev'
-Provides-Extra: docs
-Requires-Dist: myst-parser; extra == 'docs'
-Requires-Dist: pydata-sphinx-theme; extra == 'docs'
-Requires-Dist: sphinx; extra == 'docs'
-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.17.0,>=0.16.0; extra == 'test'
-Requires-Dist: pytest; extra == 'test'
-Requires-Dist: pytest-asyncio; extra == 'test'
 Description-Content-Type: text/markdown
 
 [![Build Status](https://github.com/jupyter-server/jupyter_ydoc/workflows/Tests/badge.svg)](https://github.com/jupyter-server/jupyter_ydoc/actions)
@@ -60,8 +44,6 @@ Which is just a shortcut to:
 
 ```py
 from importlib.metadata import entry_points
-# for Python < 3.10, install importlib_metadata and do:
-# from importlib_metadata import entry_points
 
 ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
 ```

jupyter_ydoc-3.3.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+jupyter_ydoc/__init__.py,sha256=itUidK7o0_wS6YcbKKIyt1su7hM3-YppQshFheTQQdw,428
+jupyter_ydoc/_version.py,sha256=Tz6lmxmxKUkvsL1d8BVDTboI2Qi1KGyuKbw2_SfyWeo,171
+jupyter_ydoc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jupyter_ydoc/utils.py,sha256=yKvcuqhpylMinmjuscuZ_kY8KPEseFbwcg5K9VzYOfs,810
+jupyter_ydoc/ybasedoc.py,sha256=c0jwhULtTNCjOYHbXhDhKaD6OJYn7hpL4hcLZWyGJsU,5115
+jupyter_ydoc/yblob.py,sha256=JZiXQhONqFS8Cqdglx__AVeS18gyRq0yHq-AQKFPVfw,2316
+jupyter_ydoc/yfile.py,sha256=XTMtAXDWgIOLU2KUQxkLJz2cGvSPlOxpvJc4daXCV6I,198
+jupyter_ydoc/ynotebook.py,sha256=_nyBC1kKGr1TQlfmFGAMWU1xb0z-vyxRQiLfTukpbAI,13257
+jupyter_ydoc/yunicode.py,sha256=ZLNLTJoy75gxCwI8ZNBv_gD42hrzHfD-J6GOO1WaJIE,2574
+jupyter_ydoc-3.3.0.dist-info/METADATA,sha256=mmVXxTiGc9_QTtRRtjlD2JJpg4Q_JHjaF4tT4JjjQgA,2282
+jupyter_ydoc-3.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+jupyter_ydoc-3.3.0.dist-info/entry_points.txt,sha256=lgvRG-rpsjRKf8cy7LpO7fqwwXy0sBVMCwhGOHgn4mc,164
+jupyter_ydoc-3.3.0.dist-info/licenses/LICENSE,sha256=dqphsFbhnlzPK7Vlkc66Zc7g7PS-e1dln07GXIVpFCQ,1567
+jupyter_ydoc-3.3.0.dist-info/RECORD,,

jupyter_ydoc-3.2.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-jupyter_ydoc/__init__.py,sha256=cVoElIvmvfj0IECe1gKe3f5vyyO7Dq7dMB_A0s2zjs4,649
-jupyter_ydoc/_version.py,sha256=TB9ypsD-hyVh_lg7CkxRsikKT0D_aW1eqdUCko0bNtw,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=y0YHCj9TEwCJOWpA2QepZwp_xQP9i9jq7E5C_y91rvc,10885
-jupyter_ydoc/yunicode.py,sha256=s-ZuzSCMVViIWmBxC-gCw9oy3CmE2jT4WG40KW9X3xM,2562
-jupyter_ydoc-3.2.1.dist-info/METADATA,sha256=KFpcOvU6mYytpm2Zdu-v1pOOlIDn9cF7wRNYSBkRclQ,3063
-jupyter_ydoc-3.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-jupyter_ydoc-3.2.1.dist-info/entry_points.txt,sha256=lgvRG-rpsjRKf8cy7LpO7fqwwXy0sBVMCwhGOHgn4mc,164
-jupyter_ydoc-3.2.1.dist-info/licenses/LICENSE,sha256=dqphsFbhnlzPK7Vlkc66Zc7g7PS-e1dln07GXIVpFCQ,1567
-jupyter_ydoc-3.2.1.dist-info/RECORD,,