doweb 0.0.1__py3-none-any.whl

doweb/__init__.py

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

doweb/api/browser.py

@@ -0,0 +1,37 @@
+from itertools import chain
+from pathlib import Path
+
+from fastapi import APIRouter, Request
+from fastapi.responses import HTMLResponse
+from fastapi.templating import Jinja2Templates
+from starlette.templating import _TemplateResponse
+
+from ..config import Config
+
+# from . import __version__ as version
+
+router = APIRouter()
+templates = Jinja2Templates(
+    directory=(Path(__file__).parent.parent / "templates").resolve()
+)
+
+
+@router.get("/", response_class=HTMLResponse)
+async def file_browser(
+    request: Request,
+) -> _TemplateResponse:
+    settings: Config = router.dependencies[0].dependency()  # type: ignore[misc]
+    files = chain(
+        settings.fileslocation.glob("**/*.gds"), settings.fileslocation.glob("**/*.oas")
+    )
+    return templates.TemplateResponse(
+        "browser.html",
+        {
+            "request": request,
+            "folder_files": [
+                file.relative_to(settings.fileslocation) for file in files
+            ],
+            "page_name": f"File Browser    Root: {settings.fileslocation}",
+            "root": settings.fileslocation,
+        },
+    )

doweb/api/viewer.py

@@ -0,0 +1,82 @@
+from pathlib import Path
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, Request
+from fastapi.exceptions import HTTPException
+from fastapi.responses import HTMLResponse
+from fastapi.templating import Jinja2Templates
+from pydantic import BaseModel
+from starlette.templating import _TemplateResponse
+
+from .. import __version__ as version
+
+router = APIRouter()
+templates = Jinja2Templates(
+    directory=(Path(__file__).parent.parent / "templates").resolve()
+)
+
+
+class FileView(BaseModel):
+    file: Path
+    cell: str | None = None
+    layer_props: str | None = None
+    rdb: str | None = None
+
+
+@router.get("/view", response_class=HTMLResponse)
+async def file_view_static(
+    request: Request, params: Annotated[FileView, Depends()]
+) -> _TemplateResponse:
+    settings = router.dependencies[0].dependency()  # type: ignore[misc]
+    _file = settings.fileslocation / f"{params.file}"
+
+    exists = _file.is_file() and _file.stat().st_mode
+
+    if not exists:
+        raise HTTPException(
+            status_code=404,
+            detail=f'No file found with name "{_file}".'
+            " It doesn't exist or is not accessible",
+        )
+
+    return await show_file(request, layout_params=params)
+
+
+async def show_file(request: Request, layout_params: FileView) -> _TemplateResponse:
+    root_path = request.scope["root_path"]
+
+    match request.url.scheme:
+        case "https":
+            ws_scheme = "wss://"
+        case "http":
+            ws_scheme = "ws://"
+        case other:
+            raise HTTPException(status_code=406, detail=f"Unknown scheme {other}")
+
+    if request.url.port is not None:
+        url = (
+            ws_scheme
+            + (request.url.hostname or "localhost")
+            + ":"
+            + str(request.url.port)
+            + root_path
+        )
+    else:
+        url = ws_scheme + (request.url.hostname or "localhost") + root_path
+
+    template_params = {
+        "request": request,
+        "url": url,
+    }
+
+    template_params["params"] = layout_params.model_dump(mode="json", exclude_none=True)
+
+    return templates.TemplateResponse(
+        "viewer.html",
+        template_params,
+    )
+
+
+@router.get("/status")
+async def doweb_status() -> dict[str, str | int]:
+    return {"server": "doweb", "version": version}

doweb/browser.py

@@ -0,0 +1,55 @@
+from pathlib import Path
+
+from fastapi import Depends, FastAPI
+from fastapi.staticfiles import StaticFiles
+from pydantic import ValidationError
+
+from . import config
+from .api.browser import router as browser_router
+from .api.viewer import router as viewer_router
+from .layout_server import LayoutViewServerEndpoint
+
+
+def get_app(fileslocation: Path | str | None = None, editable: bool = False) -> FastAPI:
+    if fileslocation is None:
+        try:
+            _settings = config.Config()
+        except ValidationError:
+            raise ValueError(
+                "To start the Kweb please set the environment "
+                "variable DOWEB_FILESLOCATION to a path in your filesystem."
+                " Alternatively, you can set the filepath in the get_app function."
+            )
+
+    else:
+        _settings = config.Config(fileslocation=fileslocation, editable=editable)
+
+    def settings() -> config.Config:
+        return _settings
+
+    staticfiles = StaticFiles(directory=Path(__file__).parent / "static")
+
+    # app = FastAPI(routes=[WebSocketRoute("/ws", endpoint=LayoutViewServerEndpoint)])
+
+    app = FastAPI()
+    viewer_router.dependencies.insert(0, Depends(settings))
+    browser_router.dependencies.insert(0, Depends(settings))
+
+    _settings = settings()
+
+    class BrowserLayoutViewServerEndpoint(
+        LayoutViewServerEndpoint,
+        root=_settings.fileslocation,
+        editable=editable,
+        add_missing_layers=_settings.add_missing_layers,
+        meta_splitter=_settings.meta_splitter,
+    ):
+        pass
+
+    app.add_websocket_route("/ws", BrowserLayoutViewServerEndpoint)
+    viewer_router.dependencies.insert(0, Depends(settings))
+    app.include_router(viewer_router)
+    app.include_router(browser_router)
+    app.mount("/static", staticfiles, name="doweb_static")
+
+    return app

doweb/config.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import pydantic
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class Config(BaseSettings):
+    model_config = SettingsConfigDict(env_prefix="doweb_", env_nested_delimiter="_")
+    fileslocation: Path
+    meta_splitter: str = ":"
+    editable: bool = False
+    add_missing_layers: bool = True
+    max_rdb_limit: int = 100
+    """Maximum rdb errors the client can request."""
+
+    @pydantic.field_validator("fileslocation")
+    @classmethod
+    def resolvefileslocation(cls, v: Path | str) -> Path:
+        return Path(v).expanduser().resolve()

doweb/default.py

@@ -0,0 +1,3 @@
+from doweb.browser import get_app
+
+app = get_app()