jupyverse 0.6.3__tar.gz → 0.7.0__tar.gz

{jupyverse-0.6.3 → jupyverse-0.7.0}/.devcontainer/requirements.txt

@@ -7,7 +7,6 @@
 ./plugins/nbconvert
 ./plugins/terminals
 ./plugins/yjs
-fps[unicorn] >=0.0.10
+fps >=0.1.1
 mypy
 pytest
-pytest-asyncio

{jupyverse-0.6.3 → jupyverse-0.7.0}/.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
       uses: actions/checkout@v3
     - uses: actions/setup-python@v4
       with:
-        python-version: '3.12'
+        python-version: '3.13'
         cache: 'pip'
     - name: Install hatch
       run: |
@@ -43,13 +43,13 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
+        python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13' ]
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
         cache: 'pip'

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

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
       - id: check-case-conflict
@@ -16,7 +16,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.8
+    rev: v0.7.1
     hooks:
       - id: ruff
         args: ["--fix"]

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

@@ -2,6 +2,37 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 0.7.0
+
+([Full Changelog](https://github.com/jupyter-server/jupyverse/compare/v0.6.4...6fe98eab9ef0cef9d77a49bed92829ae3fb3538c))
+
+### Merged PRs
+
+- Switch to FPS [#453](https://github.com/jupyter-server/jupyverse/pull/453) ([@davidbrochart](https://github.com/davidbrochart))
+- Fixing typo in the documentation [#452](https://github.com/jupyter-server/jupyverse/pull/452) ([@ThePavolC](https://github.com/ThePavolC))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter-server/jupyverse/graphs/contributors?from=2024-10-15&to=2025-02-14&type=c))
+
+[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Adavidbrochart+updated%3A2024-10-15..2025-02-14&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Apre-commit-ci+updated%3A2024-10-15..2025-02-14&type=Issues) | [@ThePavolC](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3AThePavolC+updated%3A2024-10-15..2025-02-14&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 0.6.4
+
+([Full Changelog](https://github.com/jupyter-server/jupyverse/compare/v0.6.3...69394c087d0645c784ff14e3cb71557c7a0d5cfa))
+
+### Merged PRs
+
+- Fix nbconvert file save mode [#446](https://github.com/jupyter-server/jupyverse/pull/446) ([@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-10-02&to=2024-10-15&type=c))
+
+[@davidbrochart](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Adavidbrochart+updated%3A2024-10-02..2024-10-15&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter-server%2Fjupyverse+involves%3Apre-commit-ci+updated%3A2024-10-02..2024-10-15&type=Issues)
+
 ## 0.6.3
 
 ([Full Changelog](https://github.com/jupyter-server/jupyverse/compare/v0.6.2...aa6854a51665d95216340d7fda1ba111af6aef74))
@@ -16,8 +47,6 @@
 
 [@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))

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

@@ -1,13 +1,13 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: jupyverse
-Version: 0.6.3
+Version: 0.7.0
 Summary: A set of FPS plugins implementing a Jupyter server
 Project-URL: Homepage, https://jupyter.org
 Author-email: Jupyter Development Team <jupyter@googlegroups.com>
 License: BSD 3-Clause License
 License-File: COPYING.md
 Keywords: fastapi,jupyter,plugins,server
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: fps-contents<1,>=0.1.2
 Requires-Dist: fps-frontend<1,>=0.1.2
 Requires-Dist: fps-kernels<1,>=0.1.2
@@ -38,14 +38,13 @@ Requires-Dist: httpx-ws>=0.4.1; extra == 'test'
 Requires-Dist: ipykernel; extra == 'test'
 Requires-Dist: mypy; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
-Requires-Dist: pytest-asyncio; extra == 'test'
 Requires-Dist: pytest-env; extra == 'test'
 Requires-Dist: pytest-rerunfailures; extra == 'test'
 Requires-Dist: pytest-timeout; extra == 'test'
 Requires-Dist: requests; extra == 'test'
 Requires-Dist: ruff>=0.1.2; extra == 'test'
+Requires-Dist: trio; extra == 'test'
 Requires-Dist: types-setuptools; extra == 'test'
-Requires-Dist: websockets; extra == 'test'
 Requires-Dist: ypywidgets-textual<0.6.0,>=0.5.0; extra == 'test'
 Requires-Dist: ypywidgets<0.10.0,>=0.9.3; extra == 'test'
 Description-Content-Type: text/markdown

jupyverse-0.7.0/jupyverse/__init__.py

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

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

@@ -1,10 +1,11 @@
-from typing import Dict
+from typing import Any, Dict
 
+from anyio import Event
 from pydantic import BaseModel
 
 from .app import App
 
-__version__ = "0.6.3"
+__version__ = "0.7.0"
 
 
 class Singleton(type):
@@ -41,3 +42,36 @@ class Router:
 
     def add_middleware(self, middleware, *args, **kwargs) -> None:
         self._app.add_middleware(middleware, *args, **kwargs)
+
+
+class ResourceLock:
+    """ResourceLock ensures that accesses cannot be done concurrently on the same resource.
+    """
+    _locks: Dict[Any, Event]
+
+    def __init__(self):
+        self._locks = {}
+
+    def __call__(self, idx: Any):
+        return _ResourceLock(idx, self._locks)
+
+
+class _ResourceLock:
+    _idx: Any
+    _locks: Dict[Any, Event]
+    _lock: Event
+
+    def __init__(self, idx: Any, locks: Dict[Any, Event]):
+        self._idx = idx
+        self._locks = locks
+
+    async def __aenter__(self):
+        while True:
+            if self._idx not in self._locks:
+                break
+            await self._locks[self._idx].wait()
+        self._locks[self._idx] = self._lock = Event()
+
+    async def __aexit__(self, exc_type, exc_value, exc_tb):
+        self._lock.set()
+        del self._locks[self._idx]

{jupyverse-0.6.3 → jupyverse-0.7.0}/jupyverse_api/jupyverse_api/app/__init__.py

@@ -1,15 +1,15 @@
 from __future__ import annotations
 
-import logging
 from collections import defaultdict
 from datetime import datetime, timezone
 from typing import Dict, List
 
+import structlog
 from fastapi import FastAPI, Request
 
 from ..exceptions import RedirectException, _redirect_exception_handler
 
-logger = logging.getLogger("app")
+logger = structlog.get_logger()
 
 
 class App:
@@ -57,7 +57,7 @@ class App:
                         f"{_type} adds a handler for a path that is already defined in "
                         f"{_router}: {path}"
                     )
-            logger.debug("%s added handler for path: %s", _type, path)
+            logger.debug("Handler added", type=_type, path=path)
             new_paths.append(path)
         self._router_paths[_type].extend(new_paths)
         self._app.include_router(router, **kwargs)
@@ -69,7 +69,7 @@ class App:
                     f"{_type } mounts a path that is already defined in {_router}: {path}"
                 )
         self._router_paths[_type].append(path)
-        logger.debug("%s mounted path: %s", _type, path)
+        logger.debug("Path mounted", type=_type, path=path)
         self._app.mount(path, *args, **kwargs)
 
     def add_middleware(self, middleware, *args, **kwargs) -> None:

{jupyverse-0.6.3 → jupyverse-0.7.0}/jupyverse_api/jupyverse_api/auth/__init__.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, List, Optional, Tuple
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Tuple
 
 from jupyverse_api import Config
 
@@ -19,7 +19,7 @@ class Auth(ABC):
     def websocket_auth(
         self,
         permissions: Optional[Dict[str, List[str]]] = None,
-    ) -> Callable[[], Tuple[Any, Dict[str, List[str]]]]:
+    ) -> Callable[[Any], Awaitable[Optional[Tuple[Any, Optional[Dict[str, List[str]]]]]]]:
         ...
 
 

jupyverse-0.7.0/jupyverse_api/jupyverse_api/cli.py

@@ -0,0 +1,115 @@
+import io
+import json
+import sys
+from typing import Any, List, Tuple
+
+import rich_click as click
+from fps import main as fps_main
+
+if sys.version_info < (3, 10):
+    from importlib_metadata import entry_points
+else:
+    from importlib.metadata import entry_points
+
+
+@click.command()  # type: ignore
+@click.option(
+    "--debug",
+    is_flag=True,
+    show_default=True,
+    default=False,
+    help="Enable debug mode.",
+)
+@click.option(
+    "--open-browser",
+    is_flag=True,
+    show_default=True,
+    default=False,
+    help="Open a browser window.",
+)
+@click.option(
+    "--host",
+    type=str,
+    default="127.0.0.1",
+    help="The host URL.",
+)
+@click.option(
+    "--port",
+    type=int,
+    default=8000,
+    help="The host port.",
+)
+@click.option(
+    "--query-param",
+    multiple=True,
+    type=str,
+    help='The query parameter key and value, separated by "=".',
+)
+@click.option(
+    "--allow-origin",
+    multiple=True,
+    type=str,
+    help="The origin to allow.",
+)
+@click.option(
+    "--set",
+    "set_",
+    multiple=True,
+    type=str,
+    help="Set configuration.",
+)
+@click.option(
+    "--disable",
+    multiple=True,
+    type=str,
+    help="Disable plugin.",
+)
+def main(
+    debug: bool = False,
+    open_browser: bool = False,
+    host: str = "127.0.0.1",
+    port: int = 8000,
+    set_: Tuple[str, ...] = (),
+    disable: Tuple[str, ...] = (),
+    allow_origin: Tuple[str, ...] = (),
+    query_param: Tuple[str, ...] = (),
+) -> None:
+    query_params_dict = {}
+    for qp in query_param:
+        key, _, value = qp.partition("=")
+        query_params_dict[key] = value
+    query_params_str = json.dumps(query_params_dict)
+    allow_origins_str = json.dumps(allow_origin)
+    set_list: List[str] = list(set_)
+    set_list.append(f"debug={debug}")
+    set_list.append(f"open_browser={open_browser}")
+    set_list.append(f"host={host}")
+    set_list.append(f"port={port}")
+    set_list.append(f"allow_origins={allow_origins_str}")
+    set_list.append(f"query_params={query_params_str}")
+    pluggin_config = io.StringIO(json.dumps(get_pluggin_config(disable)))
+    fps_main.callback(
+        "",
+        set_=set_list,
+        config=pluggin_config,
+    )  # type: ignore
+
+
+def get_pluggin_config(disable: Tuple[str, ...]) -> dict[str, Any]:
+    jupyverse_modules = [
+        ep.name
+        for ep in entry_points(group="jupyverse.modules")
+        if ep.name not in disable
+    ]
+    config = {
+        "jupyverse": {
+            "type":"jupyverse_api.main:JupyverseModule",
+            "modules": {
+                module: {
+                    "type": module
+                }
+                for module in jupyverse_modules
+            }
+        }
+    }
+    return config

{jupyverse-0.6.3 → jupyverse-0.7.0}/jupyverse_api/jupyverse_api/contents/__init__.py

@@ -1,11 +1,12 @@
-import asyncio
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import Dict, List, Optional, Union
 
 from fastapi import APIRouter, Depends, Request, Response
 
-from jupyverse_api import Router
+from jupyverse_api import ResourceLock, Router
 
 from ..app import App
 from ..auth import Auth, User
@@ -13,8 +14,13 @@ from .models import Checkpoint, Content, SaveContent
 
 
 class FileIdManager(ABC):
-    stop_watching_files: asyncio.Event
-    stopped_watching_files: asyncio.Event
+    @abstractmethod
+    async def start(self) -> None:
+        ...
+
+    @abstractmethod
+    async def stop(self) -> None:
+        ...
 
     @abstractmethod
     async def get_path(self, file_id: str) -> str:
@@ -32,9 +38,11 @@ class FileIdManager(ABC):
 
 
 class Contents(Router, ABC):
+    file_lock: ResourceLock
+
     def __init__(self, app: App, auth: Auth):
         super().__init__(app=app)
-
+        self.file_lock = ResourceLock()
         router = APIRouter()
 
         @router.post(

jupyverse-0.7.0/jupyverse_api/jupyverse_api/main/__init__.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+import logging
+import webbrowser
+from typing import Dict, List
+
+import structlog
+from anyio import Event, create_task_group
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from fps import Module
+from fps.web.fastapi import FastAPIModule
+from pydantic import BaseModel, Json
+
+from jupyverse_api import Config
+
+from ..app import App
+
+logger = structlog.get_logger()
+
+
+class AppModule(Module):
+    def __init__(
+        self,
+        name: str,
+        *,
+        mount_path: str | None = None,
+    ) -> None:
+        super().__init__(name)
+        self.mount_path = mount_path
+
+    async def prepare(self) -> None:
+        app = await self.get(FastAPI)
+        _app = App(app, mount_path=self.mount_path)
+        self.put(_app)
+
+
+class JupyverseModule(FastAPIModule):
+    def __init__(self, name: str, **kwargs) -> None:
+        self.jupyverse_config = JupyverseConfig(**kwargs)
+        if self.jupyverse_config.debug:
+            structlog.stdlib.recreate_defaults(log_level=logging.DEBUG)
+        super().__init__(
+            name,
+            host=self.jupyverse_config.host,
+            port=self.jupyverse_config.port,
+            debug=self.jupyverse_config.debug,
+        )
+        self.lifespan = Lifespan()
+
+    async def prepare(self) -> None:
+        await super().prepare()
+        app = await self.get(App)
+        if self.jupyverse_config.allow_origins:
+            app.add_middleware(
+                CORSMiddleware,
+                allow_origins=self.jupyverse_config.allow_origins,
+                allow_credentials=True,
+                allow_methods=["*"],
+                allow_headers=["*"],
+            )
+        self._query_params = QueryParams(d={})
+        self._host = self.jupyverse_config.host
+        if not self._host.startswith("http"):
+            self._host = f"http://{self._host}"
+        self._port = self.jupyverse_config.port
+        host_url = Host(url=f"{self._host}:{self._port}/")
+        self.put(self._query_params)
+        self.put(host_url)
+        self.put(self.lifespan)
+
+    async def start(self) -> None:
+        async with create_task_group() as tg:
+            tg.start_soon(super().start)
+            await self.started.wait()
+
+            # at this point, the server has started
+            qp = self._query_params.d
+            if self.jupyverse_config.query_params:
+                qp.update(**self.jupyverse_config.query_params)
+            query_params_str = "?" + "&".join([f"{k}={v}" for k, v in qp.items()]) if qp else ""
+            url = f"{self._host}:{self._port}{query_params_str}"
+            logger.info("Server running", url=url)
+            if self.jupyverse_config.open_browser:
+                webbrowser.open_new_tab(url)
+
+    async def stop(self) -> None:
+        self.lifespan.shutdown_request.set()
+
+
+class QueryParams(BaseModel):
+    d: Dict[str, str]
+
+
+class Host(BaseModel):
+    url: str
+
+
+class Lifespan:
+    def __init__(self):
+        self.shutdown_request = Event()
+
+
+class JupyverseConfig(Config):
+    host: str = "127.0.0.1"
+    port: int = 8000
+    allow_origins: Json[List[str]] = []
+    open_browser: bool = False
+    query_params: Json[Dict[str, str]] = {}
+    debug: bool = False

{jupyverse-0.6.3 → jupyverse-0.7.0}/jupyverse_api/jupyverse_api/terminals/__init__.py

@@ -83,5 +83,5 @@ class TerminalServer(ABC):
         ...
 
     @abstractmethod
-    async def exit(self):
+    def quit(self, websocket):
         ...

{jupyverse-0.6.3 → jupyverse-0.7.0}/jupyverse_api/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "jupyverse_api"
 description = "The public API for Jupyverse"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 keywords = [
   "jupyverse", "api",
 ]
@@ -16,10 +16,11 @@ authors = [
 classifiers = [
   "Development Status :: 4 - Beta",
   "Programming Language :: Python",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -28,8 +29,7 @@ dependencies = [
   "pydantic >=2,<3",
   "fastapi >=0.95.0,<1",
   "rich-click >=1.6.1,<2",
-  "asphalt >=4.11.0,<5",
-  "asphalt-web[fastapi] >=1.1.0,<2",
+  "fps[web] >=0.1.1,<0.2.0",
 ]
 dynamic = ["version"]
 
@@ -42,12 +42,12 @@ Source = "https://github.com/jupyter-server/jupyverse/jupyverse_api"
 [project.scripts]
 jupyverse = "jupyverse_api.cli:main"
 
-[project.entry-points."asphalt.components"]
-app = "jupyverse_api.main:AppComponent"
-jupyverse = "jupyverse_api.main:JupyverseComponent"
+[project.entry-points."fps.modules"]
+app = "jupyverse_api.main:AppModule"
+jupyverse = "jupyverse_api.main:JupyverseModule"
 
-[project.entry-points."jupyverse.components"]
-app = "jupyverse_api.main:AppComponent"
+[project.entry-points."jupyverse.modules"]
+app = "jupyverse_api.main:AppModule"
 
 [tool.hatch.version]
 path = "jupyverse_api/__init__.py"

jupyverse-0.7.0/jupyverse_api/tests/test_resource_lock.py

@@ -0,0 +1,57 @@
+import pytest
+from anyio import create_task_group, sleep
+
+from jupyverse_api import ResourceLock
+
+pytestmark = pytest.mark.anyio
+
+
+async def do_op(operation, resource_lock, operations):
+    op, path = operation
+    async with resource_lock(path):
+        operations.append(operation + ["start"])
+        await sleep(0.1)
+        operations.append(operation + ["done"])
+
+
+async def test_resource_lock():
+    resource_lock = ResourceLock()
+
+    # test concurrent accesses to the same resource
+    idx = "idx"
+    operations = []
+    async with create_task_group() as tg:
+        tg.start_soon(do_op, [0, idx], resource_lock, operations)
+        await sleep(0.01)
+        tg.start_soon(do_op, [1, idx], resource_lock, operations)
+
+    assert operations == [
+        [0, idx, "start"],
+        [0, idx, "done"],
+        [1, idx, "start"],
+        [1, idx, "done"],
+    ]
+
+    # test concurrent accesses to different files
+    idx0 = "idx0"
+    idx1 = "idx1"
+    operations = []
+    async with create_task_group() as tg:
+        tg.start_soon(do_op, [0, idx0], resource_lock, operations)
+        await sleep(0.01)
+        tg.start_soon(do_op, [1, idx1], resource_lock, operations)
+        await sleep(0.01)
+        tg.start_soon(do_op, [2, idx0], resource_lock, operations)
+        await sleep(0.01)
+        tg.start_soon(do_op, [3, idx1], resource_lock, operations)
+
+    assert operations == [
+        [0, idx0, "start"],
+        [1, idx1, "start"],
+        [0, idx0, "done"],
+        [2, idx0, "start"],
+        [1, idx1, "done"],
+        [3, idx1, "start"],
+        [2, idx0, "done"],
+        [3, idx1, "done"],
+    ]

{jupyverse-0.6.3 → jupyverse-0.7.0}/mkdocs.yml

@@ -35,7 +35,7 @@ nav:
   - usage/single_user.md
   - usage/multi_user.md
   - usage/microservices.md
-- Turorials:
+- Tutorials:
   - tutorials/standalone_jupyverse_deployment.md
   - tutorials/jupyterhub_jupyverse_deployment.md
 - Plugins:

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

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

{jupyverse-0.6.3 → jupyverse-0.7.0}/plugins/auth/fps_auth/backends.py

@@ -1,4 +1,3 @@
-import logging
 import uuid
 from dataclasses import dataclass
 from typing import Any, Dict, Generic, List, Optional, Tuple, cast
@@ -29,8 +28,6 @@ from .config import _AuthConfig
 from .db import User
 from .models import UserCreate, UserRead
 
-logger = logging.getLogger("auth")
-
 
 @dataclass
 class Res:

{jupyverse-0.6.3 → jupyverse-0.7.0}/plugins/auth/fps_auth/db.py

@@ -1,4 +1,3 @@
-import logging
 import secrets
 from dataclasses import dataclass
 from pathlib import Path
@@ -16,8 +15,6 @@ from sqlalchemy.orm import DeclarativeBase, Mapped, relationship
 
 from .config import _AuthConfig
 
-logger = logging.getLogger("auth")
-
 
 class Base(AsyncAttrs, DeclarativeBase):
     pass