minos.networks.rest.requests module¶

class minos.networks.rest.requests.RestRequest(raw, *args, **kwargs)[source]¶

Bases: minos.networks.requests.abc.Request

Rest Request class.

__init__(raw, *args, **kwargs)[source]¶

async content(**kwargs)¶

Get the request content.

Parameters: kwargs – Additional named arguments.
Return type: typing.Any
Returns: The request content.

property content_type: str¶

Get the content type.

Return type: str
Returns: A str value.

property has_content: bool¶

Check if the request has content.

Return type: bool
Returns: True if it has content or False otherwise.

property has_params: bool¶

Check if the request has params.

Return type: bool
Returns: True if it has params or False otherwise.

property has_query_params: bool¶

Check if the request has query params.

Return type: bool
Returns: True if it has query params or False otherwise.

property has_url_params: bool¶

Check if the request has url params.

Return type: bool
Returns: True if it has url params or False otherwise.

property headers: dict[str, str]¶

Get the headers of the request.

Return type: dict[str, str]
Returns: A dictionary in which keys are str instances and values are str instances.

async params(**kwargs)¶

Get the request params.

Parameters: kwargs – Additional named arguments.
Return type: dict[str, typing.Any]
Returns: The request params.

async query_params(type_=None, **kwargs)[source]¶

Get the query params.

Parameters

type – Optional type or str (classname) that defines the request content type.
kwargs – Additional named arguments.

Return type

typing.Any

Returns

A dictionary instance.

raw¶

property raw_request: aiohttp.web_request.Request¶

Get the raw request within the instance.

Return type: aiohttp.web_request.Request
Returns: An aiohttp.web.Request instance.

async url_params(type_=None, **kwargs)[source]¶

Get the url params.

Parameters

type – Optional type or str (classname) that defines the request content type.
kwargs – Additional named arguments.

Return type

typing.Any

Returns

A dictionary instance.

user¶: Returns the UUID of the user making the Request.

class minos.networks.rest.requests.RestResponse(data)[source]¶

Bases: minos.networks.requests.abc.Response

Rest Response class.

__init__(data)¶

async content(**kwargs)¶

Response content.

Parameters: kwargs – Additional named arguments.
Return type: typing.Any
Returns: A list of items.

async raw_content(**kwargs)¶

Raw response content.

Parameters: kwargs – Additional named arguments.
Return type: typing.Any
Returns: A list of raw items.

exception minos.networks.rest.requests.RestResponseException(error_message)[source]¶

Bases: minos.networks.requests.abc.ResponseException

Rest Response Exception class.

__init__(error_message)¶

args¶

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.