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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
import hashlib
import json
from operator import itemgetter
from typing import Iterable, List, Mapping, Tuple, Union
from urllib.parse import parse_qsl, urlencode, urlparse, urlunparse
import requests
from url_normalize import url_normalize
DEFAULT_HEADERS = requests.utils.default_headers()
RequestContent = Union[Mapping, str, bytes]
def create_key(
request: requests.PreparedRequest,
ignored_params: Iterable[str] = None,
include_get_headers: bool = False,
**kwargs,
) -> str:
"""Create a normalized cache key from a request object"""
key = hashlib.sha256()
key.update(_encode(request.method.upper()))
url = remove_ignored_url_params(request, ignored_params)
url = url_normalize(url)
key.update(_encode(url))
key.update(_encode(kwargs.get('verify', True)))
body = remove_ignored_body_params(request, ignored_params)
if body:
key.update(_encode(body))
if include_get_headers and request.headers != DEFAULT_HEADERS:
for name, value in normalize_dict(request.headers).items():
key.update(_encode(f'{name}={value}'))
return key.hexdigest()
def remove_ignored_url_params(request: requests.PreparedRequest, ignored_params: Iterable[str]) -> str:
url = str(request.url)
if not ignored_params:
return url
url = urlparse(url)
query = parse_qsl(url.query)
query = filter_params(query, ignored_params)
query = urlencode(query)
url = urlunparse((url.scheme, url.netloc, url.path, url.params, query, url.fragment))
return url
def remove_ignored_body_params(request: requests.PreparedRequest, ignored_params: Iterable[str]) -> str:
body = request.body
content_type = request.headers.get('content-type')
if not ignored_params or not body or not content_type:
return request.body
if content_type == 'application/x-www-form-urlencoded':
body = parse_qsl(body)
body = filter_params(body, ignored_params)
body = urlencode(body)
elif content_type == 'application/json':
body = json.loads(_decode(body))
body = filter_params(sorted(body.items()), ignored_params)
body = json.dumps(body)
return body
def filter_params(data: List[Tuple], ignored_params: Iterable[str]) -> List[Tuple]:
return [(k, v) for k, v in data if k not in set(ignored_params)]
def normalize_dict(items: RequestContent = None, normalize_data: bool = True) -> RequestContent:
"""Sort items in a dict
Args:
items: Request params, data, or json
normalize_data: Also normalize stringified JSON
"""
def sort_dict(d):
return dict(sorted(d.items(), key=itemgetter(0)))
if isinstance(items, Mapping):
return sort_dict(items)
if normalize_data and isinstance(items, (bytes, str)):
# Attempt to load body as JSON; not doing this by default as it could impact performance
try:
dict_items = json.loads(_decode(items))
dict_items = json.dumps(sort_dict(dict_items))
return dict_items.encode('utf-8') if isinstance(items, bytes) else dict_items
except Exception:
pass
return items
def url_to_key(url: str, *args, **kwargs) -> str:
request = requests.Session().prepare_request(requests.Request('GET', url))
return create_key(request, *args, **kwargs)
def _encode(value, encoding='utf-8') -> bytes:
"""Encode a value, if it hasn't already been"""
return value if isinstance(value, bytes) else str(value).encode(encoding)
def _decode(value, encoding='utf-8') -> str:
"""Decode a value, if hasn't already been.
Note: PreparedRequest.body is always encoded in utf-8.
"""
return value.decode(encoding) if isinstance(value, bytes) else value
|
