jupyter-ydoc 3.0.0a8__tar.gz → 3.0.0a10__tar.gz

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
       - id: check-case-conflict
@@ -17,7 +17,7 @@ repos:
         exclude: ^\.yarn
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.7
+    rev: v0.6.9
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 3.0.0a10
+
+([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.0-a9...dc71f641f72826232772509a8c9cea474d7ccc9f))
+
+### Maintenance and upkeep improvements
+
+- Revert #266 [#280](https://github.com/jupyter-server/jupyter_ydoc/pull/280) ([@davidbrochart](https://github.com/davidbrochart))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2024-10-10&to=2024-10-17&type=c))
+
+[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2024-10-10..2024-10-17&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 3.0.0a9
+
+([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.0-a8...877e5b9bb449b6f4e2472337e41f27c3bf24ead1))
+
+### Enhancements made
+
+- Doc awareness [#277](https://github.com/jupyter-server/jupyter_ydoc/pull/277) ([@brichet](https://github.com/brichet))
+
+### Maintenance and upkeep improvements
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2024-09-26&to=2024-10-10&type=c))
+
+[@brichet](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Abrichet+updated%3A2024-09-26..2024-10-10&type=Issues) | [@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2024-09-26..2024-10-10&type=Issues) | [@lumberbot-app](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Alumberbot-app+updated%3A2024-09-26..2024-10-10&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2024-09-26..2024-10-10&type=Issues)
+
 ## 3.0.0a8
 
 ([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.0-a7...b20878676d4564641ac142804eaf27331ddb342c))
@@ -20,8 +52,6 @@
 
 [@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adavidbrochart+updated%3A2024-09-18..2024-09-26&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2024-09-18..2024-09-26&type=Issues)
 
-<!-- <END NEW CHANGELOG ENTRY> -->
-
 ## 3.0.0a7
 
 ([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.0-a6...3f323117ba2e8cf36f0e06c0ec9b9fa2c192278b))

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: jupyter-ydoc
-Version: 3.0.0a8
+Version: 3.0.0a10
 Summary: Document structures for collaborative editing using Ypy
 Project-URL: Homepage, https://jupyter.org
 Project-URL: Source, https://github.com/jupyter-server/jupyter_ydoc
@@ -10,7 +10,7 @@ License-File: LICENSE
 Keywords: jupyter,pycrdt,yjs
 Requires-Python: >=3.8
 Requires-Dist: importlib-metadata>=3.6; python_version < '3.10'
-Requires-Dist: pycrdt<0.10.0,>=0.9.0
+Requires-Dist: pycrdt<0.11.0,>=0.10.1
 Provides-Extra: dev
 Requires-Dist: click; extra == 'dev'
 Requires-Dist: jupyter-releaser; extra == 'dev'
@@ -21,7 +21,7 @@ Requires-Dist: pydata-sphinx-theme; extra == 'docs'
 Requires-Dist: sphinx; extra == 'docs'
 Provides-Extra: test
 Requires-Dist: pre-commit; extra == 'test'
-Requires-Dist: pycrdt-websocket<0.15.0,>=0.14.1; extra == 'test'
+Requires-Dist: pycrdt-websocket<0.16.0,>=0.15.0; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-asyncio; extra == 'test'
 Requires-Dist: websockets>=10.0; extra == 'test'

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/javascript/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyter/ydoc",
-    "version": "3.0.0-a8",
+    "version": "3.0.0-a10",
     "type": "module",
     "description": "Jupyter document structures for collaborative editing using YJS",
     "homepage": "https://github.com/jupyter-server/jupyter_ydoc",

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/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.0.0a8'
+__version__ = VERSION = '3.0.0a10'

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/jupyter_ydoc/ybasedoc.py

@@ -4,7 +4,7 @@
 from abc import ABC, abstractmethod
 from typing import Any, Callable, Dict, Optional
 
-from pycrdt import Doc, Map, Subscription, UndoManager
+from pycrdt import Awareness, Doc, Map, Subscription, UndoManager
 
 
 class YBaseDoc(ABC):
