"""
MicroPie: A simple Python ultra-micro web framework with ASGI
support. https://patx.github.io/micropie
Copyright 2025 Harrison Erd
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. 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.
3. Neither the name of the copyright holder 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 HOLDER 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.
"""
import asyncio
import contextvars
import inspect
import os
import re
import time
import uuid
from abc import ABC, abstractmethod
from typing import Any, Awaitable, Callable, Dict, List, Optional, Tuple
from urllib.parse import parse_qs
try:
import orjson as json # Use `orjson` if installed as it is faster
except ImportError:
import json
try:
from jinja2 import Environment, FileSystemLoader, select_autoescape
JINJA_INSTALLED = True
except ImportError:
JINJA_INSTALLED = False
try:
import aiofiles, aiofiles.os
from multipart import PushMultipartParser, MultipartSegment
MULTIPART_INSTALLED = True
except ImportError:
MULTIPART_INSTALLED = False
# -----------------------------
# Session Backend Abstraction
# -----------------------------
SESSION_TIMEOUT: int = 8 * 3600 # Default 8 hours
class SessionBackend(ABC):
@abstractmethod
async def load(self, session_id: str) -> Dict[str, Any]:
"""
Load session data given a session ID.
Args:
session_id: str
"""
pass
@abstractmethod
async def save(self, session_id: str, data: Dict[str, Any], timeout: int) -> None:
"""
Save session data.
Args:
session_id: str
data: Dict
timeout: int (in seconds)
"""
pass
class InMemorySessionBackend(SessionBackend):
def __init__(self):
self.sessions: Dict[str, Dict[str, Any]] = {}
self.last_access: Dict[str, float] = {}
async def load(self, session_id: str) -> Dict[str, Any]:
now = time.time()
if session_id in self.sessions and (now - self.last_access.get(session_id, now)) < SESSION_TIMEOUT:
self.last_access[session_id] = now
return self.sessions[session_id]
return {}
async def save(self, session_id: str, data: Dict[str, Any], timeout: int) -> None:
self.sessions[session_id] = data
self.last_access[session_id] = time.time()
# -----------------------------
# Request Object
# -----------------------------
current_request: contextvars.ContextVar[Any] = contextvars.ContextVar("current_request")
class Request:
"""Represents an HTTP request in the MicroPie framework."""
def __init__(self, scope: Dict[str, Any]) -> None:
"""
Initialize a new Request instance.
Args:
scope: The ASGI scope dictionary for the request.
"""
self.scope: Dict[str, Any] = scope
self.method: str = scope["method"]
self.path_params: List[str] = []
self.query_params: Dict[str, List[str]] = {}
self.body_params: Dict[str, List[str]] = {}
self.get_json: Any = {}
self.session: Dict[str, Any] = {}
self.files: Dict[str, Any] = {}
self.headers: Dict[str, str] = {
k.decode("utf-8", errors="replace").lower(): v.decode("utf-8", errors="replace")
for k, v in scope.get("headers", [])
}
# -----------------------------
# Middleware Abstraction
# -----------------------------
class HttpMiddleware(ABC):
"""
Pluggable middleware class that allows hooking into the request lifecycle.
"""
@abstractmethod
async def before_request(self, request: Request) -> None:
"""
Called before the request is processed.
"""
pass
@abstractmethod
async def after_request(
self,
request: Request,
status_code: int,
response_body: Any,
extra_headers: List[Tuple[str, str]]
) -> None:
"""
Called after the request is processed, but before the final response
is sent to the client. You may alter the status_code, response_body,
or extra_headers if needed.
"""
pass
# -----------------------------
# Application Base
# -----------------------------
class App:
"""
ASGI application for handling HTTP requests in MicroPie.
It supports pluggable session backends via the 'session_backend' attribute
and pluggable middlewares via the 'middlewares' list.
"""
def __init__(self, session_backend: Optional[SessionBackend] = None) -> None:
if JINJA_INSTALLED:
self.env = Environment(
loader=FileSystemLoader("templates"),
autoescape=select_autoescape(["html", "xml"]),
enable_async=True
)
else:
self.env = None
self.session_backend: SessionBackend = session_backend or InMemorySessionBackend()
self.middlewares: List[HttpMiddleware] = []
@property
def request(self) -> Request:
"""
Retrieve the current request from the context variable.
Returns: The current Request instance.
"""
return current_request.get()
async def __call__(
self,
scope: Dict[str, Any],
receive: Callable[[], Awaitable[Dict[str, Any]]],
send: Callable[[Dict[str, Any]], Awaitable[None]]
) -> None:
"""
ASGI callable interface for the server.
Args:
scope: The ASGI scope dictionary.
receive: The callable to receive ASGI events.
send: The callable to send ASGI events.
"""
if scope["type"] == "http":
await self._asgi_app_http(scope, receive, send)
else:
pass # Handle websockets, lifespan and more in the future.
async def _asgi_app_http(
self,
scope: Dict[str, Any],
receive: Callable[[], Awaitable[Dict[str, Any]]],
send: Callable[[Dict[str, Any]], Awaitable[None]]
) -> None:
"""
ASGI application entry point for handling HTTP requests.
Args:
scope: The ASGI scope dictionary.
receive: The callable to receive ASGI events.
send: The callable to send ASGI events.
"""
request: Request = Request(scope)
token = current_request.set(request)
status_code: int = 200
response_body: Any = ""
extra_headers: List[Tuple[str, str]] = []
try:
# Middleware: before request
for mw in self.middlewares:
if result := await mw.before_request(request):
status_code, response_body, extra_headers = (
result["status_code"],
result["body"],
result.get("headers", []),
)
await self._send_response(send, status_code, response_body, extra_headers)
return
# Parse path and find handler
path: str = scope["path"].lstrip("/")
parts: List[str] = path.split("/") if path else []
func_name: str = parts[0] if parts else "index"
if func_name.startswith("_"):
await self._send_response(send, 404, "404 Not Found")
return
request.path_params = parts[1:] if len(parts) > 1 else []
handler = getattr(self, func_name, None) or getattr(self, "index", None)
if not handler:
await self._send_response(send, 404, "404 Not Found")
return
# Parse request details
request.query_params = parse_qs(scope.get("query_string", b"").decode("utf-8", "ignore"))
cookies = self._parse_cookies(request.headers.get("cookie", ""))
request.session = await self.session_backend.load(cookies.get("session_id", "")) or {}
# Parse body parameters.
if request.method in ("POST", "PUT", "PATCH"):
body_data = bytearray()
while True:
msg: Dict[str, Any] = await receive()
body_data += msg.get("body", b"")
if not msg.get("more_body"):
break
content_type = request.headers.get("content-type", "")
if "application/json" in content_type:
try:
request.get_json = json.loads(body_data.decode("utf-8"))
if isinstance(request.get_json, dict):
request.body_params = {k: [str(v)] for k, v in request.get_json.items()}
except:
print(f"Request error: {e}")
await self._send_response(send, 400, "400 Bad Request: Bad JSON")
return
elif "multipart/form-data" in content_type:
if boundary := re.search(r"boundary=([^;]+)", content_type):
reader = asyncio.StreamReader()
reader.feed_data(body_data)
reader.feed_eof()
request.body_params, request.files = await self._parse_multipart(reader, boundary.group(1).encode("utf-8"))
else:
await self._send_response(send, 400, "400 Bad Request: Missing boundary")
return
else:
request.body_params = parse_qs(body_data.decode("utf-8", "ignore"))
# Build function arguments from path, query, body, files, and session values.
sig = inspect.signature(handler)
func_args: List[Any] = []
path_params_copy = request.path_params[:] # Create a copy to avoid modifying original
for param in sig.parameters.values():
if param.name == "self": # Skip self parameter
continue
if param.kind == inspect.Parameter.VAR_POSITIONAL:
# Pass all remaining path_params for *args
func_args.extend(path_params_copy)
path_params_copy = [] # Clear to prevent reuse
continue # Skip appending anything else
param_value = None
if path_params_copy:
param_value = path_params_copy.pop(0)
elif param.name in request.query_params:
param_value = request.query_params[param.name][0]
elif param.name in request.body_params:
param_value = request.body_params[param.name][0]
elif param.name in request.files:
param_value = request.files[param.name]
elif param.name in request.session:
param_value = request.session[param.name]
elif param.default is not param.empty:
param_value = param.default
else:
status_code = 400
response_body = f"400 Bad Request: Missing required parameter '{param.name}'"
await self._send_response(send, status_code, response_body)
return
func_args.append(param_value)
if handler == getattr(self, "index", None) and not func_args and path:
await self._send_response(send, 404, "404 Not Found")
return
# Execute handler
try:
result = await handler(*func_args) if inspect.iscoroutinefunction(handler) else handler(*func_args)
except Exception as e:
print(f"Request error: {e}")
await self._send_response(send, 500, "500 Internal Server Error")
return
# Normalize response
if isinstance(result, tuple):
status_code, response_body = result[0], result[1]
extra_headers = result[2] if len(result) > 2 else []
else:
response_body = result
if isinstance(response_body, (dict, list)):
response_body = json.dumps(response_body)
extra_headers.append(("Content-Type", "application/json"))
# Save session
if request.session:
session_id = cookies.get("session_id") or str(uuid.uuid4())
await self.session_backend.save(session_id, request.session, SESSION_TIMEOUT)
if not cookies.get("session_id"):
extra_headers.append(("Set-Cookie", f"session_id={session_id}; Path=/; SameSite=Lax; HttpOnly; Secure;"))
# Middleware: after request
for mw in self.middlewares:
if result := await mw.after_request(request, status_code, response_body, extra_headers):
status_code, response_body, extra_headers = (
result.get("status_code", status_code),
result.get("body", response_body),
result.get("headers", extra_headers)
)
await self._send_response(send, status_code, response_body, extra_headers)
finally:
current_request.reset(token)
def _parse_cookies(self, cookie_header: str) -> Dict[str, str]:
"""
Parse the Cookie header and return a dictionary of cookie names and values.
Args:
cookie_header: The raw Cookie header string.
Returns:
A dictionary mapping cookie names to their corresponding values.
"""
cookies: Dict[str, str] = {}
if not cookie_header:
return cookies
for cookie in cookie_header.split(";"):
if "=" in cookie:
k, v = cookie.strip().split("=", 1)
cookies[k] = v
return cookies
async def _parse_multipart(self, reader: asyncio.StreamReader, boundary: bytes):
"""
Asynchronously parses a multipart form-data request.
This method processes incoming multipart form-data, handling
both text fields and file uploads. It reads data from the provided
asyncio stream reader and extracts form values and files,
saving uploaded files to a designated directory.
Args:
reader (asyncio.StreamReader): The stream reader from which
to read the multipart data.
boundary (bytes): The boundary string used to separate form
fields in the multipart request.
Returns:
tuple[dict, dict]: A tuple containing form_data & files.
"""
if not MULTIPART_INSTALLED:
print("For multipart form data support install 'multipart' and 'aiofiles'.")
await self._send_response(send, 500, "500 Internal Server Error")
return
with PushMultipartParser(boundary) as parser:
form_data: dict = {}
files: dict = {}
current_field_name: Optional[str] = None
current_filename: Optional[str] = None
current_content_type: Optional[str] = None
current_file: Optional[aiofiles.threadpool.binary.AsyncBufferedIOBase] = None
form_value: str = ""
upload_directory: str = "uploads"
await aiofiles.os.makedirs(upload_directory, exist_ok=True)
while not parser.closed:
chunk: bytes = await reader.read(65536)
if not chunk:
break
for result in parser.parse(chunk):
if isinstance(result, MultipartSegment):
current_field_name = result.name
current_filename = result.filename
current_content_type = None
form_value = ""
for header, value in result.headerlist:
if header.lower() == "content-type":
current_content_type = value
if current_filename:
safe_filename: str = f"{uuid.uuid4()}_{current_filename}"
safe_filename = re.sub(r"[^a-zA-Z0-9_.-]", "_", safe_filename)
file_path: str = os.path.join(upload_directory, safe_filename)
current_file = await aiofiles.open(file_path, "wb")
else:
form_data[current_field_name] = []
elif result:
if current_file:
await current_file.write(result)
else:
if current_file:
form_value += result.decode("utf-8", "ignore")
else:
if current_file:
await current_file.close()
current_file = None
files[current_field_name] = {
"filename": current_filename,
"content_type": current_content_type or "application/octet-stream",
"saved_path": os.path.join(upload_directory, safe_filename),
}
else:
if form_value:
form_data[current_field_name].append(form_value)
form_value = ""
# Ensure any remaining form_value is appended
if current_field_name and form_value and not current_filename:
form_data[current_field_name].append(form_value)
return form_data, files
async def _send_response(
self,
send: Callable[[Dict[str, Any]], Awaitable[None]],
status_code: int,
body: Any,
extra_headers: Optional[List[Tuple[str, str]]] = None
) -> None:
"""
Send an HTTP response using the ASGI send callable.
Args:
send: The ASGI send callable.
status_code: The HTTP status code for the response.
body: The response body, which may be a string, bytes, or
generator.
extra_headers: Optional list of extra header tuples.
"""
if extra_headers is None:
extra_headers = []
sanitized_headers: List[Tuple[str, str]] = []
for k, v in extra_headers:
if "\n" in k or "\r" in k or "\n" in v or "\r" in v:
print(f"Header injection attempt detected: {k}: {v}")
continue
sanitized_headers.append((k, v))
if not any(h[0].lower() == "content-type" for h in sanitized_headers):
sanitized_headers.append(("Content-Type", "text/html; charset=utf-8"))
await send({
"type": "http.response.start",
"status": status_code,
"headers": [(k.encode("latin-1"), v.encode("latin-1")) for k, v in sanitized_headers],
})
if hasattr(body, "__aiter__"):
async for chunk in body:
if isinstance(chunk, str):
chunk = chunk.encode("utf-8")
await send({
"type": "http.response.body",
"body": chunk,
"more_body": True
})
await send({"type": "http.response.body", "body": b"", "more_body": False})
return
if hasattr(body, "__iter__") and not isinstance(body, (bytes, str)):
for chunk in body:
if isinstance(chunk, str):
chunk = chunk.encode("utf-8")
await send({
"type": "http.response.body",
"body": chunk,
"more_body": True
})
await send({"type": "http.response.body", "body": b"", "more_body": False})
return
response_body = (body if isinstance(body, bytes)
else str(body).encode("utf-8"))
await send({
"type": "http.response.body",
"body": response_body,
"more_body": False
})
def _redirect(self, location: str, extra_headers: list = None) -> Tuple[int, str]:
"""
Generate an HTTP redirect response.
Args:
location: The URL to redirect to.
extra_headers: Optional list of tuples (header_name, header_value) to include in the response.
Returns:
A tuple containing the HTTP status code, the HTML body, and headers list.
"""
headers = [("Location", location)]
if extra_headers:
headers.extend(extra_headers)
return 302, "", headers
async def _render_template(self, name: str, **kwargs: Any) -> str:
"""
Render a template asynchronously using Jinja2.
Args:
name: The name of the template file.
**kwargs: Additional keyword arguments for the template.
Returns:
The rendered template as a string.
"""
if not JINJA_INSTALLED:
print("To use the `_render_template` method install 'jinja2'.")
return 500, "500 Internal Server Error"
assert self.env is not None
template = await asyncio.to_thread(self.env.get_template, name)
return await template.render_async(**kwargs)