Doc awareness

jupyter_ydoc/ybasedoc.py

@@ -5,6 +5,7 @@
 from typing import Any, Callable, Dict, Optional
 
 from pycrdt import Doc, Map, Subscription, UndoManager
+from pycrdt_websocket.awareness import Awareness
 
 
 class YBaseDoc(ABC):
@@ -20,7 +21,7 @@ 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.
 
@@ -31,6 +32,9 @@ def __init__(self, ydoc: Optional[Doc] = 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)
@@ -74,6 +78,25 @@ def ydoc(self) -> Doc:
         """
         return self._ydoc
 
+    @property
+    def awareness(self) -> Awareness | None:
+        """
+        Return the awareness.
+
+        :return: The document's awareness.
+        :rtype: :class:`pycrdt_websocket.awareness.Awareness`
+        """
+        return self._awareness
+
+    @awareness.setter
+    def awareness(self, value: Awareness):
+        """
+        Sets the awareness.
+
+        :param: The awareness.
+        """
+        self._awareness = value
+
     @property
     def source(self) -> Any:
         """

jupyter_ydoc/yblob.py

@@ -5,6 +5,7 @@
 from typing import Any, Callable, Optional
 
 from pycrdt import Doc, Map
+from pycrdt_websocket.awareness import Awareness
 
 from .ybasedoc import YBaseDoc
 
@@ -24,14 +25,14 @@ 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.
         """
-        super().__init__(ydoc)
+        super().__init__(ydoc, awareness)
         self._ysource = self._ydoc.get("source", type=Map)
         self.undo_manager.expand_scope(self._ysource)
 

jupyter_ydoc/ynotebook.py

@@ -7,6 +7,7 @@
 from uuid import uuid4
 
 from pycrdt import Array, Doc, Map, Text
+from pycrdt_websocket.awareness import Awareness
 
 from .utils import cast_all
 from .ybasedoc import YBaseDoc
@@ -47,14 +48,14 @@ 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.
         """
-        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)

jupyter_ydoc/yunicode.py

@@ -5,6 +5,7 @@
 from typing import Any, Callable, Optional
 
 from pycrdt import Doc, Text
+from pycrdt_websocket.awareness import Awareness
 
 from .ybasedoc import YBaseDoc
 
@@ -23,14 +24,14 @@ 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.
         """
-        super().__init__(ydoc)
+        super().__init__(ydoc, awareness)
         self._ysource = self._ydoc.get("source", type=Text)
         self.undo_manager.expand_scope(self._ysource)
 

tests/test_ydocs.py

@@ -1,6 +1,8 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+from pycrdt_websocket.awareness import Awareness
+
 from jupyter_ydoc import YBlob, YNotebook
 
 
@@ -53,3 +55,14 @@ def test_ynotebook_undo_manager():
     ynotebook.undo_manager.undo()
     assert len(ynotebook.ycells) == 0
     assert not ynotebook.undo_manager.can_undo()
+
+
+def test_awareness():
+    yblob = YBlob()
+
+    assert yblob.awareness is None
+
+    awareness = Awareness(yblob.ydoc)
+    yblob.awareness = awareness
+
+    assert yblob.awareness == awareness