jupyter-ydoc 3.3.1__tar.gz → 3.3.3__tar.gz

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/.github/workflows/check-release.yml

@@ -19,7 +19,7 @@ jobs:
         node-version: ["14.x"]
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Base Setup
         uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install Dependencies

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/.github/workflows/license-header.yml

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

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     name: pre-commit
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
       - uses: pre-commit/action@v3.0.1
         with:
@@ -41,7 +41,7 @@ jobs:
         shell: bash -l {0}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Install mamba
         uses: mamba-org/setup-micromamba@v2
         with:

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
         exclude: ^\.yarn
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.5
+    rev: v0.14.8
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 3.3.3
+
+([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.3.2...3900efdeefef21eb6e117fdd30827ee4c9149ff3))
+
+### Bugs fixed
+
+- Fix multi-byte Unicode handling in files [#370](https://github.com/jupyter-server/jupyter_ydoc/pull/370) ([@krassowski](https://github.com/krassowski))
+
+### 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-12-01&to=2025-12-10&type=c))
+
+[@krassowski](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Akrassowski+updated%3A2025-12-01..2025-12-10&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2025-12-01..2025-12-10&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 3.3.2
+
+([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.3.1...87e205209dbfed2d367424e6913c88916e77d98e))
+
+### Enhancements made
+
+- Perform granular updates if reloading textual files [#366](https://github.com/jupyter-server/jupyter_ydoc/pull/366) ([@krassowski](https://github.com/krassowski))
+
+### Maintenance and upkeep improvements
+
+- Bump actions/checkout from 5 to 6 [#363](https://github.com/jupyter-server/jupyter_ydoc/pull/363) ([@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-11-21&to=2025-12-01&type=c))
+
+[@dependabot](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Adependabot+updated%3A2025-11-21..2025-12-01&type=Issues) | [@krassowski](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Akrassowski+updated%3A2025-11-21..2025-12-01&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Apre-commit-ci+updated%3A2025-11-21..2025-12-01&type=Issues)
+
 ## 3.3.1
 
 ([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.3.0...0a0d0bc23b5894db0b00c5b073861025757c72db))
@@ -16,8 +52,6 @@
 
 [@krassowski](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyter_ydoc+involves%3Akrassowski+updated%3A2025-11-21..2025-11-21&type=Issues)
 
-<!-- <END NEW CHANGELOG ENTRY> -->
-
 ## 3.3.0
 
 ([Full Changelog](https://github.com/jupyter-server/jupyter_ydoc/compare/@jupyter/ydoc@3.2.1...91d2742a5faff878f7d802e994922e7c3bcf9d33))

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-ydoc
-Version: 3.3.1
+Version: 3.3.3
 Summary: Document structures for collaborative editing using Ypy
 Project-URL: Homepage, https://jupyter.org
 Project-URL: Source, https://github.com/jupyter-server/jupyter_ydoc

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/javascript/package.json

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

{jupyter_ydoc-3.3.1 → jupyter_ydoc-3.3.3}/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.3.1'
+__version__ = VERSION = '3.3.3'

jupyter_ydoc-3.3.3/jupyter_ydoc/yunicode.py

@@ -0,0 +1,181 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+from collections.abc import Callable
+from difflib import SequenceMatcher
+from functools import partial
+from typing import Any
+
+from pycrdt import Awareness, Doc, Text
+
+from .ybasedoc import YBaseDoc
+
+# Heuristic threshold as recommended in difflib documentation
+SIMILARITY_THREESHOLD = 0.6
+
+
+class YUnicode(YBaseDoc):
+    """
+    Extends :class:`YBaseDoc`, and represents a plain text document, encoded as UTF-8.
+
+    Schema:
+
+    .. code-block:: json
+
+        {
+            "state": YMap,
+            "source": YText
+        }
+    """
+
+    def __init__(self, ydoc: Doc | None = None, awareness: Awareness | None = 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, awareness)
+        self._ysource: Text = self._ydoc.get("source", type=Text)
+        self.undo_manager.expand_scope(self._ysource)
+
+    @property
+    def version(self) -> str:
+        """
+        Returns the version of the document.
+
+        :return: Document's version.
+        :rtype: str
+        """
+        return "1.0.0"
+
+    def get(self) -> str:
+        """
+        Returns the content of the document.
+
+        :return: Document's content.
+        :rtype: str
+        """
+        return str(self._ysource)
+
+    def set(self, value: str) -> None:
+        """
+        Sets the content of the document.
+
+        :param value: The content of the document.
+        :type value: str
+        """
+        old_value = self.get()
+        if old_value == value:
+            # no-op if the values are already the same,
+            # to avoid side-effects such as cursor jumping to the top
+            return
+
+        before_bytes = old_value.encode("utf-8")
+        after_bytes = value.encode("utf-8")
+
+        with self._ydoc.transaction():
+            matcher = SequenceMatcher(a=before_bytes, b=after_bytes)
+
+            if (
+                matcher.real_quick_ratio() >= SIMILARITY_THREESHOLD
+                and matcher.ratio() >= SIMILARITY_THREESHOLD
+            ):
+                operations = matcher.get_opcodes()
+
+                # Fix byte ranges and check for problematic overlaps
+                fixed_operations = []
+                prev_end = 0
+                prev_tag = None
+                has_overlap = False
+
+                for tag, i1, i2, j1, j2 in operations:
+                    # Fix byte ranges to proper UTF-8 character boundaries
+                    i1_fixed, i2_fixed = _fix_byte_range_to_char_boundary(before_bytes, i1, i2)
+                    j1_fixed, j2_fixed = _fix_byte_range_to_char_boundary(after_bytes, j1, j2)
+
+                    # Check if this operation overlaps with the previous one
+                    # which can happen with grapheme clusters (emoji + modifiers, etc.)
+                    if i1_fixed < prev_end and prev_tag != "equal":
+                        has_overlap = True
+                        break
+
+                    prev_end = i2_fixed
+                    prev_tag = tag
+                    fixed_operations.append((tag, i1_fixed, i2_fixed, j1_fixed, j2_fixed))
+
+                # If we detected overlapping operations, fall back to hard reload
+                if has_overlap:
+                    self._ysource.clear()
+                    if value:
+                        self._ysource += value
+                else:
+                    # Apply granular operations
+                    offset = 0
+                    for tag, i1, i2, j1, j2 in fixed_operations:
+                        match tag:
+                            case "replace":
+                                self._ysource[i1 + offset : i2 + offset] = after_bytes[
+                                    j1:j2
+                                ].decode("utf-8")
+                                offset += (j2 - j1) - (i2 - i1)
+                            case "delete":
+                                del self._ysource[i1 + offset : i2 + offset]
+                                offset -= i2 - i1
+                            case "insert":
+                                self._ysource.insert(
+                                    i1 + offset, after_bytes[j1:j2].decode("utf-8")
+                                )
+                                offset += j2 - j1
+                            case "equal":
+                                pass
+                            case _:
+                                raise ValueError(f"Unknown tag '{tag}' in sequence matcher")
+            else:
+                # for very different strings, just replace the whole content;
+                # this avoids generating a huge number of operations
+
+                # clear document
+                self._ysource.clear()
+                # initialize document
+                if value:
+                    self._ysource += value
+
+    def observe(self, callback: Callable[[str, Any], None]) -> None:
+        """
+        Subscribes to document changes.
+
+        :param callback: Callback that will be called when the document changes.
+        :type callback: Callable[[str, Any], None]
+        """
+        self.unobserve()
+        self._subscriptions[self._ystate] = self._ystate.observe(partial(callback, "state"))
+        self._subscriptions[self._ysource] = self._ysource.observe(partial(callback, "source"))
+
+
+def _is_utf8_continuation_byte(byte: int) -> bool:
+    """Check if a byte is a UTF-8 continuation byte (10xxxxxx)."""
+    return (byte & 0xC0) == 0x80
+
+
+def _fix_byte_range_to_char_boundary(data: bytes, start: int, end: int) -> tuple[int, int]:
+    """
+    Adjust byte indices to proper UTF-8 character boundaries.
+
+    :param data: The byte data.
+    :param start: The start byte index.
+    :param end: The end byte index.
+    :return: A tuple of (adjusted_start, adjusted_end).
+    """
+    # Move start backward to the beginning of a UTF-8 character
+    while start > 0 and start < len(data) and _is_utf8_continuation_byte(data[start]):
+        start -= 1
+
+    # Move end forward to the end of a UTF-8 character
+    while end < len(data) and _is_utf8_continuation_byte(data[end]):
+        end += 1
+
+    return start, end

jupyter_ydoc-3.3.1/jupyter_ydoc/yunicode.py

@@ -1,88 +0,0 @@
-# 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
-
-from pycrdt import Awareness, Doc, Text
-
-from .ybasedoc import YBaseDoc
-
-
-class YUnicode(YBaseDoc):
-    """
-    Extends :class:`YBaseDoc`, and represents a plain text document, encoded as UTF-8.
-
-    Schema:
-
-    .. code-block:: json
-
-        {
-            "state": YMap,
-            "source": YText
-        }
-    """
-
-    def __init__(self, ydoc: Doc | None = None, awareness: Awareness | None = 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, awareness)
-        self._ysource = self._ydoc.get("source", type=Text)
-        self.undo_manager.expand_scope(self._ysource)
-
-    @property
-    def version(self) -> str:
-        """
-        Returns the version of the document.
-
-        :return: Document's version.
-        :rtype: str
-        """
-        return "1.0.0"
-
-    def get(self) -> str:
-        """
-        Returns the content of the document.
-
-        :return: Document's content.
-        :rtype: str
-        """
-        return str(self._ysource)
-
-    def set(self, value: str) -> None:
-        """
-        Sets the content of the document.
-
-        :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()
-            # initialize document
-            if value:
-                self._ysource += value
-
-    def observe(self, callback: Callable[[str, Any], None]) -> None:
-        """
-        Subscribes to document changes.
-
-        :param callback: Callback that will be called when the document changes.
-        :type callback: Callable[[str, Any], None]
-        """
-        self.unobserve()
-        self._subscriptions[self._ystate] = self._ystate.observe(partial(callback, "state"))
-        self._subscriptions[self._ysource] = self._ysource.observe(partial(callback, "source"))