@@ -20,17 +20,22 @@ class YBaseDoc(ABC):
     _subscriptions: Dict[Any, Subscription]
     _undo_manager: UndoManager
 
-    def __init__(self, ydoc: Optional[Doc] = None):
+    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
         """
         Constructs a YBaseDoc.
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that shares non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
         if ydoc is None:
             self._ydoc = Doc()
         else:
             self._ydoc = ydoc
+        self.awareness = awareness
+
         self._ystate = self._ydoc.get("state", type=Map)
         self._subscriptions = {}
         self._undo_manager = UndoManager(doc=self._ydoc, capture_timeout_millis=0)

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/jupyter_ydoc/yblob.py

@@ -4,7 +4,7 @@
 from functools import partial
 from typing import Any, Callable, Optional
 
-from pycrdt import Doc, Map
+from pycrdt import Awareness, Doc, Map
 
 from .ybasedoc import YBaseDoc
 
@@ -24,14 +24,17 @@ class YBlob(YBaseDoc):
         }
     """
 
-    def __init__(self, ydoc: Optional[Doc] = None):
+    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
         """
         Constructs a YBlob.
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that shares non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
-        super().__init__(ydoc)
+        super().__init__(ydoc, awareness)
         self._ysource = self._ydoc.get("source", type=Map)
         self.undo_manager.expand_scope(self._ysource)
 

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/jupyter_ydoc/ynotebook.py

@@ -6,7 +6,7 @@ from functools import partial
 from typing import Any, Callable, Dict, Optional
 from uuid import uuid4
 
-from pycrdt import Array, Doc, Map, Text
+from pycrdt import Array, Awareness, Doc, Map, Text
 
 from .utils import cast_all
 from .ybasedoc import YBaseDoc
@@ -47,14 +47,17 @@ class YNotebook(YBaseDoc):
         }
     """
 
-    def __init__(self, ydoc: Optional[Doc] = None):
+    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
         """
         Constructs a YNotebook.
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that shares non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
-        super().__init__(ydoc)
+        super().__init__(ydoc, awareness)
         self._ymeta = self._ydoc.get("meta", type=Map)
         self._ycells = self._ydoc.get("cells", type=Array)
         self.undo_manager.expand_scope(self._ycells)
@@ -222,7 +225,17 @@ 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"]
+        cells = value["cells"] or [
+            {
+                "cell_type": "code",
+                "execution_count": None,
+                # auto-created empty code cell without outputs ought be trusted
+                "metadata": {"trusted": True},
+                "outputs": [],
+                "source": "",
+                "id": str(uuid4()),
+            }
+        ]
 
         with self._ydoc.transaction():
             # clear document

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/jupyter_ydoc/yunicode.py

@@ -4,7 +4,7 @@
 from functools import partial
 from typing import Any, Callable, Optional
 
-from pycrdt import Doc, Text
+from pycrdt import Awareness, Doc, Text
 
 from .ybasedoc import YBaseDoc
 
@@ -23,14 +23,17 @@ class YUnicode(YBaseDoc):
         }
     """
 
-    def __init__(self, ydoc: Optional[Doc] = None):
+    def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] = None):
         """
         Constructs a YUnicode.
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that shares non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
-        super().__init__(ydoc)
+        super().__init__(ydoc, awareness)
         self._ysource = self._ydoc.get("source", type=Text)
         self.undo_manager.expand_scope(self._ysource)
 

{jupyter_ydoc-3.0.0a8 → jupyter_ydoc-3.0.0a10}/pyproject.toml

@@ -13,7 +13,7 @@ requires-python = ">=3.8"
 keywords = ["jupyter", "pycrdt", "yjs"]
 dependencies = [
     "importlib_metadata >=3.6; python_version<'3.10'",
-    "pycrdt >=0.9.0,<0.10.0",
+    "pycrdt >=0.10.1,<0.11.0",
 ]
 
 [[project.authors]]
@@ -31,7 +31,7 @@ test = [
     "pytest",
     "pytest-asyncio",
     "websockets >=10.0",
-    "pycrdt-websocket >=0.14.1,<0.15.0",
+    "pycrdt-websocket >=0.15.0,<0.16.0",
 ]
 docs = [
     "sphinx",