revert to synchronous contents manager, add separate async contents m…

…anager

jupyterfs/extension.py

@@ -10,7 +10,7 @@
 from jupyter_server.utils import url_path_join
 
 from ._version import __version__  # noqa: F401
-from .metamanager import MetaManager, MetaManagerHandler
+from .metamanager import MetaManagerMixin, MetaManager, MetaManagerHandler
 from .snippets import SnippetsHandler
 
 _mm_config_warning_msg = """Misconfiguration of MetaManager. Please add:
@@ -42,7 +42,7 @@ def _load_jupyter_server_extension(serverapp):
         return
 
     if isinstance(serverapp.contents_manager_class, type) and not issubclass(
-        serverapp.contents_manager_class, MetaManager
+        serverapp.contents_manager_class, MetaManagerMixin
     ):
         serverapp.contents_manager_class = MetaManager
         serverapp.log.info(

jupyterfs/metamanager.py

@@ -15,7 +15,10 @@
 from fs.errors import FSError
 from fs.opener.errors import OpenerError, ParseError
 from jupyter_server.base.handlers import APIHandler
-from jupyter_server.services.contents.manager import AsyncContentsManager
+from jupyter_server.services.contents.manager import (
+    AsyncContentsManager,
+    ContentsManager,
+)
 
 from .auth import substituteAsk, substituteEnv, substituteNone
 from .config import JupyterFs as JupyterFsConfig
@@ -30,10 +33,10 @@
     stripDrive,
 )
 
-__all__ = ["MetaManager", "MetaManagerHandler"]
+__all__ = ["MetaManagerMixin", "MetaManager", "MetaManagerHandler", "SyncMetaManager"]
 
 
-class MetaManager(AsyncContentsManager):
+class MetaManagerMixin:
     copy_pat = re.compile(r"\-Copy\d*\.")
 
     @default("files_handler_params")
@@ -153,7 +156,7 @@ def root_manager(self):
     def root_dir(self):
         return self.root_manager.root_dir
 
-    async def copy(self, from_path, to_path=None):
+    def copy(self, from_path, to_path=None):
         """Copy an existing file and return its new model.
 
         If to_path not specified, it will be the parent directory of from_path.
@@ -205,32 +208,6 @@ def _getManagerForPath(self, path):
 
         return mgr, stripDrive(path)
 
-    is_hidden = path_first_arg("is_hidden", False)
-    dir_exists = path_first_arg("dir_exists", False)
-    file_exists = path_kwarg("file_exists", "", False)
-    exists = path_first_arg("exists", False)
-
-    save = path_second_arg("save", "model", True)
-    rename = path_old_new("rename", False)
-
-    get = path_first_arg("get", True)
-    delete = path_first_arg("delete", False)
-
-    get_kernel_path = path_first_arg("get_kernel_path", False, sync=True)
-
-    create_checkpoint = path_first_arg("create_checkpoint", False)
-    list_checkpoints = path_first_arg("list_checkpoints", False)
-    restore_checkpoint = path_second_arg(
-        "restore_checkpoint",
-        "checkpoint_id",
-        False,
-    )
-    delete_checkpoint = path_second_arg(
-        "delete_checkpoint",
-        "checkpoint_id",
-        False,
-    )
-
 
 class MetaManagerHandler(APIHandler):
     _jupyterfsConfig = None
@@ -300,3 +277,57 @@ async def post(self):
         self.finish(
             json.dumps(self.contents_manager.initResource(*resources, options=options))
         )
+
+
+class MetaManager(MetaManagerMixin, AsyncContentsManager):
+    async def copy(self, from_path, to_path=None):
+        return super().copy(from_path=from_path, to_path=to_path)
+
+    is_hidden = path_first_arg("is_hidden", False, sync=False)
+    dir_exists = path_first_arg("dir_exists", False, sync=False)
+    file_exists = path_kwarg("file_exists", "", False, sync=False)
+    exists = path_first_arg("exists", False, sync=False)
+
+    save = path_second_arg("save", "model", True, sync=False)
+    rename = path_old_new("rename", False, sync=False)
+
+    get = path_first_arg("get", True, sync=False)
+    delete = path_first_arg("delete", False, sync=False)
+
+    get_kernel_path = path_first_arg("get_kernel_path", False, sync=False)
+
+    create_checkpoint = path_first_arg("create_checkpoint", False, sync=False)
+    list_checkpoints = path_first_arg("list_checkpoints", False, sync=False)
+    restore_checkpoint = path_second_arg(
+        "restore_checkpoint", "checkpoint_id", False, sync=False
+    )
+    delete_checkpoint = path_second_arg(
+        "delete_checkpoint", "checkpoint_id", False, sync=False
+    )
+
+
+class SyncMetaManager(MetaManagerMixin, ContentsManager):
+    def copy(self, from_path, to_path=None):
+        return super().copy(from_path=from_path, to_path=to_path)
+
+    is_hidden = path_first_arg("is_hidden", False, sync=True)
+    dir_exists = path_first_arg("dir_exists", False, sync=True)
+    file_exists = path_kwarg("file_exists", "", False, sync=True)
+    exists = path_first_arg("exists", False, sync=True)
+
+    save = path_second_arg("save", "model", True, sync=True)
+    rename = path_old_new("rename", False, sync=True)
+
+    get = path_first_arg("get", True, sync=True)
+    delete = path_first_arg("delete", False, sync=True)
+
+    get_kernel_path = path_first_arg("get_kernel_path", False, sync=True)
+
+    create_checkpoint = path_first_arg("create_checkpoint", False, sync=True)
+    list_checkpoints = path_first_arg("list_checkpoints", False, sync=True)
+    restore_checkpoint = path_second_arg(
+        "restore_checkpoint", "checkpoint_id", False, sync=True
+    )
+    delete_checkpoint = path_second_arg(
+        "delete_checkpoint", "checkpoint_id", False, sync=True
+    )

