jupyverse 0.6.2__tar.gz → 0.6.3__tar.gz

{jupyverse-0.6.2 → jupyverse-0.6.3}/.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.4
+    rev: v0.6.8
     hooks:
       - id: ruff
         args: ["--fix"]

{jupyverse-0.6.2 → jupyverse-0.6.3}/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 0.6.3
+
+([Full Changelog](https://github.com/jupyter-server/jupyverse/compare/v0.6.2...aa6854a51665d95216340d7fda1ba111af6aef74))
+
+### Merged PRs
+
+- Add Yjs plugin configuration [#442](https://github.com/jupyter-server/jupyverse/pull/442) ([@davidbrochart](https://github.com/davidbrochart))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter-server/jupyverse/graphs/contributors?from=2024-09-13&to=2024-10-02&type=c))
+
+[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Adavidbrochart+updated%3A2024-09-13..2024-10-02&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Apre-commit-ci+updated%3A2024-09-13..2024-10-02&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
 ## 0.6.2
 
 ([Full Changelog](https://github.com/jupyter-server/jupyverse/compare/v0.6.1...b7823731e061936842a3d2bcc6044f5134b50857))
@@ -16,8 +32,6 @@
 
 [@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Adavidbrochart+updated%3A2024-09-09..2024-09-13&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Apre-commit-ci+updated%3A2024-09-09..2024-09-13&type=Issues)
 
-<!-- <END NEW CHANGELOG ENTRY> -->
-
 ## 0.6.1
 
 ([Full Changelog](https://github.com/jupyter-server/jupyverse/compare/v0.6.0...74930336b6b60a75e07cb0d45b10e4cfcdb80d58))

{jupyverse-0.6.2 → jupyverse-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: jupyverse
-Version: 0.6.2
+Version: 0.6.3
 Summary: A set of FPS plugins implementing a Jupyter server
 Project-URL: Homepage, https://jupyter.org
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>

jupyverse-0.6.3/jupyverse/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

{jupyverse-0.6.2 → jupyverse-0.6.3}/jupyverse_api/jupyverse_api/__init__.py

@@ -4,7 +4,7 @@ from pydantic import BaseModel
 
 from .app import App
 
-__version__ = "0.6.2"
+__version__ = "0.6.3"
 
 
 class Singleton(type):

{jupyverse-0.6.2 → jupyverse-0.6.3}/jupyverse_api/jupyverse_api/yjs/__init__.py

@@ -3,7 +3,7 @@ from typing import Any
 
 from fastapi import APIRouter, Depends, Request, Response
 
-from jupyverse_api import Router
+from jupyverse_api import Config, Router
 
 from ..app import App
 from ..auth import Auth, User
@@ -61,3 +61,8 @@ class Yjs(Router, ABC):
         document_id: str,
     ):
         ...
+
+
+class YjsConfig(Config):
+    document_cleanup_delay: float = 60
+    document_save_delay: float = 1

jupyverse-0.6.3/plugins/auth/fps_auth/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/auth_fief/fps_auth_fief/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

{jupyverse-0.6.2 → jupyverse-0.6.3}/plugins/auth_jupyterhub/fps_auth_jupyterhub/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "0.6.2"
+__version__ = "0.6.3"
 
 from .launch import launch  # noqa

jupyverse-0.6.3/plugins/contents/fps_contents/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/frontend/fps_frontend/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/jupyterlab/fps_jupyterlab/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/kernels/fps_kernels/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/lab/fps_lab/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/login/fps_login/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/nbconvert/fps_nbconvert/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/noauth/fps_noauth/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/notebook/fps_notebook/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/resource_usage/fps_resource_usage/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/terminals/fps_terminals/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/webdav/fps_webdav/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

jupyverse-0.6.3/plugins/yjs/fps_yjs/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

{jupyverse-0.6.2 → jupyverse-0.6.3}/plugins/yjs/fps_yjs/main.py

@@ -8,22 +8,27 @@ from asphalt.core import Component, Context, context_teardown
 from jupyverse_api.app import App
 from jupyverse_api.auth import Auth
 from jupyverse_api.contents import Contents
-from jupyverse_api.yjs import Yjs
+from jupyverse_api.yjs import Yjs, YjsConfig
 
 from .routes import _Yjs
 
 
 class YjsComponent(Component):
+    def __init__(self, **kwargs):
+        self.yjs_config = YjsConfig(**kwargs)
+
     @context_teardown
     async def start(
         self,
         ctx: Context,
     ) -> AsyncGenerator[None, Optional[BaseException]]:
+        ctx.add_resource(self.yjs_config, types=YjsConfig)
+
         app = await ctx.request_resource(App)
         auth = await ctx.request_resource(Auth)  # type: ignore
         contents = await ctx.request_resource(Contents)  # type: ignore
 
-        yjs = _Yjs(app, auth, contents)
+        yjs = _Yjs(app, self.yjs_config, auth, contents)
         ctx.add_resource(yjs, types=Yjs)
 
         # start indexing in the background

{jupyverse-0.6.2 → jupyverse-0.6.3}/plugins/yjs/fps_yjs/routes.py

@@ -20,7 +20,7 @@ from websockets.exceptions import ConnectionClosedOK
 from jupyverse_api.app import App
 from jupyverse_api.auth import Auth, User
 from jupyverse_api.contents import Contents
-from jupyverse_api.yjs import Yjs
+from jupyverse_api.yjs import Yjs, YjsConfig
 from jupyverse_api.yjs.models import CreateDocumentSession
 
 from .ydocs import ydocs as YDOCS
@@ -44,12 +44,13 @@ class _Yjs(Yjs):
     def __init__(
         self,
         app: App,
+        yjs_config: YjsConfig,
         auth: Auth,
         contents: Contents,
     ) -> None:
         super().__init__(app=app, auth=auth)
         self.contents = contents
-        self.room_manager = RoomManager(contents)
+        self.room_manager = RoomManager(contents, yjs_config)
         if Widgets is None:
             self.widgets = None
         else:
@@ -148,8 +149,9 @@ class RoomManager:
     websocket_server: JupyterWebsocketServer
     lock: asyncio.Lock
 
-    def __init__(self, contents: Contents):
+    def __init__(self, contents: Contents, yjs_config: YjsConfig):
         self.contents = contents
+        self.yjs_config = yjs_config
         self.documents = {}  # a dictionary of room_name:document
         self.watchers = {}  # a dictionary of file_id:task
         self.savers = {}  # a dictionary of file_id:task
@@ -314,7 +316,7 @@ class RoomManager:
         self, file_id: str, file_type: str, file_format: str, document: YBaseDoc
     ) -> None:
         # save after 1 second of inactivity to prevent too frequent saving
-        await asyncio.sleep(1)  # FIXME: pass in config
+        await asyncio.sleep(self.yjs_config.document_save_delay)
         # if the room cannot be found, don't save
         try:
             file_path = await self.get_file_path(file_id, document)
@@ -349,12 +351,12 @@ class RoomManager:
         del self.savers[file_id]
 
     async def maybe_clean_room(self, room, ws_path: str) -> None:
-        file_id = ws_path.split(":", 2)[2]
         # keep the document for a while in case someone reconnects
-        await asyncio.sleep(60)  # FIXME: pass in config
+        await asyncio.sleep(self.yjs_config.document_cleanup_delay)
         document = self.documents[ws_path]
         document.unobserve()
         del self.documents[ws_path]
+        file_id = ws_path.split(":", 2)[2]
         documents = [v for k, v in self.documents.items() if k.split(":", 2)[2] == file_id]
         if not documents:
             self.watchers[file_id].cancel()

jupyverse-0.6.2/jupyverse/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/auth/fps_auth/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/auth_fief/fps_auth_fief/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/contents/fps_contents/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/frontend/fps_frontend/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/jupyterlab/fps_jupyterlab/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/kernels/fps_kernels/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/lab/fps_lab/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/login/fps_login/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/nbconvert/fps_nbconvert/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/noauth/fps_noauth/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/notebook/fps_notebook/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/resource_usage/fps_resource_usage/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/terminals/fps_terminals/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/webdav/fps_webdav/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"

jupyverse-0.6.2/plugins/yjs/fps_yjs/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.2"