1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
"""This module documents the minimal http behaviors used by this package.
Its interface is influenced by, and similar to a subset of some popular,
real-world http libraries, such as requests, aiohttp and httpx.
"""
class HttpClient(object):
"""This describes a minimal http request interface used by this package."""
def post(self, url, params=None, data=None, headers=None, **kwargs):
"""HTTP post.
:param dict params: A dict to be url-encoded and sent as query-string.
:param dict headers: A dict representing headers to be sent via request.
:param data:
Implementation needs to support 2 types.
* A dict, which will need to be urlencode() before being sent.
* (Recommended) A string, which will be sent in request as-is.
It returns an :class:`~Response`-like object.
Note: In its async counterpart, this method would be defined as async.
"""
return Response()
def get(self, url, params=None, headers=None, **kwargs):
"""HTTP get.
:param dict params: A dict to be url-encoded and sent as query-string.
:param dict headers: A dict representing headers to be sent via request.
It returns an :class:`~Response`-like object.
Note: In its async counterpart, this method would be defined as async.
"""
return Response()
class Response(object):
"""This describes a minimal http response interface used by this package.
:var int status_code:
The status code of this http response.
Our async code path would also accept an alias as "status".
:var string text:
The body of this http response.
Our async code path would also accept an awaitable with the same name.
"""
status_code = 200 # Our async code path would also accept a name as "status"
text = "body as a string" # Our async code path would also accept an awaitable
# We could define a json() method instead of a text property/method,
# but a `text` would be more generic,
# when downstream packages would potentially access some XML endpoints.
headers = {} # Duplicated headers are expected to be combined into one header
# with its value as a comma-separated string.
# https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.2
# Popular HTTP libraries model it as a case-insensitive dict.
def raise_for_status(self):
"""Raise an exception when http response status contains error"""
raise NotImplementedError("Your implementation should provide this")
def _get_status_code(resp):
# RFC defines and some libraries use "status_code", others use "status"
return getattr(resp, "status_code", None) or resp.status
|
