jupyverse 0.10.2__tar.gz → 0.10.4__tar.gz

{jupyverse-0.10.2 → jupyverse-0.10.4}/.pre-commit-config.yaml

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

{jupyverse-0.10.2 → jupyverse-0.10.4}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Version history
 
+## 0.10.3
+
+- Propagate `yjs` settings.
+
 ## 0.10.2
 
 - Rework `test_kernels.py` to use ASGI transport.

{jupyverse-0.10.2 → jupyverse-0.10.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyverse
-Version: 0.10.2
+Version: 0.10.4
 Summary: A set of FPS plugins implementing a Jupyter server
 Project-URL: Homepage, https://jupyter.org
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
@@ -12,14 +12,14 @@ Requires-Dist: eval-type-backport; python_version < '3.10'
 Requires-Dist: fps-contents<0.11.0,>=0.10.0
 Requires-Dist: fps-file-id<0.3.0,>=0.2.0
 Requires-Dist: fps-frontend<0.10.0,>=0.9.0
-Requires-Dist: fps-kernel-subprocess<0.2.0,>=0.1.0
+Requires-Dist: fps-kernel-subprocess<0.2.0,>=0.1.1
 Requires-Dist: fps-kernels<0.10.0,>=0.9.1
 Requires-Dist: fps-lab<0.10.0,>=0.9.0
 Requires-Dist: fps-nbconvert<0.10.0,>=0.9.0
 Requires-Dist: fps-terminals<0.10.0,>=0.9.0
-Requires-Dist: fps-yjs<0.11.0,>=0.10.0
+Requires-Dist: fps-yjs<0.11.0,>=0.10.1
 Requires-Dist: fps[anycorn,click,fastapi]<0.5.0,>=0.4.0
-Requires-Dist: jupyverse-api<0.11.0,>=0.10.0
+Requires-Dist: jupyverse-api<0.11.0,>=0.10.1
 Requires-Dist: rich-click<2,>=1.6.1
 Provides-Extra: auth
 Requires-Dist: fps-auth<0.10.0,>=0.9.0; extra == 'auth'

{jupyverse-0.10.2 → jupyverse-0.10.4}/jupyverse_api/jupyverse_api/kernel/__init__.py

@@ -2,17 +2,18 @@ from __future__ import annotations
 
 from abc import ABC, abstractmethod
 
-from anyio import TASK_STATUS_IGNORED, create_memory_object_stream
+from anyio import TASK_STATUS_IGNORED, Event, create_memory_object_stream
 from anyio.abc import TaskStatus
 from anyio.streams.memory import MemoryObjectReceiveStream
 from anyio.streams.stapled import StapledObjectStream
 
 
 class Kernel(ABC):
-    key = "0"
-    wait_for_ready = False
-
     def __init__(self) -> None:
+        self.key = "0"
+        self.wait_for_ready = False
+        self.started = Event()
+
         self._to_shell_send_stream, self._to_shell_receive_stream = create_memory_object_stream[
             list[bytes]
         ]()

{jupyverse-0.10.2 → jupyverse-0.10.4}/jupyverse_api/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "jupyverse_api"
-version = "0.10.0"
+version = "0.10.1"
 description = "The public API for Jupyverse"
 readme = "README.md"
 requires-python = ">=3.9"

{jupyverse-0.10.2 → jupyverse-0.10.4}/plugins/kernel_subprocess/fps_kernel_subprocess/kernel_subprocess.py

@@ -9,7 +9,7 @@ from dataclasses import dataclass
 from typing import cast
 
 import anyio
-from anyio import TASK_STATUS_IGNORED, create_task_group, open_process, sleep_forever
+from anyio import TASK_STATUS_IGNORED, create_task_group, open_process
 from anyio.abc import TaskStatus
 
 from jupyverse_api.kernel import Kernel
@@ -48,7 +48,6 @@ class KernelSubprocess(Kernel):
 
     async def start(self, *, task_status: TaskStatus[None] = TASK_STATUS_IGNORED) -> None:
         async with (
-            create_task_group() as self.task_group,
             self._to_shell_send_stream,
             self._to_shell_receive_stream,
             self._from_shell_send_stream,
@@ -63,6 +62,7 @@ class KernelSubprocess(Kernel):
             self._from_stdin_receive_stream,
             self._from_iopub_send_stream,
             self._from_iopub_receive_stream,
+            create_task_group() as self.task_group,
         ):
             with open(self.kernelspec_path) as f:
                 kernelspec = json.load(f)
@@ -105,7 +105,7 @@ class KernelSubprocess(Kernel):
             self.task_group.start_soon(self.forward_messages_from_iopub)
 
             task_status.started()
-            await sleep_forever()
+            self.started.set()
 
     async def stop(self) -> None:
         try:

{jupyverse-0.10.2 → jupyverse-0.10.4}/plugins/kernel_subprocess/pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_kernel_subprocess"
-version = "0.1.0"
+version = "0.1.1"
 description = "An FPS plugin for the kernel subprocess API"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"
 dependencies = [
-    "jupyverse-api >=0.10.0,<0.11.0",
+    "jupyverse-api >=0.10.1,<0.11.0",
     "anyio",
     "pyzmq",
     "zmq-anyio >=0.3.1,<0.4.0",

jupyverse-0.10.4/plugins/kernel_web_worker/COPYING.md

@@ -0,0 +1,59 @@
+# Licensing terms
+
+This project is licensed under the terms of the Modified BSD License
+(also known as New or Revised or 3-Clause BSD), as follows:
+
+- Copyright (c) 2025-, Jupyter Development Team
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+Neither the name of the Jupyter Development Team nor the names of its
+contributors may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## About the Jupyter Development Team
+
+The Jupyter Development Team is the set of all contributors to the Jupyter project.
+This includes all of the Jupyter subprojects.
+
+The core team that coordinates development on GitHub can be found here:
+https://github.com/jupyter/.
+
+## Our Copyright Policy
+
+Jupyter uses a shared copyright model. Each contributor maintains copyright
+over their contributions to Jupyter. But, it is important to note that these
+contributions are typically only changes to the repositories. Thus, the Jupyter
+source code, in its entirety is not the copyright of any single person or
+institution. Instead, it is the collective copyright of the entire Jupyter
+Development Team. If individual contributors want to maintain a record of what
+changes/contributions they have specific copyright on, they should indicate
+their copyright in the commit message of the change, when they commit the
+change to one of the Jupyter repositories.
+
+With this in mind, the following banner should be used in any source code file
+to indicate the copyright and license terms:
+
+    # Copyright (c) Jupyter Development Team.
+    # Distributed under the terms of the Modified BSD License.

jupyverse-0.10.4/plugins/kernel_web_worker/README.md

@@ -0,0 +1,3 @@
+# fps-kernel-web-worker
+
+An FPS plugin for the kernel web worker API, to be used with `microverse`.

jupyverse-0.10.4/plugins/kernel_web_worker/fps_kernel_web_worker/__init__.py

@@ -0,0 +1,6 @@
+import importlib.metadata
+
+try:
+    __version__ = importlib.metadata.version("fps_kernel_web_worker")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"

jupyverse-0.10.4/plugins/kernel_web_worker/fps_kernel_web_worker/kernel_web_worker.py

@@ -0,0 +1,90 @@
+from uuid import uuid4
+
+import pyjs  # type: ignore[import-not-found]
+from anyio import TASK_STATUS_IGNORED, Event, create_task_group
+from anyio.abc import TaskStatus
+
+from jupyverse_api.kernel import Kernel as Kernel
+
+
+class KernelWebWorker(Kernel):
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+
+    async def start(self, *, task_status: TaskStatus[None] = TASK_STATUS_IGNORED) -> None:
+        async with (
+            self._to_shell_send_stream,
+            self._to_shell_receive_stream,
+            self._from_shell_send_stream,
+            self._from_shell_receive_stream,
+            self._to_control_send_stream,
+            self._to_control_receive_stream,
+            self._from_control_send_stream,
+            self._from_control_receive_stream,
+            self._to_stdin_send_stream,
+            self._to_stdin_receive_stream,
+            self._from_stdin_send_stream,
+            self._from_stdin_receive_stream,
+            self._from_iopub_send_stream,
+            self._from_iopub_receive_stream,
+            create_task_group() as self.task_group,
+        ):
+            self.kernel_id = uuid4().hex
+            kernel_ready = Event()
+
+            def callback(msg):
+                if msg["type"] == "started":
+                    kernel_ready.set()
+                else:
+                    msg = [bytes(pyjs.to_py(m)) for m in msg["msg"]]
+                    if msg["type"] == "shell":
+                        self.task_group.start_soon(self._from_shell_send_stream.send, msg)
+                    elif msg["type"] == "control":
+                        self.task_group.start_soon(self._from_control_send_stream.send, msg)
+                    elif msg["type"] == "stdin":
+                        self.task_group.start_soon(self._from_stdin_send_stream.send, msg)
+                    elif msg["type"] == "iopub":
+                        self.task_group.start_soon(self._from_iopub_send_stream.send, msg)
+
+            js_callable, self.js_py_object = pyjs.create_callable(callback)
+            higher_order_function = pyjs.js.Function(
+                "callback", "action", "kernel_id",
+                "kernel_web_worker(action, kernel_id, 0, callback);"
+            )
+            higher_order_function(js_callable, "start", self.kernel_id)
+            await kernel_ready.wait()
+
+            self.task_group.start_soon(self.forward_messages_to_shell)
+            self.task_group.start_soon(self.forward_messages_to_control)
+            self.task_group.start_soon(self.forward_messages_to_stdin)
+
+            task_status.started()
+            self.started.set()
+
+    async def stop(self) -> None:
+        self.js_py_object.delete()
+        self.task_group.cancel_scope.cancel()
+
+    async def interrupt(self) -> None:
+        pass
+
+    async def forward_messages_to_shell(self) -> None:
+        async for msg in self._to_shell_receive_stream:
+            msg = pyjs.to_js(msg)
+            pyjs.js.Function(
+                "action", "kernel_id", "msg", "kernel_web_worker(action, kernel_id, msg, 0);"
+            )("shell", self.kernel_id, msg)
+
+    async def forward_messages_to_control(self) -> None:
+        async for msg in self._to_control_receive_stream:
+            msg = pyjs.to_js(msg)
+            pyjs.js.Function(
+                "action", "kernel_id", "msg", "kernel_web_worker(action, kernel_id, msg, 0);"
+            )("control", self.kernel_id, msg)
+
+    async def forward_messages_to_stdin(self) -> None:
+        async for msg in self._to_stdin_receive_stream:
+            msg = pyjs.to_js(msg)
+            pyjs.js.Function(
+                "action", "kernel_id", "msg", "kernel_web_worker(action, kernel_id, msg, 0);"
+            )("stdin", self.kernel_id, msg)

jupyverse-0.10.4/plugins/kernel_web_worker/fps_kernel_web_worker/main.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from fps import Module
+
+from jupyverse_api.kernel import DefaultKernelFactory
+
+from .kernel_web_worker import KernelWebWorker
+
+
+class KernelWebWorkerModule(Module):
+    async def prepare(self) -> None:
+        default_kernel_factory = DefaultKernelFactory(KernelWebWorker)
+        self.put(default_kernel_factory)

jupyverse-0.10.4/plugins/kernel_web_worker/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = [ "hatchling",]
+build-backend = "hatchling.build"
+
+[project]
+name = "fps_kernel_web_worker"
+version = "0.1.1"
+description = "An FPS plugin for the kernel web worker API"
+keywords = ["jupyter", "server", "fastapi", "plugins"]
+requires-python = ">=3.9"
+dependencies = [
+    "jupyverse-api >=0.10.1,<0.11.0",
+    "anyio",
+]
+[[project.authors]]
+name = "Jupyter Development Team"
+email = "jupyter@googlegroups.com"
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.license]
+text = "BSD 3-Clause License"
+
+[project.urls]
+Homepage = "https://jupyter.org"
+
+[project.entry-points]
+"fps.modules" = {kernel_web_worker = "fps_kernel_web_worker.main:KernelWebWorkerModule"}

{jupyverse-0.10.2 → jupyverse-0.10.4}/plugins/yjs/fps_yjs/main.py

@@ -27,7 +27,7 @@ class YjsModule(Module):
         file_id = await self.get(FileId)  # type: ignore[type-abstract]
         lifespan = await self.get(Lifespan)
 
-        self.yjs = _Yjs(app, auth, contents, file_id, lifespan)
+        self.yjs = _Yjs(app, auth, contents, file_id, lifespan, self.config)
 
         async with create_task_group() as tg:
             await tg.start(self.yjs.start)

{jupyverse-0.10.2 → jupyverse-0.10.4}/plugins/yjs/fps_yjs/routes.py

@@ -25,7 +25,7 @@ from jupyverse_api.auth import Auth, User
 from jupyverse_api.contents import Contents
 from jupyverse_api.file_id import FileId
 from jupyverse_api.main import Lifespan
-from jupyverse_api.yjs import Yjs
+from jupyverse_api.yjs import Yjs, YjsConfig
 from jupyverse_api.yjs.models import CreateDocumentSession
 
 from .ywebsocket.websocket import Websocket
@@ -51,11 +51,13 @@ class _Yjs(Yjs):
         contents: Contents,
         file_id: FileId,
         lifespan: Lifespan,
+        config: YjsConfig,
     ) -> None:
         super().__init__(app=app, auth=auth)
         self.contents = contents
         self.file_id = file_id
         self.lifespan = lifespan
