sveltekit-python-vercel 0.2.0 → 0.4.0

package/README.md

@@ -17,13 +17,12 @@ Write Python endpoints in [SvelteKit](https://kit.svelte.dev/) and seamlessly de
 - [Fork of `sveltekit-modal`](#fork-of-sveltekit-modal)
 - [Possible future plans](#possible-future-plans)
 
-
 **This is very much in beta.**
 
 ## Current Features
 
 - Write `+server.py` files nearly the same way you would write `+server.js` files
-- Deploy (quadi) automatically to Vercel Serverless
+- Deploy (quasi) automatically to Vercel Serverless
 
 ## Installing
 
@@ -47,7 +46,7 @@ Write Python endpoints in [SvelteKit](https://kit.svelte.dev/) and seamlessly de
 - Update your `svelte.config.js`:
 
   ```javascript
-  import adapter from "@sveltejs/adapter-vercel";  // Use the vercel adapter
+  import adapter from "@sveltejs/adapter-vercel"; // Use the vercel adapter
   import { vitePreprocess } from "@sveltejs/kit/vite";
 
   /** @type {import('@sveltejs/kit').Config} */
@@ -63,8 +62,10 @@ Write Python endpoints in [SvelteKit](https://kit.svelte.dev/) and seamlessly de
   ```
 
 - Update your `vercel.json`
+
   - The build command prepares all your endpoints and copies them to the `/api` directory where Vercel looks for functions
   - Functions and Routes tell Vercel how to run and redirect function calls
+
   ```json
   {
     "buildCommand": "node ./node_modules/sveltekit-python-vercel/esm/src/vite/sveltekit_python_vercel/bin.mjs; vite build",
@@ -85,7 +86,8 @@ Write Python endpoints in [SvelteKit](https://kit.svelte.dev/) and seamlessly de
 - Write some `+server.py` endpoints. See the example section below.
 
 ## Testing Locally
-Using [Poetry](https://python-poetry.org/) to manage your virtual environments with this package is recommended. 
+
+Using [Poetry](https://python-poetry.org/) to manage your virtual environments with this package is recommended.
 
 - Run `poetry init` to create a new virtual environment, and follow the steps. Or simply create a `pyproject.toml` like the one below.
 
@@ -99,14 +101,17 @@ Using [Poetry](https://python-poetry.org/) to manage your virtual environments w
 
   [tool.poetry.dependencies]
   python = "^3.9"
-  fastapi = "^0.95.1"
+  fastapi = "^0.95.2"
   uvicorn = "^0.22.0"
-
+  
+  [tool.poetry.group.dev.dependencies]
+  watchfiles = "^0.19.0"
 
   [build-system]
   requires = ["poetry-core"]
   build-backend = "poetry.core.masonry.api"
   ```
+
 - Required packages are python3.9 (that is what Vercel's runtime uses), `fastapi`, and `uvicorn`.
 - Install whatever other dependencies you need from pypi using `poetry add package-name`
 
@@ -115,6 +120,7 @@ Using [Poetry](https://python-poetry.org/) to manage your virtual environments w
   - You should see both the usual SvelteKit server start as well as the unvicorn server (by default on `http://0.0.0.0:8000`) in the console.
 
 ## Deploying to Vercel
+
 - At the moment this requires a tiny bit of extra labor besides just pushing to your repository. I believe this is because of the way Vercel looks for serverless functions, but I hope to make this a bit easier in the future.
 
 - When you make changes to your python endpoints, you have to manually regenerate the `/api` folder by running:
@@ -122,8 +128,8 @@ Using [Poetry](https://python-poetry.org/) to manage your virtual environments w
   2. `node ./node_modules/sveltekit-python-vercel/esm/src/vite/sveltekit_python_vercel/bin.mjs`
 - Then commit `requirements.txt` and the changes in `/api` and push.
 
-
 Note:
+
 - To make this a bit smoother, you can add a script to you `package.json`:
   ```json
   "scripts": {
@@ -133,12 +139,10 @@ Note:
   ```
   - and then just run `pnpm py-update`
 
-
-
-
 ## Example
 
 - Frontend: `/src/routes/py/+page.svelte`
+
   ```html
   <script lang="ts">
     let a = 0;
@@ -146,12 +150,12 @@ Note:
     let total = 0;
 
     async function pyAddPost() {
-      const response = await fetch('/py', {
-        method: 'POST',
+      const response = await fetch("/py", {
+        method: "POST",
         body: JSON.stringify({ a, b }),
         headers: {
-          'content-type': 'application/json'
-        }
+          "content-type": "application/json",
+        },
       });
       let res = await response.json();
       total = res.sum;
@@ -159,10 +163,10 @@ Note:
 
     async function pyAddGet() {
       const response = await fetch(`/py?a=${a}&b=${b}`, {
-        method: 'GET',
+        method: "GET",
         headers: {
-          'content-type': 'application/json'
-        }
+          "content-type": "application/json",
+        },
       });
 
       let res = await response.json();
@@ -174,9 +178,9 @@ Note:
 
   <h3>POST Example</h3>
   <form>
-    <input type="number" name="a" placeholder="Number 1" bind:value={a} />
-    <input type="number" name="b" placeholder="Number 2" bind:value={b} />
-    <button on:click|preventDefault={pyAddPost}>Add</button>
+    <input type="number" name="a" placeholder="Number 1" bind:value="{a}" />
+    <input type="number" name="b" placeholder="Number 2" bind:value="{b}" />
+    <button on:click|preventDefault="{pyAddPost}">Add</button>
   </form>
   <h4>Total: {total}</h4>
 
@@ -184,14 +188,15 @@ Note:
 
   <h3>GET Example</h3>
   <form>
-    <input type="number" name="a" placeholder="Number 1" bind:value={a} />
-    <input type="number" name="b" placeholder="Number 2" bind:value={b} />
-    <button on:click|preventDefault={pyAddGet}>Add</button>
+    <input type="number" name="a" placeholder="Number 1" bind:value="{a}" />
+    <input type="number" name="b" placeholder="Number 2" bind:value="{b}" />
+    <button on:click|preventDefault="{pyAddGet}">Add</button>
   </form>
   <h4>Total: {total}</h4>
   ```
 
 - Backend: `/src/routes/py/+server.py`
+
   ```python
   from pydantic import BaseModel
 
@@ -201,18 +206,19 @@ Note:
       b: float
 
 
-  async def POST(numberSet: NumberSet):
-      return {"sum": float(numberSet.a) + float(numberSet.b)}
+  async def POST(data: NumberSet):
+      return {"sum": data.a + data.b}
 
 
-  async def GET(a, b):
-      return {"sum": float(a) + float(b)}
+  async def GET(a: float, b: float):
+      return {"sum": a + b}
 
   ```
 
 ### Backend Caveats
 
 There are currently a few things that have to be worked around.
+
 - `GET` endpoints are directly fed the parameters from the url, so when you define an endpoint
 - All other endpoints are fed the body as a JSON. The recommended way to deal with this is to use a pydantic model and pass it as the singular input to the function.
 
@@ -224,8 +230,9 @@ Check out the awesome [sveltekit-modal](https://github.com/semicognitive/sveltek
 
 ## Possible future plans
 
+- [X] Add hot reloading in dev mode
 - [ ] Generate endpoints (/api folder) automatically during build
   - [ ] Auto create requirements.txt from pyproject.toml (both related to vercel functions being checked/handled before build)
 - [ ] Add form actions
 - [ ] Add load functions
-- [ ] Add helper functions to automatically call API endpoints in project
+- [ ] Add helper functions to automatically call API endpoints in project\

package/esm/src/vite/mod.js

@@ -14,10 +14,9 @@ const get_pyServerEndpointAsString = (app_url, serve = false) => `
           fullURL = new URL('/api' + url.pathname, new URL('${app_url}')) + url.search;
         }
 
-        console.log(\`Reached python endpoint of \${method} \${fullURL}\`)
+        console.log(\`PY: Reached python endpoint of \${method} \${fullURL}\`)
         let requestBody = await request.clone().text();
-        console.log(\`Body: \${requestBody}\`);
-        console.log(\`Content-Type: \${request.headers.get('content-type')}\`);
+        console.log(\`PY: Body: \${requestBody}\`);
 
         if (method === 'GET') {
           requestBody = null;
@@ -79,11 +78,11 @@ export async function sveltekit_python_vercel(opts = {}) {
         name: "vite-plugin-sveltekit_python-build",
         apply: "build",
         async configResolved(config) {
-            console.log("BUILD DEBUG");
-            console.log("ROOT PATH: " + config.root);
-            console.log("LOADED VERCEL URL: " + loadEnv("", config.root, "").VERCEL_URL);
+            console.log("PY: BUILD DEBUG");
+            console.log("PY: ROOT PATH: " + config.root);
+            console.log("PY: LOADED VERCEL URL: " + loadEnv("", config.root, "").VERCEL_URL);
             const packagelocation = path.join(config.root, "node_modules", "sveltekit-python-vercel", "esm/src/vite");
-            console.log("PACKAGE LOCATION: " + packagelocation);
+            console.log("PY: PACKAGE LOCATION: " + packagelocation);
             const python_path = opts.python_path ?? (await which("python3"));
             await run$ `cd ${packagelocation}`;
             await run$ `${python_path} ${packagelocation}/sveltekit_python_vercel/build.py --root ${config.root}`;
@@ -95,7 +94,7 @@ export async function sveltekit_python_vercel(opts = {}) {
             const api_url = path.join(httpPrefix + loadEnv("", config.root, "").VERCEL_URL);
             // get current Vercel deploy URL
             sveltekit_url = new URL(api_url);
-            console.log("Build API URL: " + sveltekit_url.toString());
+            console.log("PY: Build API URL: " + sveltekit_url.toString());
         },
     };
     const plugin_py_server_endpoint_serve = {

package/esm/src/vite/sveltekit_python_vercel/build.py

@@ -25,7 +25,8 @@ for module_path in glob.glob(str(root_dir / 'src/routes/**/+server.py'), recursi
     
     # replace the root_dir with api_dir
     api_route = api_dir / Path(module_path).absolute().relative_to(root_dir / "src/routes")
-    
+    api_route = Path(str(api_route).replace('[', '{').replace(']', '}'))
+
     if not api_route.parent.exists():
         api_route.parent.mkdir(parents=True)
     

package/esm/src/vite/sveltekit_python_vercel/deploy.py

@@ -1,7 +1,7 @@
-import os
 import glob
 import importlib
 import importlib.util
+import os
 from pathlib import Path
 
 from fastapi import FastAPI, Request
@@ -22,29 +22,27 @@ for module_path in glob.glob('./**/+server.py', recursive=True):
     
     api_route = module_path[1:] if module_path.startswith('./') else module_path
     api_route = str(Path(api_route).parent)
+    
+    # Replace square brackets with curly brackets
+    api_route = api_route.replace('[', '{').replace(']', '}')
 
     mod = importlib.import_module(module_name, module_package)
-
-    if hasattr(mod, 'GET'):
-        app.add_api_route(api_route, mod.GET, methods=["GET"])
-        print(f"PYTHON ENDPOINT: Added {module_path} [GET] at {api_route}")
-
-    if hasattr(mod, 'POST'):
-        app.add_api_route(api_route, mod.POST, methods=["POST"])
-        print(f"PYTHON ENDPOINT: Added {module_path} [POST] at {api_route}")
-
-    if hasattr(mod, 'PATCH'):
-        app.add_api_route(api_route, mod.PATCH, methods=["PATCH"])
-        print(f"PYTHON ENDPOINT: Added {module_path} [PATCH] at {api_route}")
-
-    if hasattr(mod, 'PUT'):
-        app.add_api_route(api_route, mod.PUT, methods=["PUT"])
-        print(f"PYTHON ENDPOINT: Added {module_path} [PUT] at {api_route}")
-
-    if hasattr(mod, 'DELETE'):
-        app.add_api_route(api_route, mod.DELETE, methods=["DELETE"])
-        print(f"PYTHON ENDPOINT: Added {module_path} [DELETE] at {api_route}")
-
+    
+    # Add endpoints
+    for method in ["GET", "POST", "PATCH", "PUT", "DELETE"]:
+        
+        # Check for duplicate methods
+        if hasattr(mod, method) and hasattr(mod, method.lower()):
+            raise Exception(
+                f"Duplicate method {method} and {method.lower()} in {api_route}"
+            )
+            
+        elif hasattr(mod, method):
+            app.add_api_route(api_route, getattr(mod, method), methods=[method])
+            print(f"PYTHON ENDPOINT: Added {module_path} [{method}] at {api_route}")
+        elif hasattr(mod, method.lower()):
+            app.add_api_route(api_route, getattr(mod, method.lower()), methods=[method])
+            print(f"PYTHON ENDPOINT: Added {module_path} [{method}] at {api_route}")
 
 @app.exception_handler(Exception)
 async def unicorn_exception_handler(request: Request, exc: Exception):

package/esm/src/vite/sveltekit_python_vercel/serve.py

@@ -1,14 +1,12 @@
-import uvicorn
 import argparse
-import os
+import glob
 import importlib
 import importlib.util
-import glob
 import shutil
 from pathlib import Path
 
-from fastapi import FastAPI, Request
-from fastapi.responses import JSONResponse
+import uvicorn
+from fastapi import FastAPI
 
 parser = argparse.ArgumentParser(description="Run Sveltekit Python Server")
 parser.add_argument("--host", default="0.0.0.0", help="Server hostname")
@@ -18,59 +16,64 @@ args = parser.parse_args()
 
 app = FastAPI()
 
-def app_factory():
-    return app # return the app object
+root_dir = Path(args.root).absolute()
+
+api_dir = Path("./sveltekit_python_vercel").absolute()
+
+route_dir = root_dir.joinpath("src/routes")
+
+watch_modules = []  # list of modules to watch for changes
+
+for module_path in glob.glob(
+    route_dir.joinpath("**/+server.py").as_posix(), recursive=True
+):
+    abs_module_path = Path(module_path).absolute()
+
+    watch_modules.append(abs_module_path.parent.as_posix())
+
+    api_route = api_dir.joinpath(abs_module_path.relative_to(root_dir / "src/routes"))
+
+    if not api_route.parent.exists():
+        api_route.parent.mkdir(parents=True)
+
+    # copy module path to api_route
+    shutil.copy(module_path, api_route.parent)
+
+    module_name = api_route.stem
+
+    spec = importlib.util.spec_from_file_location(module_name, api_route)
+    mod = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(mod)
+
+    # Get the relative path of the module from the API directory
+    rel_path = api_route.relative_to(api_dir)
+
+    # Convert the relative path to a string and remove the file extension
+    api_path = f"/{rel_path.parent}"
+
+    # Replace square brackets with curly brackets
+    api_path = api_path.replace("[", "{").replace("]", "}")
+
+    # Add endpoints
+    for method in ["GET", "POST", "PATCH", "PUT", "DELETE"]:
+        # Check for duplicate methods
+        if hasattr(mod, method) and hasattr(mod, method.lower()):
+            raise Exception(
+                f"Duplicate method {method} and {method.lower()} in {api_route}"
+            )
+        elif hasattr(mod, method):
+            app.add_api_route(api_path, getattr(mod, method), methods=[method])
+        elif hasattr(mod, method.lower()):
+            app.add_api_route(api_path, getattr(mod, method.lower()), methods=[method])
+
 
 if __name__ == "__main__":
-    
-    root_dir = Path(args.root).absolute()
-    api_dir = Path("./sveltekit_python_vercel").absolute()
-
-    # Add all +server.py routes to web_app
-    for module_path in glob.glob(str(root_dir / 'src/routes/**/+server.py'), recursive=True):
-        
-        # replace the root_dir with api_dir
-        api_route = api_dir / Path(module_path).absolute().relative_to(root_dir/ "src/routes")
-        
-        if not api_route.parent.exists():
-            api_route.parent.mkdir(parents=True)
-        
-        # copy module path to api_route
-        shutil.copy(module_path, api_route.parent)
-        print(f"PYTHON ENDPOINT: Copied {module_path} to {api_route.parent}")
-        
-        # Get the module name from the module path
-        module_name = api_route.stem
-        
-        # Import the module dynamically
-        spec = importlib.util.spec_from_file_location(module_name, api_route)
-        mod = importlib.util.module_from_spec(spec)
-        spec.loader.exec_module(mod)
-        
-        # Get the relative path of the module from the API directory
-        rel_path = api_route.relative_to(api_dir)
-        # Convert the relative path to a string and remove the file extension
-        api_path = "/" + str(rel_path.parent)
-        
-        print("ADDING API PATH:", rel_path, api_path)
-        
-        if hasattr(mod, 'GET'):
-            app.add_api_route(api_path, mod.GET, methods=["GET"])
-
-        if hasattr(mod, 'POST'):
-            app.add_api_route(api_path, mod.POST, methods=["POST"])
-
-        if hasattr(mod, 'PATCH'):
-            app.add_api_route(api_path, mod.PATCH, methods=["PATCH"])
-
-        if hasattr(mod, 'PUT'):
-            app.add_api_route(api_path, mod.PUT, methods=["PUT"])
-
-        if hasattr(mod, 'DELETE'):
-            app.add_api_route(api_path, mod.DELETE, methods=["DELETE"])
-
-    
-    config = uvicorn.Config(app_factory, host=args.host, port=args.port, log_level="info", factory=True)
-    server = uvicorn.Server(config)
-    print(f"Hosting on http://{args.host}:{args.port}")
-    server.run()
+    uvicorn.run(
+        "sveltekit_python_vercel.serve:app",
+        host=args.host,
+        port=args.port,
+        log_level="info",
+        reload=True,
+        reload_includes=[*set(watch_modules)],
+        reload_excludes=[api_dir.as_posix()],
+    )

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/mod.js",
   "types": "./types/mod.d.ts",
   "name": "sveltekit-python-vercel",
-  "version": "v0.2.0",
+  "version": "v0.4.0",
   "description": "Write Sveltekit server endpoints in Python and seamlessly deploy to Vercel",
   "repository": {
     "type": "git",