pyview-web 0.0.6a0__tar.gz → 0.0.7a0__tar.gz

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyview-web
-Version: 0.0.6a0
+Version: 0.0.7a0
 Summary: LiveView in Python
 Home-page: https://pyview.rocks
 License: MIT
@@ -79,7 +79,7 @@ class CountContext(TypedDict):
 
 
 class CountLiveView(LiveView[CountContext]):
-    async def mount(self, socket: LiveViewSocket[CountContext]):
+    async def mount(self, socket: LiveViewSocket[CountContext], _session):
         socket.context = {"count": 0}
 
     async def handle_event(self, event, payload, socket: LiveViewSocket[CountContext]):

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/pyproject.toml

@@ -5,7 +5,7 @@ packages = [
   { include = "pyview" },
 ]
 
-version = "0.0.6a"
+version = "0.0.7a"
 description = "LiveView in Python"
 authors = ["Larry Ogrodnek <ogrodnek@gmail.com>"]
 license = "MIT"

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/pyview/csrf.py

@@ -1,15 +1,14 @@
 from itsdangerous import BadData, SignatureExpired, URLSafeTimedSerializer
-import secrets
 from typing import Optional
 import hmac
-import os
+from pyview.secret import get_secret
 
 
 def generate_csrf_token(value: str, salt: Optional[str] = None) -> str:
     """
     Generate a CSRF token.
     """
-    s = URLSafeTimedSerializer(_get_secret(), salt=salt or "pyview-csrf-token")
+    s = URLSafeTimedSerializer(get_secret(), salt=salt or "pyview-csrf-token")
     return s.dumps(value)  # type: ignore
 
 
@@ -17,27 +16,10 @@ def validate_csrf_token(data: str, expected: str, salt: Optional[str] = None) ->
     """
     Validate a CSRF token.
     """
-    s = URLSafeTimedSerializer(_get_secret(), salt=salt or "pyview-csrf-token")
+    s = URLSafeTimedSerializer(get_secret(), salt=salt or "pyview-csrf-token")
     try:
         token = s.loads(data, max_age=3600)
         return hmac.compare_digest(token, expected)
     except (BadData, SignatureExpired) as e:
         print(e)
         return False
-
-
-_SECRET = None
-
-
-def _get_secret() -> str:
-    """
-    Get the secret key from the environment, or generate a new one.
-    """
-    global _SECRET
-    if _SECRET is None:
-        secret = os.environ.get("PYVIEW_SECRET")
-        if secret is None:
-            secret = secrets.token_urlsafe(16)
-        _SECRET = secret
-
-    return _SECRET

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/pyview/live_view.py

@@ -1,4 +1,4 @@
-from typing import TypeVar, Generic, Optional, Union
+from typing import TypeVar, Generic, Optional, Union, Any
 from .live_socket import LiveViewSocket, UnconnectedSocket
 from pyview.template import LiveTemplate, template_file, RenderedContent, LiveRender
 import inspect
@@ -7,13 +7,14 @@ from pyview.events import InfoEvent
 T = TypeVar("T")
 
 AnySocket = Union[LiveViewSocket[T], UnconnectedSocket[T]]
+Session = dict[str, Any]
 
 
 class LiveView(Generic[T]):
     def __init__(self):
         pass
 
-    async def mount(self, socket: AnySocket):
+    async def mount(self, socket: AnySocket, session: Session):
         pass
 
     async def handle_event(self, event, payload, socket: LiveViewSocket[T]):

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/pyview/pyview.py

@@ -2,12 +2,16 @@ from starlette.applications import Starlette
 from fastapi import WebSocket
 from fastapi.responses import HTMLResponse
 from starlette.middleware.gzip import GZipMiddleware
+from starlette.middleware.sessions import SessionMiddleware
 from starlette.routing import Route
+from starlette.requests import Request
 import uuid
 from urllib.parse import parse_qs
 
 from pyview.live_socket import UnconnectedSocket
 from pyview.csrf import generate_csrf_token
+from pyview.session import serialize_session
+from pyview.secret import get_secret
 from .ws_handler import LiveSocketHandler
 from .live_view import LiveView
 from .live_routes import LiveViewLookup
@@ -20,6 +24,7 @@ class RootTemplateContext(TypedDict):
     title: Optional[str]
     css: Optional[str]
     csrf_token: str
+    session: Optional[str]
 
 
 RootTemplate = Callable[[RootTemplateContext], str]
@@ -39,25 +44,25 @@ class PyView(Starlette):
 
         self.add_websocket_route("/live/websocket", live_websocket_endpoint)
         self.add_middleware(GZipMiddleware)
+        # self.add_middleware(SessionMiddleware, secret_key=get_secret())
 
     def add_live_view(self, path: str, view: Callable[[], LiveView]):
-        async def lv(request):
-            return await liveview_container(
-                self.rootTemplate, self.view_lookup, request
-            )
+        async def lv(request: Request):
+            return await liveview_container(self.rootTemplate, self.view_lookup, request)
 
         self.view_lookup.add(path, view)
         self.routes.append(Route(path, lv, methods=["GET"]))
 
 