+        self.config = config
         if Widgets is None:
             self.widgets = None
         else:
@@ -63,7 +65,7 @@ class _Yjs(Yjs):
 
     async def start(self, *, task_status: TaskStatus[None] = TASK_STATUS_IGNORED) -> None:
         async with create_task_group() as tg:
-            self.room_manager = RoomManager(self.contents, self.file_id, self.lifespan)
+            self.room_manager = RoomManager(self.contents, self.file_id, self.lifespan, self.config)
             tg.start_soon(self.room_manager.start)
             task_status.started()
 
@@ -166,7 +168,7 @@ class RoomManager:
     room_write_permissions: dict[str, set[YWebsocket]]
     room_lock: ResourceLock
 
-    def __init__(self, contents: Contents, file_id: FileId, lifespan: Lifespan):
+    def __init__(self, contents: Contents, file_id: FileId, lifespan: Lifespan, config: YjsConfig):
         self.contents = contents
         self.file_id = file_id
         self.lifespan = lifespan
@@ -178,6 +180,7 @@ class RoomManager:
         self.room_write_permissions = {}  # a dictionary of room_name:websockets that can write
         self.websocket_server = JupyterWebsocketServer(rooms_ready=False, auto_clean_rooms=False)
         self.room_lock = ResourceLock()
