Add more tests, require Python 3.10+ (#359)

* Add more tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Remove coverage pinning

* Use python 3.10 in check-release

* In readthedocs.yml too

* Fix pip install in readthedocs

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: davidbrochart

.github/workflows/check-release.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         group: [check_release, link_check]
-        python-version: ["3.9"]
+        python-version: ["3.10"]
         node-version: ["14.x"]
     steps:
       - name: Checkout

.github/workflows/test.yml

@@ -28,13 +28,14 @@ jobs:
           echo "    pre-commit run --all-files --hook-stage=manual"
 
   test:
-    name: Run tests on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+    name: Run tests on ${{ matrix.os }} py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
     timeout-minutes: 10
 
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu, windows, macos]
+        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14' ]
     defaults:
       run:
         shell: bash -l {0}
@@ -48,7 +49,7 @@ jobs:
       - name: Install dependencies
         run: |
           micromamba install pip nodejs=18
-          pip install ".[test]"
+          pip install . --group test
       - name: Build JavaScript assets
         working-directory: javascript
         run: |
@@ -76,5 +77,11 @@ jobs:
           yarn build:test
           yarn test:cov
       - name: Run Python tests
+        if: ${{ !((matrix.python-version == '3.14') && (matrix.os == 'ubuntu')) }}
         run: |
           python -m pytest -v
+      - name: Run Python code coverage
+        if: ${{ (matrix.python-version == '3.14') && (matrix.os == 'ubuntu') }}
+        run: |
+          coverage run -m pytest -v
+          coverage report --show-missing

README.md

@@ -30,8 +30,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/__init__.py

@@ -1,19 +1,12 @@
 # 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
 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/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 @@ def source(self, value: Any):
         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 @@ def dirty(self, value: bool) -> None:
         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 @@ def hash(self, value: str) -> None:
         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 @@ def set(self, value: bytes) -> None:
         :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
@@ -47,7 +48,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 +93,7 @@ def cell_number(self) -> int:
         """
         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 +105,7 @@ def get_cell(self, index: int) -> Dict[str, Any]:
         """
         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 +121,7 @@ def _cell_to_py(self, ycell: Map) -> Dict[str, Any]:
             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 +131,7 @@ def append_cell(self, value: Dict[str, Any]) -> None:
         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 +144,7 @@ def set_cell(self, index: int, value: Dict[str, Any]) -> None:
         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 +194,7 @@ def set_ycell(self, index: int, ycell: Map) -> None:
         """
         self._ycells[index] = ycell
 
-    def get(self) -> Dict:
+    def get(self) -> dict:
         """
         Returns the content of the document.
 
@@ -227,7 +228,7 @@ def get(self) -> Dict:
             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.
 
@@ -251,7 +252,7 @@ def set(self, value: Dict) -> None:
         old_ycells_by_id = {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

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 @@ def set(self, value: str) -> None:
             # 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()

pyproject.toml

@@ -9,18 +9,17 @@ build-backend = "hatchling.build"
 name = "jupyter-ydoc"
 dynamic = ["version"]
 description = "Document structures for collaborative editing using Ypy"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 keywords = ["jupyter", "pycrdt", "yjs"]
 dependencies = [
-    "importlib_metadata >=3.6; python_version<'3.10'",
     "pycrdt >=0.10.1,<0.13.0",
 ]
 
 [[project.authors]]
 name = "Jupyter Development Team"
 email = "[email protected]"
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
     "click",
     "jupyter_releaser",
@@ -33,6 +32,7 @@ test = [
     "httpx-ws >=0.5.2",
     "hypercorn >=0.16.0",
     "pycrdt-websocket >=0.16.0,<0.17.0",
+    "coverage",
 ]
 docs = [
     "sphinx",