Home Assistant Unofficial Reference 2024.12.1
homeassistant.util.aiohttp.MockRequest Class Reference

Public Member Functions

None __init__ (self, bytes content, str mock_source, str method="GET", int status=HTTPStatus.OK, dict[str, str]|None headers=None, str|None query_string=None, str url="")
 
bool body_exists (self)
 
MockStreamReader content (self)
 
Any json (self, JSONDecoder loads=json_loads)
 
MultiDict[str] post (self)
 
MultiDict[str] query (self)
 
str text (self)
 

Public Attributes

 keep_alive
 
 method
 
 mock_source
 
 query_string
 
 status
 
 url
 
 version
 

Static Public Attributes

 None
 

Private Member Functions

None _prepare_hook (self, Any response)
 
str _text (self)
 

Private Attributes

 _content
 
 _payload_writer
 

Detailed Description

Mock an aiohttp request.

Definition at line 44 of file aiohttp.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.util.aiohttp.MockRequest.__init__ (   self,
bytes  content,
str  mock_source,
str   method = "GET",
int   status = HTTPStatus.OK,
dict[str, str] | None   headers = None,
str | None   query_string = None,
str   url = "" 
)
Initialize a request.

Definition at line 49 of file aiohttp.py.

Member Function Documentation

◆ _prepare_hook()

None homeassistant.util.aiohttp.MockRequest._prepare_hook (   self,
Any  response 
)
private
Prepare hook.

Definition at line 71 of file aiohttp.py.

◆ _text()

str homeassistant.util.aiohttp.MockRequest._text (   self)
private
Return the body as text.

Definition at line 80 of file aiohttp.py.

◆ body_exists()

bool homeassistant.util.aiohttp.MockRequest.body_exists (   self)
Return True if request has HTTP BODY, False otherwise.

Definition at line 90 of file aiohttp.py.

◆ content()

MockStreamReader homeassistant.util.aiohttp.MockRequest.content (   self)
Return the body as text.

Definition at line 85 of file aiohttp.py.

◆ json()

Any homeassistant.util.aiohttp.MockRequest.json (   self,
JSONDecoder   loads = json_loads 
)
Return the body as JSON.

Definition at line 94 of file aiohttp.py.

◆ post()

MultiDict[str] homeassistant.util.aiohttp.MockRequest.post (   self)
Return POST parameters.

Definition at line 98 of file aiohttp.py.

◆ query()

MultiDict[str] homeassistant.util.aiohttp.MockRequest.query (   self)
Return a dictionary with the query variables.

Definition at line 75 of file aiohttp.py.

◆ text()

str homeassistant.util.aiohttp.MockRequest.text (   self)
Return the body as text.

Definition at line 102 of file aiohttp.py.

Member Data Documentation

◆ _content

homeassistant.util.aiohttp.MockRequest._content
private

Definition at line 67 of file aiohttp.py.

◆ _payload_writer

homeassistant.util.aiohttp.MockRequest._payload_writer
private

Definition at line 69 of file aiohttp.py.

◆ keep_alive

homeassistant.util.aiohttp.MockRequest.keep_alive

Definition at line 65 of file aiohttp.py.

◆ method

homeassistant.util.aiohttp.MockRequest.method

Definition at line 60 of file aiohttp.py.

◆ mock_source

homeassistant.util.aiohttp.MockRequest.mock_source

Definition at line 68 of file aiohttp.py.

◆ None

homeassistant.util.aiohttp.MockRequest.None
static
Mock an aiohttp request.

Definition at line 47 of file aiohttp.py.

◆ query_string

homeassistant.util.aiohttp.MockRequest.query_string

Definition at line 64 of file aiohttp.py.

◆ status

homeassistant.util.aiohttp.MockRequest.status

Definition at line 62 of file aiohttp.py.

◆ url

homeassistant.util.aiohttp.MockRequest.url

Definition at line 61 of file aiohttp.py.

◆ version

homeassistant.util.aiohttp.MockRequest.version

Definition at line 66 of file aiohttp.py.


The documentation for this class was generated from the following file: