Add optional file ID to document state

jupyter_ydoc/ybasedoc.py

@@ -109,6 +109,16 @@ def path(self) -> Optional[str]:
         """
         return self._ystate.get("path")
 
+    @property
+    def file_id(self) -> Optional[str]:
+        """
+        Returns document's file ID.
+
+        :return: Document's file ID.
+        :rtype: Optional[str]
+        """
+        return self._ystate.get("file_id")
+
     @path.setter
     def path(self, value: str) -> None:
         """
@@ -119,6 +129,16 @@ def path(self, value: str) -> None:
         """
         self._ystate["path"] = value
 
+    @file_id.setter
+    def file_id(self, value: str) -> None:
+        """
+        Sets document's file ID.
+
+        :param value: Document's file ID.
+        :type value: str
+        """
+        self._ystate["file_id"] = value
+
     @abstractmethod
     def get(self) -> Any:
         """

jupyter_ydoc/ynotebook.py

@@ -229,7 +229,7 @@ def set(self, value: Dict) -> None:
             # clear document
             self._ymeta.clear()
             self._ycells.clear()
-            for key in [k for k in self._ystate.keys() if k not in ("dirty", "path")]:
+            for key in [k for k in self._ystate.keys() if k not in ("dirty", "path", "file_id")]:
                 del self._ystate[key]
 
             # initialize document