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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# -*- coding: utf-8 -*-
"""
requests_futures
~~~~~~~~~~~~~~~~
This module provides a small add-on for the requests http library. It makes use
of python 3.3's concurrent.futures or the futures backport for previous
releases of python.
from requests_futures.sessions import FuturesSession
session = FuturesSession()
# request is run in the background
future = session.get('http://httpbin.org/get')
# ... do other stuff ...
# wait for the request to complete, if it hasn't already
response = future.result()
print('response status: {0}'.format(response.status_code))
print(response.content)
"""
from concurrent.futures import ProcessPoolExecutor, ThreadPoolExecutor
from functools import partial
from logging import getLogger
from pickle import PickleError, dumps
from requests import Session
from requests.adapters import DEFAULT_POOLSIZE, HTTPAdapter
def wrap(self, sup, background_callback, *args_, **kwargs_):
"""A global top-level is required for ProcessPoolExecutor"""
resp = sup(*args_, **kwargs_)
return background_callback(self, resp) or resp
PICKLE_ERROR = (
'Cannot pickle function. Refer to documentation: https://'
'github.com/ross/requests-futures/#using-processpoolexecutor'
)
class FuturesSession(Session):
def __init__(
self,
executor=None,
max_workers=8,
session=None,
adapter_kwargs=None,
*args,
**kwargs
):
"""Creates a FuturesSession
Notes
~~~~~
* `ProcessPoolExecutor` may be used with Python > 3.4;
see README for more information.
* If you provide both `executor` and `max_workers`, the latter is
ignored and provided executor is used as is.
"""
_adapter_kwargs = {}
super(FuturesSession, self).__init__(*args, **kwargs)
self._owned_executor = executor is None
if executor is None:
executor = ThreadPoolExecutor(max_workers=max_workers)
# set connection pool size equal to max_workers if needed
if max_workers > DEFAULT_POOLSIZE:
_adapter_kwargs.update(
{
'pool_connections': max_workers,
'pool_maxsize': max_workers,
}
)
_adapter_kwargs.update(adapter_kwargs or {})
if _adapter_kwargs:
self.mount('https://', HTTPAdapter(**_adapter_kwargs))
self.mount('http://', HTTPAdapter(**_adapter_kwargs))
self.executor = executor
self.session = session
def request(self, *args, **kwargs):
"""Maintains the existing api for Session.request.
Used by all of the higher level methods, e.g. Session.get.
The background_callback param allows you to do some processing on the
response in the background, e.g. call resp.json() so that json parsing
happens in the background thread.
:rtype : concurrent.futures.Future
"""
if self.session:
func = self.session.request
else:
# avoid calling super to not break pickled method
func = partial(Session.request, self)
background_callback = kwargs.pop('background_callback', None)
if background_callback:
logger = getLogger(self.__class__.__name__)
logger.warning(
'`background_callback` is deprecated and will be '
'removed in 1.0, use `hooks` instead'
)
func = partial(wrap, self, func, background_callback)
if isinstance(self.executor, ProcessPoolExecutor):
# verify function can be pickled
try:
dumps(func)
except (TypeError, PickleError):
raise RuntimeError(PICKLE_ERROR)
return self.executor.submit(func, *args, **kwargs)
def close(self):
super(FuturesSession, self).close()
if self._owned_executor:
self.executor.shutdown()
def get(self, url, **kwargs):
r"""
Sends a GET request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).get(url, **kwargs)
def options(self, url, **kwargs):
r"""Sends a OPTIONS request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).options(url, **kwargs)
def head(self, url, **kwargs):
r"""Sends a HEAD request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).head(url, **kwargs)
def post(self, url, data=None, json=None, **kwargs):
r"""Sends a POST request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary, list of tuples, bytes, or file-like
object to send in the body of the :class:`Request`.
:param json: (optional) json to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).post(
url, data=data, json=json, **kwargs
)
def put(self, url, data=None, **kwargs):
r"""Sends a PUT request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary, list of tuples, bytes, or file-like
object to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).put(url, data=data, **kwargs)
def patch(self, url, data=None, **kwargs):
r"""Sends a PATCH request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary, list of tuples, bytes, or file-like
object to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).patch(url, data=data, **kwargs)
def delete(self, url, **kwargs):
r"""Sends a DELETE request. Returns :class:`Future` object.
:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.
:rtype : concurrent.futures.Future
"""
return super(FuturesSession, self).delete(url, **kwargs)
|
