Module spangle.models.http¶

HTTP Request & Response.

Classes¶

Request¶

class Request(self, scope: Scope, receive: Receive, send: Send)

Incoming HTTP request class.

Attributes

headers (Headers): The request headers, case-insensitive dictionary.
state (addict.Dict): Any object you want to store while the response.
max_upload_bytes (Optional[int]): Limit upload size against each request.

Do not use manually.

Instance attributes¶

apparent_encoding (Dict[str, Union[str, float]]): Guess the content encoding, provided by the chardet library. Must be awaited.
client (Address): The client address.

Attributes
- host (Optional[str]): The client address, like "127.0.0.1" .
- port (Optional[int]): The client port, like 1234 .
content (bytes): The request body, as bytes. Must be awaited.

Raises

TooLargeRequestError: when request body is too large.
cookies (dict[str, str]): The cookies sent in the request, as a dictionary.
full_url (str): The full URL of the request.
method (str): The request method, lower-cased.
mimetype (str): Mimetype of the request’s body, or "" .
queries (QueryParams): The parsed query parameters used for the request.
text (str): The request body, as unicode-decoded. Must be awaited.
url (URL): The parsed URL of the request. For more details, see Starlette docs .
version (str): The HTTP version, like "1.1" , "2" .

Methods¶

accept

def accept(self, content_type: str) -> Optional[tuple[str, float]]

Test given type is acceptable or not.

Args

content_type (str): Testing "mime/type" .

Returns

Optional[tuple[str, float]]: The first accepted type and its priority in the range: 0.0<=q<=1.0 , or None .

media

async def media(
    self,
    *,
    parser: Callable[["Request"], Awaitable[T]] = None,
    parse_as: Optional[ParseMode] = None,
    ) -> Union[ImmutableMultiDict, T, JsonType]

Decode the request body to dict-like object. Must be awaited.

You can use custom parser by setting your function.

Args

parser (Optional[Callable[[Request], Awaitable[T]]]): Custom parser, must be async function. If not given, spangle uses builtin parser.
parse_as (Optional[ParseMode]): Select parser to decode the body. Accept "json" , "form" , or "multipart" .

Returns

T: Parsed by given function.
ImmutableMultiDict
JsonType

push

async def push(self, path: str) -> None

HTTP2 push-promise.

Args

path (str): A content location in the app.

Response¶

class Response(self)

Outgoing HTTP response class. Response instance is ASGI3 application.

Attributes

headers (MutableHeaders): The response headers, case-insensitive dictionary. To set values having same key, use headers.append() .
cookies (SimpleCookie): Dict-like http cookies. Set-Cookie header refers this. You can set cookie-attributes.
status (int): The response’s status code.
streaming (Optional[AsyncGenerator]): Async generator for streaming. If set, other response body attrs like media are ignored.
mimetype (str): The mediatype of the response body.
reraise (bool): In ErrorHandler, if set true, reraise the exception after sending data.

Do not use manually.

Instance attributes¶

content (bytes): Bytes of the response body. Default-type: "application/octet-stream" .
json (Any): A dict sent to the client. Default-type: "application/json" . You can set values like resp.json.keyName.you = "want" .
text (str): A unicode string of the response body. Default-type: "text/plain" .

Methods¶

add_header

def add_header(self, key: str, value: str) -> "Response"

Append new header. To overwrite, use spangle.models.http.Response.set_header .

Args

key (str): Header’s key.
value (str): Header’s value.

Returns

Response: Return self.

delete_cookie

def delete_cookie(
    self, key: str, path: str = "/", domain: str = None
    ) -> "Response"

Remove cookie value from client.

Args

key (str) Cookie options:
path (str)
domain (str) Returns
Response: Return self.

load_template

async def load_template(
    self, template_name: str, content_type="text/html", **params
    ) -> "Response"

Load jinja2 template, render, set headers & text.

Args

template_name (str): The template "path/name" .
content_type (str): "text/html" .
**params: Variables used in the template. api is reserved by Api instance by default.

Returns

Response: Return self.

Raises

ValueError: Missing jinja2 env in Api instance.
NotFoundError: Missing requested template.

redirect

def redirect(
    self,
    *,
    view: type = None,
    params: dict = None,
    url: str = None,
    status=HTTPStatus.TEMPORARY_REDIRECT,
    query_string: Optional[str] = None,
    ) -> "Response"

Set redirect view/location. Positional args are not allowed.

If both view and url are set, url is ignored.

Args

view (Type): View class that the client redirect to.
params (dict): Dynamic URL params passed to the view.
url (str): The location out of the app.
status (int): HTTP status code. Must be 300<=status<400 .

Returns

Response: Return self.

set_content

def set_content(
    self, content: bytes, content_type="application/octet-stream"
    ) -> "Response"

Set bytes to response body with content type.

Args

content (bytes): Response body as bytes.
content_type (str): Response content type.

Returns

Response: Return self.

set_cookie

def set_cookie(
    self,
    key: str,
    value: str = "",
    max_age: Optional[int] = None,
    expires: Optional[int] = None,
    path: Optional[str] = "/",
    comment: Optional[str] = None,
    domain: Optional[str] = None,
    secure: bool = False,
    httponly: bool = True,
    version: Optional[int] = None,
    samesite: Optional[str] = "Lax",
    ) -> "Response"

Set cookie value to given key with params.

Args

key (str)
value (str) Cookie options:
max_age (Optional[int])
expires (Optional[int])
path (Optional[str])
comment (Optional[str])
domain (Optional[str])
secure (bool)
httponly (bool)
version (Optional[int])
samesite (Optional[str]) Returns
Response: Return self.

set_header

def set_header(self, key: str, value: str) -> "Response"

Set HTTP header value to given key. It overwrites value if exists.

Args

key (str): Header’s key.
value (str): Header’s value.

Returns

Response: Return self.

set_status

def set_status(self, status: int) -> "Response"

Set HTTP status code.

Args

status (int): HTTP status code.

Returns

Response: Return self.

set_text

def set_text(self, text: str, content_type="text/plain") -> "Response"

Set given text to response body with content type.

Args

text (str): Response body as UTF-8 string.
content_type (str): Response content type.

Returns

Response: Return self.