-async def liveview_container(
-    template: RootTemplate, view_lookup: LiveViewLookup, request
-):
+async def liveview_container(template: RootTemplate, view_lookup: LiveViewLookup, request: Request):
     url = request.url
     path = url.path
     lv: LiveView = view_lookup.get(path)
     s = UnconnectedSocket()
-    await lv.mount(s)
+
+    session = request.session if "session" in request.scope else {}
+
+    await lv.mount(s, session)
     await lv.handle_params(url, parse_qs(url.query), s)
     r = await lv.render(s.context)
 
@@ -69,6 +74,7 @@ async def liveview_container(
         "title": s.live_title,
         "csrf_token": generate_csrf_token("lv:phx-" + id),
         "css": None,
+        "session": serialize_session(session),
     }
 
     return HTMLResponse(template(context))
@@ -84,11 +90,7 @@ def defaultRootTemplate(css: str) -> RootTemplate:
 
 def _defaultRootTemplate(context: RootTemplateContext) -> str:
     suffix = " | LiveView"
-    render_title = (
-        (context["title"] + suffix)  # type: ignore
-        if context.get("title", None) is not None
-        else "LiveView"
-    )
+    render_title = (context["title"] + suffix) if context.get("title", None) is not None else "LiveView"  # type: ignore
     css = context["css"] if context.get("css", None) is not None else ""
     return f"""
 <!DOCTYPE html>
@@ -107,7 +109,7 @@ def _defaultRootTemplate(context: RootTemplateContext) -> str:
       <a href="/">Home</a>
       <div
         data-phx-main="true"
-        data-phx-session=""
+        data-phx-session="{context['session']}"
         data-phx-static=""
         id="phx-{context['id']}"
         >

pyview_web-0.0.7a0/pyview/secret.py

@@ -0,0 +1,18 @@
+import os
+import secrets
+
+_SECRET = None
+
+
+def get_secret() -> str:
+    """
+    Get the secret key from the environment, or generate a new one.
+    """
+    global _SECRET
+    if _SECRET is None:
+        secret = os.environ.get("PYVIEW_SECRET")
+        if secret is None:
+            secret = secrets.token_urlsafe(16)
+        _SECRET = secret
+
+    return _SECRET

pyview_web-0.0.7a0/pyview/session.py

@@ -0,0 +1,13 @@
+from typing import Any, cast
+from itsdangerous import URLSafeSerializer
+from pyview.secret import get_secret
+
+
+def serialize_session(session: dict[str, Any]) -> str:
+    s = URLSafeSerializer(get_secret(), salt="pyview-session")
+    return cast(str, s.dumps(session))
+
+
+def deserialize_session(ser: str) -> dict[str, Any]:
+    s = URLSafeSerializer(get_secret(), salt="pyview-session")
+    return cast(dict[str, Any], s.loads(ser))

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/pyview/ws_handler.py

@@ -5,6 +5,7 @@ from urllib.parse import urlparse, parse_qs
 from pyview.live_socket import LiveViewSocket
 from pyview.live_routes import LiveViewLookup
 from pyview.csrf import validate_csrf_token
+from pyview.session import deserialize_session
 
 
 class LiveSocketHandler:
@@ -31,7 +32,11 @@ class LiveSocketHandler:
                 if not validate_csrf_token(payload["params"]["_csrf_token"], topic):
                     raise Exception("Invalid CSRF token")
 
-                await lv.mount(socket)
+                session = {}
+                if "session" in payload:
+                    session = deserialize_session(payload["session"])
+
+                await lv.mount(socket, session)
                 await lv.handle_params(url, parse_qs(url.query), socket)
 
                 rendered = await _render(socket)
@@ -66,9 +71,7 @@ class LiveSocketHandler:
                     "phx_reply",
                     {"response": {}, "status": "ok"},
                 ]
-                await self.manager.send_personal_message(
-                    json.dumps(resp), socket.websocket
-                )
+                await self.manager.send_personal_message(json.dumps(resp), socket.websocket)
                 continue
 
             if event == "event":
@@ -86,9 +89,7 @@ class LiveSocketHandler:
                     "phx_reply",
                     {"response": {"diff": rendered}, "status": "ok"},
                 ]
-                await self.manager.send_personal_message(
-                    json.dumps(resp), socket.websocket
-                )
+                await self.manager.send_personal_message(json.dumps(resp), socket.websocket)
                 continue
 
             if event == "live_patch":
@@ -105,9 +106,7 @@ class LiveSocketHandler:
                     "phx_reply",
                     {"response": {"diff": rendered}, "status": "ok"},
                 ]
-                await self.manager.send_personal_message(
-                    json.dumps(resp), socket.websocket
-                )
+                await self.manager.send_personal_message(json.dumps(resp), socket.websocket)
                 continue
 
 

{pyview_web-0.0.6a0 → pyview_web-0.0.7a0}/readme.md

@@ -32,7 +32,7 @@ class CountContext(TypedDict):
 
 
 class CountLiveView(LiveView[CountContext]):
-    async def mount(self, socket: LiveViewSocket[CountContext]):
+    async def mount(self, socket: LiveViewSocket[CountContext], _session):
         socket.context = {"count": 0}
 
     async def handle_event(self, event, payload, socket: LiveViewSocket[CountContext]):