jupyter-ydoc 3.0.5__tar.gz → 3.2.0__tar.gz

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/.github/workflows/check-release.yml

@@ -19,7 +19,7 @@ jobs:
         node-version: ["14.x"]
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Base Setup
         uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install Dependencies
@@ -37,7 +37,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
       - name: Upload Distributions
         if: ${{ matrix.group == 'check_release' }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: jupyter-releaser-dist-${{ github.run_number }}
           path: .jupyter_releaser_checkout/dist

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/.github/workflows/license-header.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/.github/workflows/publish-release.yml

@@ -21,7 +21,7 @@ jobs:
     steps:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
-      - uses: actions/create-github-app-token@v1
+      - uses: actions/create-github-app-token@v2
         id: app-token
         with:
           app-id: ${{ vars.APP_ID }}

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/.github/workflows/test.yml

@@ -11,8 +11,8 @@ jobs:
     name: pre-commit
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
       - uses: pre-commit/action@v3.0.1
         with:
           extra_args: --all-files --hook-stage=manual
@@ -40,7 +40,7 @@ jobs:
         shell: bash -l {0}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Install mamba
         uses: mamba-org/setup-micromamba@v2
         with:

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.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.11.8
+    rev: v0.14.4
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/CHANGELOG.md

@@ -2,6 +2,47 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 3.2.0
+
+([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.1.0...85206ea5cadcb7fc0419edc98fb47b765f3050b5))
+
+### Bugs fixed
+
+- Improve reloading of documents to avoid spurious side-effects [#355](https://github.com/jupyter-server/jupyter_ydoc/pull/355) ([@krassowski](https://github.com/krassowski))
+- Preserve `document_id` state when setting notebook source [#338](https://github.com/jupyter-server/jupyter_ydoc/pull/338) ([@apeng-stripe](https://github.com/apeng-stripe))
+
+### Maintenance and upkeep improvements
+
+- Bump actions/upload-artifact from 4 to 5 [#349](https://github.com/jupyter-server/jupyter_ydoc/pull/349) ([@dependabot](https://github.com/dependabot))
+- Bump actions/setup-python from 5 to 6 [#340](https://github.com/jupyter-server/jupyter_ydoc/pull/340) ([@dependabot](https://github.com/dependabot))
+- Test against `pycrdt-websocket` `v0.16.0` & update dev dependencies [#339](https://github.com/jupyter-server/jupyter_ydoc/pull/339) ([@krassowski](https://github.com/krassowski))
+- Bump actions/checkout from 4 to 5 [#337](https://github.com/jupyter-server/jupyter_ydoc/pull/337) ([@dependabot](https://github.com/dependabot))
+- Bump actions/create-github-app-token from 1 to 2 [#318](https://github.com/jupyter-server/jupyter_ydoc/pull/318) ([@dependabot](https://github.com/dependabot))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2025-07-01&to=2025-11-17&type=c))
+
+[@apeng-stripe](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Aapeng-stripe+updated%3A2025-07-01..2025-11-17&type=Issues) | [@dependabot](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adependabot+updated%3A2025-07-01..2025-11-17&type=Issues) | [@krassowski](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Akrassowski+updated%3A2025-07-01..2025-11-17&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2025-07-01..2025-11-17&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 3.1.0
+
+([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.5...280e6e33c0d283456e5519607186db08bccfaa5b))
+
+### Enhancements made
+
+- Add `clearOutputs()` method to `ISharedCodeCell` [#330](https://github.com/jupyter-server/jupyter_ydoc/pull/330) ([@Darshan808](https://github.com/Darshan808))
+
+### Maintenance and upkeep improvements
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter-server/jupyter_ydoc/graphs/contributors?from=2025-05-07&to=2025-07-01&type=c))
+
+[@Darshan808](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3ADarshan808+updated%3A2025-05-07..2025-07-01&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2025-05-07..2025-07-01&type=Issues)
+
 ## 3.0.5
 
 ([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.4...9a28796415aeb19ffaf0ca7f5fab2bf39ee04755))
@@ -16,8 +57,6 @@
 
 [@dlqqq](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adlqqq+updated%3A2025-04-18..2025-05-07&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2025-04-18..2025-05-07&type=Issues)
 
-<!-- <END NEW CHANGELOG ENTRY> -->
-
 ## 3.0.4
 
 ([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.0.3...accc3139a8bf5b5c7492a37af50309ffb810f7fd))

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-ydoc
-Version: 3.0.5
+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.0.5 → jupyter_ydoc-3.2.0}/javascript/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyter/ydoc",
-    "version": "3.0.5",
+    "version": "3.2.0",
     "type": "module",
     "description": "Jupyter document structures for collaborative editing using YJS",
     "homepage": "https://github.com/jupyter-server/jupyter_ydoc",
@@ -49,19 +49,19 @@
         "yjs": "^13.5.40"
     },
     "devDependencies": {
-        "@types/jest": "^29.0.0",
-        "@typescript-eslint/eslint-plugin": "^5.36.0",
-        "@typescript-eslint/parser": "^5.36.0",
-        "eslint": "^8.17.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-jest": "^27.0.0",
-        "eslint-plugin-prettier": "^4.0.0",
-        "jest": "^29.0.0",
-        "prettier": "^2.8.4",
-        "rimraf": "^4.4.0",
+        "@types/jest": "^29.2.0",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
+        "eslint": "^8.36.0",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-jest": "^27.6.0",
+        "eslint-plugin-prettier": "^5.0.0",
+        "jest": "^29.2.0",
+        "prettier": "^3.0.0",
+        "rimraf": "^5.0.1",
         "tsc-esm-fix": "^2.20.0",
         "typedoc": "^0.23.21",
-        "typescript": "^4.9.5"
+        "typescript": "~5.8.0"
     },
     "publishConfig": {
         "access": "public"

{jupyter_ydoc-3.0.5 → jupyter_ydoc-3.2.0}/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.5'
+__version__ = VERSION = '3.2.0'

{jupyter_ydoc-3.0.5 → jupyter_ydoc-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-3.0.5 → jupyter_ydoc-3.2.0}/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.0.5 → jupyter_ydoc-3.2.0}/pyproject.toml

@@ -32,7 +32,7 @@ test = [
     "pytest-asyncio",
     "httpx-ws >=0.5.2",
     "hypercorn >=0.16.0",
-    "pycrdt-websocket >=0.15.0,<0.16.0",
+    "pycrdt-websocket >=0.16.0,<0.17.0",
 ]
 docs = [
     "sphinx",