jupyterfs/pathutils.py

@@ -112,58 +112,98 @@ async def _wrapper(self, *args, **kwargs):
     return _wrapper
 
 
-def path_second_arg(method_name, first_argname, returns_model):
+def path_second_arg(method_name, first_argname, returns_model, sync=False):
     """Decorator for methods that accept path as a second argument.
     e.g. manager.save(model, path, ...)"""
 
-    async def _wrapper(self, *args, **kwargs):
-        other, args = _get_arg(first_argname, args, kwargs)
-        path, args = _get_arg("path", args, kwargs)
-        _, mgr, mgr_path = _resolve_path(path, self._managers)
-        result = getattr(mgr, method_name)(other, mgr_path, *args, **kwargs)
-        return result
+    if sync:
+
+        def _wrapper(self, *args, **kwargs):
+            other, args = _get_arg(first_argname, args, kwargs)
+            path, args = _get_arg("path", args, kwargs)
+            _, mgr, mgr_path = _resolve_path(path, self._managers)
+            result = getattr(mgr, method_name)(other, mgr_path, *args, **kwargs)
+            return result
+
+    else:
+
+        async def _wrapper(self, *args, **kwargs):
+            other, args = _get_arg(first_argname, args, kwargs)
+            path, args = _get_arg("path", args, kwargs)
+            _, mgr, mgr_path = _resolve_path(path, self._managers)
+            result = getattr(mgr, method_name)(other, mgr_path, *args, **kwargs)
+            return result
 
     return _wrapper
 
 
-def path_kwarg(method_name, path_default, returns_model):
+def path_kwarg(method_name, path_default, returns_model, sync=False):
     """Parameterized decorator for methods that accept path as a second
     argument.
 
     e.g. manager.file_exists(path='')
     """
+    if sync:
 
-    async def _wrapper(self, path=path_default, **kwargs):
-        _, mgr, mgr_path = _resolve_path(path, self._managers)
-        result = getattr(mgr, method_name)(path=mgr_path, **kwargs)
-        return result
+        def _wrapper(self, path=path_default, **kwargs):
+            _, mgr, mgr_path = _resolve_path(path, self._managers)
+            result = getattr(mgr, method_name)(path=mgr_path, **kwargs)
+            return result
+
+    else:
+
+        async def _wrapper(self, path=path_default, **kwargs):
+            _, mgr, mgr_path = _resolve_path(path, self._managers)
+            result = getattr(mgr, method_name)(path=mgr_path, **kwargs)
+            return result
 
     return _wrapper
 
 
-def path_old_new(method_name, returns_model):
+def path_old_new(method_name, returns_model, sync=False):
     """Decorator for methods accepting old_path and new_path.
 
     e.g. manager.rename(old_path, new_path)
     """
+    if sync:
 
-    async def _wrapper(self, old_path, new_path, *args, **kwargs):
-        old_prefix, old_mgr, old_mgr_path = _resolve_path(old_path, self._managers)
-        new_prefix, new_mgr, new_mgr_path = _resolve_path(new_path, self._managers)
-        if old_mgr is not new_mgr:
-            # TODO: Consider supporting this via get+save+delete.
-            raise HTTPError(
-                400,
-                "Can't move files between backends yet ({old} -> {new})".format(
-                    old=old_path,
-                    new=new_path,
-                ),
+        def _wrapper(self, old_path, new_path, *args, **kwargs):
+            old_prefix, old_mgr, old_mgr_path = _resolve_path(old_path, self._managers)
+            new_prefix, new_mgr, new_mgr_path = _resolve_path(new_path, self._managers)
+            if old_mgr is not new_mgr:
+                # TODO: Consider supporting this via get+save+delete.
+                raise HTTPError(
+                    400,
+                    "Can't move files between backends yet ({old} -> {new})".format(
+                        old=old_path,
+                        new=new_path,
+                    ),
+                )
+            assert new_prefix == old_prefix
+            result = getattr(new_mgr, method_name)(
+                old_mgr_path, new_mgr_path, *args, **kwargs
             )
-        assert new_prefix == old_prefix
-        result = getattr(new_mgr, method_name)(
-            old_mgr_path, new_mgr_path, *args, **kwargs
-        )
-        return result
+            return result
+
+    else:
+
+        async def _wrapper(self, old_path, new_path, *args, **kwargs):
+            old_prefix, old_mgr, old_mgr_path = _resolve_path(old_path, self._managers)
+            new_prefix, new_mgr, new_mgr_path = _resolve_path(new_path, self._managers)
+            if old_mgr is not new_mgr:
+                # TODO: Consider supporting this via get+save+delete.
+                raise HTTPError(
+                    400,
+                    "Can't move files between backends yet ({old} -> {new})".format(
+                        old=old_path,
+                        new=new_path,
+                    ),
+                )
+            assert new_prefix == old_prefix
+            result = getattr(new_mgr, method_name)(
+                old_mgr_path, new_mgr_path, *args, **kwargs
+            )
+            return result
 
     return _wrapper