Add YFile and YNotebook

Author: davidbrochart

.pre-commit-config.yaml

@@ -0,0 +1,55 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: forbid-new-submodules
+      - id: check-builtin-literals
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        args: ["--line-length", "100"]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        files: \.py$
+        args: [--profile=black]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.32.0
+    hooks:
+      - id: pyupgrade
+        args: [--py37-plus]
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: 0.11.1
+    hooks:
+      - id: doc8
+        args: [--max-line-length=200]
+        exclude: docs/source/other/full-config.rst
+        stages: [manual]
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          [
+            "flake8-bugbear==20.1.4",
+            "flake8-logging-format==0.6.0",
+            "flake8-implicit-str-concat==0.2.0",
+          ]
+        stages: [manual]

jupyter_ydoc/__init__.py

@@ -0,0 +1,3 @@
+from .ydoc import YFile, YNotebook
+
+__version__ = "0.1.0"

jupyter_ydoc/ydoc.py

@@ -0,0 +1,170 @@
+from typing import Dict, List, Union
+from uuid import uuid4
+
+import y_py as Y
+from ypy_websocket.websocket_server import YDoc
+
+
+class YBaseDoc:
+    def __init__(self, ydoc: YDoc):
+        self._ydoc = ydoc
+        self._ystate = self._ydoc.get_map("state")
+        self._subscriptions = {}
+
+    @property
+    def ystate(self):
+        return self._ystate
+
+    @property
+    def ydoc(self):
+        return self._ydoc
+
+    @property
+    def source(self):
+        raise RuntimeError("Y document source generation not implemented")
+
+    @source.setter
+    def source(self, value):
+        raise RuntimeError("Y document source initialization not implemented")
+
+    @property
+    def dirty(self) -> None:
+        return self._ystate["dirty"]
+
+    @dirty.setter
+    def dirty(self, value: bool) -> None:
+        if self.dirty != value:
+            with self._ydoc.begin_transaction() as t:
+                self._ystate.set(t, "dirty", value)
+
+    def observe(self, callback):
+        raise RuntimeError("Y document observe not implemented")
+
+    def unobserve(self):
+        for k, v in self._subscriptions.items():
+            k.unobserve(v)
+        self._subscriptions = {}
+
+
+class YFile(YBaseDoc):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._ysource = self._ydoc.get_text("source")
+
+    @property
+    def source(self):
+        return str(self._ysource)
+
+    @source.setter
+    def source(self, value):
+        with self._ydoc.begin_transaction() as t:
+            # clear document
+            source_len = len(self._ysource)
+            if source_len:
+                self._ysource.delete(t, 0, source_len)
+            # initialize document
+            if value:
+                self._ysource.push(t, value)
+
+    def observe(self, callback):
+        self._subscriptions[self._ysource] = self._ysource.observe(callback)
+
+
+class YNotebook(YBaseDoc):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._ycells = self._ydoc.get_array("cells")
+        self._ymeta = self._ydoc.get_map("meta")
+
+    @property
+    def source(self):
+        cells = self._ycells.to_json()
+        meta = self._ymeta.to_json()
+        state = self._ystate.to_json()
+        cast_all(cells, float, int)
+        cast_all(meta, float, int)
+        for cell in cells:
+            if "id" in cell and state["nbformat"] == 4 and state["nbformatMinor"] <= 4:
+                # strip cell IDs if we have notebook format 4.0-4.4
+                del cell["id"]
+        return dict(
+            cells=cells,
+            metadata=meta["metadata"],
+            nbformat=int(state["nbformat"]),
+            nbformat_minor=int(state["nbformatMinor"]),
+        )
+
+    @source.setter
+    def source(self, value):
+        cast_all(value, int, float)
+        if not value["cells"]:
+            value["cells"] = [
+                {
+                    "cell_type": "code",
+                    "execution_count": None,
+                    "metadata": {},
+                    "outputs": [],
+                    "source": "",
+                    "id": str(uuid4()),
+                }
+            ]
+        # workaround until ypy is fixed: https://github.com/davidbrochart/ypy-websocket/pull/9
+        ytexts_to_clear = []
+        with self._ydoc.begin_transaction() as t:
+            # clear document
+            cells_len = len(self._ycells)
+            if cells_len:
+                self._ycells.delete(t, 0, cells_len)
+            for key in self._ymeta:
+                self._ymeta.delete(t, key)
+            for key in [k for k in self._ystate if k != "dirty"]:
+                self._ystate.delete(t, key)
+
+            # initialize document
+            ycells = []
+            for cell in value["cells"]:
+                cell_source = cell["source"]
+                if cell_source:
+                    ytext = Y.YText(cell_source)
+                else:
+                    ytext = Y.YText(" ")
+                    ytexts_to_clear.append(ytext)
+                cell["source"] = ytext
+                if "outputs" in cell:
+                    cell["outputs"] = Y.YArray(cell["outputs"])
+                ycell = Y.YMap(cell)
+                ycells.append(ycell)
+
+            if ycells:
+                self._ycells.push(t, ycells)
+            self._ymeta.set(t, "metadata", value["metadata"])
+            self._ystate.set(t, "nbformat", value["nbformat"])
+            self._ystate.set(t, "nbformatMinor", value["nbformat_minor"])
+        with self._ydoc.begin_transaction() as t:
+            for ytext in ytexts_to_clear:
+                ytext.delete(t, 0, 1)
+
+    def observe(self, callback):
+        self.unobserve()
+        for cell in self._ycells:
+            self._subscriptions[cell["source"]] = cell["source"].observe(callback)
+            if "outputs" in cell:
+                self._subscriptions[cell["outputs"]] = cell["outputs"].observe(callback)
+            self._subscriptions[cell] = cell.observe(callback)
+        self._subscriptions[self._ycells] = self._ycells.observe(callback)
+        self._subscriptions[self._ymeta] = self._ymeta.observe(callback)
+
+
+def cast_all(o: Union[List, Dict], from_type, to_type) -> None:
+    if isinstance(o, list):
+        for i, v in enumerate(o):
+            if isinstance(v, from_type):
+                o[i] = to_type(v)
+            elif isinstance(v, (list, dict)):
+                cast_all(v, from_type, to_type)
+    elif isinstance(o, dict):
+        for k, v in o.items():
+            if isinstance(v, from_type):
+                o[k] = to_type(v)
+            elif isinstance(v, (list, dict)):
+                cast_all(v, from_type, to_type)

setup.cfg

@@ -0,0 +1,36 @@
+[metadata]
+name = jupyter_ydoc
+version = attr: jupyter_ydoc.__version__
+description = Document structures for collaborative editing using Ypy
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = BSD 3-Clause License
+license_files = LICENSE
+author = David Brochart
+author_email = david.brochart@gmail.com
+url = https://github.com/davidbrochart/jupyter_ydoc
+platforms = Windows, Linux, Mac OS X
+keywords = jupyter ypy
+
+[bdist_wheel]
+universal = 1
+
+[options]
+include_package_data = True
+packages = find:
+python_requires = >=3.7
+
+install_requires =
+  ypy-websocket >=0.1.2
+
+[options.extras_require]
+test =
+  pre-commit
+
+[options.entry_points]
+jupyter_ydoc =
+    file = jupyter_ydoc.ydoc:YFile
+    notebook = jupyter_ydoc.ydoc:YNotebook
+
+[flake8]
+max-line-length = 100

setup.py

@@ -0,0 +1,3 @@
+import setuptools
+
+setuptools.setup()