bump to 0.27 and document Request.query/Request.form helpers

Author: patx

README.md

@@ -141,7 +141,7 @@ class MyApp(App):
         return f"Hello, {name}!"
 
     async def hello(self):
-        name = self.request.query_params.get("name", [None])[0]
+        name = self.request.query("name")
         return f"Hello {name}!"
 ```
 **Access:**
@@ -156,7 +156,7 @@ class MyApp(App):
         return f"Form submitted by: {username}"
 
     async def submit_catch_all(self):
-        username = self.request.body_params.get("username", ["Anonymous"])[0]
+        username = self.request.form("username", "Anonymous")
         return f"Submitted by: {username}"
 ```
 

docs/apidocs/conf.py

@@ -2,7 +2,7 @@
 
 project = "MicroPie"
 author = "Harrison Erd"
-release = "0.26"
+release = "0.27"
 
 extensions = [
     "sphinx.ext.autodoc",

docs/apidocs/reference/request.rst

@@ -35,8 +35,13 @@ Request class
    .. attribute:: query_params
 
       A ``dict`` mapping each query parameter to a list of values.
-      For convenience, use ``self.request.query_params['name'][0]`` to
-      obtain the first value.
+      For convenience, use :meth:`~micropie.Request.query` to obtain
+      the first value.
+
+   .. method:: query(name, default=None)
+
+      Return the first value for query parameter *name*, or *default*
+      if missing.
 
    .. attribute:: body_params
 
@@ -45,6 +50,11 @@ Request class
       object; for ``application/x-www-form-urlencoded`` forms they are
       parsed using :func:`urllib.parse.parse_qs`.
 
+   .. method:: form(name, default=None)
+
+      Return the first value for form/body field *name*, or *default*
+      if missing.
+
    .. attribute:: get_json
 
       The JSON body parsed into a Python object.  Only populated when
@@ -77,4 +87,4 @@ WebSocketRequest class
    Inherits from :class:`~micropie.Request` and represents a WebSocket
    connection request.  All attributes of :class:`~micropie.Request`
    apply.  For WebSocket handlers the request is accessible via
-   ``self.request`` inside the handler or via the context variable.
+   ``self.request`` inside the handler or via the context variable.

docs/apidocs/whats_new.rst

@@ -11,6 +11,8 @@ releases, consult the `GitHub releases page <https://github.com/patx/micropie/re
 Version highlights
 ------------------
 
+* **0.27** – Adds ``Request.query`` and ``Request.form`` helpers for more
+  direct access to query-string and form data.
 * **0.26** – Makes sub-application handoff independent of middleware
   ordering, improving reliability for mounted ASGI apps.
 * **0.25** – Fixes Unicode redirect handling by percent-encoding

docs/release_notes.md

@@ -1,6 +1,7 @@
 [![Logo](https://patx.github.io/micropie/logo.png)](https://patx.github.io/micropie)
 
 ## Releases Notes
+- **[0.27](https://github.com/patx/micropie/releases/tag/v0.27)** - Add `Request.query` and `Request.form` helpers
 - **[0.26](https://github.com/patx/micropie/releases/tag/v0.26)** - Sub-app routing no longer depends on middleware ordering
 - **[0.25](https://github.com/patx/micropie/releases/tag/v0.25)** - Fix unicode redirect handling. Percent-encode non-ASCII path segments before setting Location header. Prevents latin-1 header encoding errors and avoids double-encoding queries.
 - **[0.24](https://github.com/patx/micropie/releases/tag/v0.24)** - Improve session handling. Expired sessions now clean up properly, and empty sessions delete stored data. Session saving also moved after `after_request` middleware.

examples/auth/app.py

@@ -22,7 +22,7 @@ async def login(self):
         )
 
     async def callback(self):
-        code = self.request.query_params.get("code")
+        code = self.request.query("code")
         if not code:
             return "Error: No code provided"
 

examples/blog/app.py

@@ -203,7 +203,7 @@ async def login(self):
         GET  → show login form
         POST → authenticate and set session, then redirect
         """
-        next_path = self.request.query_params.get("next", ["/"])[0]
+        next_path = self.request.query("next", "/")
 
         if self.request.method == "GET":
             return await self._render_template(
@@ -215,8 +215,8 @@ async def login(self):
                 nav_active="login",
             )
 
-        username = self.request.body_params.get("username", [""])[0].strip()
-        password = self.request.body_params.get("password", [""])[0].strip()
+        username = self.request.form("username", "").strip()
+        password = self.request.form("password", "").strip()
 
         user = await self.users.find_one({"username": username})
         if not user or user.get("password") != password:

examples/explicit_routing/ws.py

@@ -10,7 +10,7 @@ async def get_user(self, user_id: int):
     @ws_route("/ws/chat/{room:str}")
     async def ws_chat(self, ws: WebSocket, room: str):
         await ws.accept()
-        user = self.request.query_params.get("user", ["anonymous"])[0]
+        user = self.request.query("user", "anonymous")
         self.request.session["last_room"] = room
         while True:
             try:

examples/json_api/basic.py

@@ -9,7 +9,7 @@ class PasteApp(App):
     async def paste(self, pid: str = None):
         if self.request.method == "POST":
             # Get content from JSON or form, depending on the Content-Type
-            content = self.request.body_params.get("content")[0]
+            content = self.request.form("content")
             pid = str(uuid4())
             await db.aset(pid, content)
             return {

examples/middleware/csrf.py

@@ -161,7 +161,7 @@ async def index(self):
 
     async def submit(self):
         if self.request.method == "POST":
-            name = self.request.body_params.get("name", ["World"])[0]
+            name = self.request.form("name", "World")
             return f"Hello {name}"