+        self.config = config
 
     async def start(self):
         async with create_task_group() as self.task_group:
@@ -364,8 +367,8 @@ class RoomManager:
     async def maybe_save_document(
         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 sleep(1)  # FIXME: pass in config
+        # save after configured delay to prevent too frequent saving
+        await sleep(self.config.document_save_delay)
         # if the room cannot be found, don't save
         try:
             file_path = await self.get_file_path(file_id, document)
@@ -401,7 +404,7 @@ class RoomManager:
     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 sleep(60)  # FIXME: pass in config
+        await sleep(self.config.document_cleanup_delay)
         document = self.documents[ws_path]
         document.unobserve()
         del self.documents[ws_path]

{jupyverse-0.10.2 → jupyverse-0.10.4}/plugins/yjs/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fps_yjs"
-version = "0.10.0"
+version = "0.10.1"
 description = "An FPS plugin for the Yjs API"
 keywords = [ "jupyter", "server", "fastapi", "plugins" ]
 requires-python = ">=3.9"

{jupyverse-0.10.2 → jupyverse-0.10.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "jupyverse"
-version = "0.10.2"
+version = "0.10.4"
 description = "A set of FPS plugins implementing a Jupyter server"
 keywords = ["jupyter", "server", "fastapi", "plugins"]
 requires-python = ">=3.9"
@@ -12,14 +12,14 @@ dependencies = [
     "fps[click,fastapi,anycorn] >=0.4.0,<0.5.0",
     "fps-contents >=0.10.0,<0.11.0",
     "fps-file-id >=0.2.0,<0.3.0",
-    "fps-kernel-subprocess >=0.1.0,<0.2.0",
+    "fps-kernel-subprocess >=0.1.1,<0.2.0",
     "fps-kernels >=0.9.1,<0.10.0",
     "fps-terminals >=0.9.0,<0.10.0",
     "fps-nbconvert >=0.9.0,<0.10.0",
-    "fps-yjs >=0.10.0,<0.11.0",
+    "fps-yjs >=0.10.1,<0.11.0",
     "fps-lab >=0.9.0,<0.10.0",
     "fps-frontend >=0.9.0,<0.10.0",
-    "jupyverse-api >=0.10.0,<0.11.0",
+    "jupyverse-api >=0.10.1,<0.11.0",
     "rich-click >=1.6.1,<2",
     "eval-type-backport; python_version<'3.10'",
 ]
@@ -73,6 +73,7 @@ pre-install-commands = [
   "pip install -e ./plugins/file_id",
   "pip install -e ./plugins/frontend",
   "pip install -e ./plugins/kernel_subprocess",
+  "pip install -e ./plugins/kernel_web_worker",
   "pip install -e ./plugins/kernels[watchfiles]",
   "pip install -e ./plugins/lab",
   "pip install -e ./plugins/nbconvert",
@@ -123,6 +124,7 @@ typecheck0 = """mypy --no-incremental \
 ./plugins/file_id \
 ./plugins/frontend \
 ./plugins/kernel_subprocess \
+./plugins/kernel_web_worker \
 ./plugins/kernels \
 ./plugins/lab \
 ./plugins/nbconvert \
@@ -178,6 +180,7 @@ fps-file_id = { workspace = true }
 fps-frontend = { workspace = true }
 fps-jupyterlab = { workspace = true }
 fps-kernel-subprocess = { workspace = true }
+fps-kernel-web-worker = { workspace = true }
 fps-kernels = { workspace = true }
 fps-lab = { workspace = true }
 fps-login = { workspace = true }