From d671d1ec15f228e16cd9125c99fccc39ff9021a5 Mon Sep 17 00:00:00 2001 From: Sanskar Jethi Date: Sat, 11 Jan 2025 18:43:36 +0000 Subject: [PATCH 1/3] chore: fix the documentation --- .../documentation/api_reference/getting_started.mdx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs_src/src/pages/documentation/api_reference/getting_started.mdx b/docs_src/src/pages/documentation/api_reference/getting_started.mdx index 933a381fa..55f25ee63 100644 --- a/docs_src/src/pages/documentation/api_reference/getting_started.mdx +++ b/docs_src/src/pages/documentation/api_reference/getting_started.mdx @@ -325,8 +325,7 @@ Batman was curious about how to access path parameters and query parameters from ```python - from robyn.robyn import QueryParams, Headers - from robyn.types import PathParams, RequestMethod, RequestBody, RequestURL + from robyn import QueryParams, Headers, PathParams, Method, Body, URL @app.get("/untyped/query_params") def untyped_basic(query_params): @@ -346,9 +345,9 @@ Batman was curious about how to access path parameters and query parameters from @app.post("/typed_untyped/combined") def typed_untyped_combined( query_params, - method_data: RequestMethod, - body_data: RequestBody, - url: RequestURL, + method_data: Method, + body_data: Body, + url: URL, headers_item: Headers, ): return { @@ -364,7 +363,7 @@ Batman was curious about how to access path parameters and query parameters from -Type Aliases: `Request`, `QueryParams`, `Headers`, `PathParams`, `RequestBody`, `RequestMethod`, `RequestURL`, `FormData`, `RequestFiles`, `RequestIP`, `RequestIdentity` +Type Aliases: `Request`, `QueryParams`, `Headers`, `PathParams`, `Body`, `URL`, `FormData`, `Files`, `IPAddress`, `Identity` Reserved Names: `r`, `req`, `request`, `query_params`, `headers`, `path_params`, `body`, `method`, `url`, `ip_addr`, `identity`, `form_data`, `files` From a6ffc21abc0f7274c8847394550ad9ec67a32f44 Mon Sep 17 00:00:00 2001 From: Sanskar Jethi Date: Sat, 11 Jan 2025 22:17:34 +0000 Subject: [PATCH 2/3] chore: fix the documentation --- robyn/__init__.py | 12 ++++++++++-- robyn/types.py | 3 ++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/robyn/__init__.py b/robyn/__init__.py index ca81226f9..13e42b0ea 100644 --- a/robyn/__init__.py +++ b/robyn/__init__.py @@ -20,9 +20,9 @@ from robyn.processpool import run_processes from robyn.reloader import compile_rust_files from robyn.responses import html, serve_file, serve_html -from robyn.robyn import FunctionInfo, Headers, HttpMethod, Request, Response, WebSocketConnector, get_version +from robyn.robyn import FunctionInfo, Headers, HttpMethod, Request, Response, WebSocketConnector, get_version, Url from robyn.router import MiddlewareRouter, MiddlewareType, Router, WebSocketRouter -from robyn.types import Directory +from robyn.types import Directory, PathParams, Method, FormData, Files, IPAddress, Body from robyn.ws import WebSocket __version__ = get_version() @@ -656,4 +656,12 @@ def cors_middleware(request): "Headers", "WebSocketConnector", "WebSocket", + "Directory", + "PathParams", + "Method", + "FormData", + "Files", + "IPAddress", + "Body", + "Url", ] diff --git a/robyn/types.py b/robyn/types.py index 071e62a60..30fa26037 100644 --- a/robyn/types.py +++ b/robyn/types.py @@ -41,4 +41,5 @@ class Body: pass -__all__ = ["JSONResponse", "Body"] +__all__ = ["JSONResponse", "Body", "Directory", "PathParams", "Method", "FormData", "Files", "IPAddress"] + From 140d5e803c54eb76c3022fc6f0bb7623d2a0702f Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 11 Jan 2025 22:17:43 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- robyn/types.py | 1 - 1 file changed, 1 deletion(-) diff --git a/robyn/types.py b/robyn/types.py index 30fa26037..6c6809ff4 100644 --- a/robyn/types.py +++ b/robyn/types.py @@ -42,4 +42,3 @@ class Body: __all__ = ["JSONResponse", "Body", "Directory", "PathParams", "Method", "FormData", "Files", "IPAddress"] -