webull-openapi-python-sdk 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (295) hide show
  1. samples/__init__.py +1 -0
  2. samples/data/__init__.py +1 -0
  3. samples/data/data_client.py +57 -0
  4. samples/data/data_streaming_client.py +86 -0
  5. samples/data/data_streaming_client_async.py +101 -0
  6. samples/trade/__init__.py +0 -0
  7. samples/trade/trade_client.py +163 -0
  8. samples/trade/trade_client_v2.py +181 -0
  9. samples/trade/trade_event_client.py +47 -0
  10. webull/__init__.py +1 -0
  11. webull/core/__init__.py +12 -0
  12. webull/core/auth/__init__.py +0 -0
  13. webull/core/auth/algorithm/__init__.py +0 -0
  14. webull/core/auth/algorithm/sha_hmac1.py +65 -0
  15. webull/core/auth/algorithm/sha_hmac256.py +75 -0
  16. webull/core/auth/composer/__init__.py +0 -0
  17. webull/core/auth/composer/default_signature_composer.py +125 -0
  18. webull/core/auth/credentials.py +46 -0
  19. webull/core/auth/signers/__init__.py +0 -0
  20. webull/core/auth/signers/app_key_signer.py +72 -0
  21. webull/core/auth/signers/signer.py +48 -0
  22. webull/core/auth/signers/signer_factory.py +58 -0
  23. webull/core/cache/__init__.py +225 -0
  24. webull/core/client.py +410 -0
  25. webull/core/common/__init__.py +0 -0
  26. webull/core/common/api_type.py +19 -0
  27. webull/core/common/easy_enum.py +35 -0
  28. webull/core/common/region.py +7 -0
  29. webull/core/compat.py +85 -0
  30. webull/core/context/__init__.py +0 -0
  31. webull/core/context/request_context_holder.py +33 -0
  32. webull/core/data/endpoints.json +22 -0
  33. webull/core/data/retry_config.json +15 -0
  34. webull/core/endpoint/__init__.py +8 -0
  35. webull/core/endpoint/chained_endpoint_resolver.py +57 -0
  36. webull/core/endpoint/default_endpoint_resolver.py +60 -0
  37. webull/core/endpoint/local_config_regional_endpoint_resolver.py +77 -0
  38. webull/core/endpoint/resolver_endpoint_request.py +46 -0
  39. webull/core/endpoint/user_customized_endpoint_resolver.py +55 -0
  40. webull/core/exception/__init__.py +0 -0
  41. webull/core/exception/error_code.py +23 -0
  42. webull/core/exception/error_msg.py +21 -0
  43. webull/core/exception/exceptions.py +53 -0
  44. webull/core/headers.py +57 -0
  45. webull/core/http/__init__.py +0 -0
  46. webull/core/http/initializer/__init__.py +0 -0
  47. webull/core/http/initializer/client_initializer.py +79 -0
  48. webull/core/http/initializer/token/__init__.py +0 -0
  49. webull/core/http/initializer/token/bean/__init__.py +0 -0
  50. webull/core/http/initializer/token/bean/access_token.py +40 -0
  51. webull/core/http/initializer/token/bean/check_token_request.py +44 -0
  52. webull/core/http/initializer/token/bean/create_token_request.py +45 -0
  53. webull/core/http/initializer/token/bean/refresh_token_request.py +44 -0
  54. webull/core/http/initializer/token/token_manager.py +208 -0
  55. webull/core/http/initializer/token/token_operation.py +72 -0
  56. webull/core/http/method_type.py +43 -0
  57. webull/core/http/protocol_type.py +43 -0
  58. webull/core/http/request.py +121 -0
  59. webull/core/http/response.py +166 -0
  60. webull/core/request.py +278 -0
  61. webull/core/retry/__init__.py +0 -0
  62. webull/core/retry/backoff_strategy.py +102 -0
  63. webull/core/retry/retry_condition.py +214 -0
  64. webull/core/retry/retry_policy.py +63 -0
  65. webull/core/retry/retry_policy_context.py +51 -0
  66. webull/core/utils/__init__.py +0 -0
  67. webull/core/utils/common.py +62 -0
  68. webull/core/utils/data.py +25 -0
  69. webull/core/utils/desensitize.py +33 -0
  70. webull/core/utils/validation.py +49 -0
  71. webull/core/vendored/__init__.py +0 -0
  72. webull/core/vendored/requests/__init__.py +94 -0
  73. webull/core/vendored/requests/__version__.py +28 -0
  74. webull/core/vendored/requests/_internal_utils.py +56 -0
  75. webull/core/vendored/requests/adapters.py +539 -0
  76. webull/core/vendored/requests/api.py +166 -0
  77. webull/core/vendored/requests/auth.py +307 -0
  78. webull/core/vendored/requests/certs.py +34 -0
  79. webull/core/vendored/requests/compat.py +85 -0
  80. webull/core/vendored/requests/cookies.py +555 -0
  81. webull/core/vendored/requests/exceptions.py +136 -0
  82. webull/core/vendored/requests/help.py +134 -0
  83. webull/core/vendored/requests/hooks.py +48 -0
  84. webull/core/vendored/requests/models.py +960 -0
  85. webull/core/vendored/requests/packages/__init__.py +17 -0
  86. webull/core/vendored/requests/packages/certifi/__init__.py +17 -0
  87. webull/core/vendored/requests/packages/certifi/__main__.py +16 -0
  88. webull/core/vendored/requests/packages/certifi/cacert.pem +4433 -0
  89. webull/core/vendored/requests/packages/certifi/core.py +51 -0
  90. webull/core/vendored/requests/packages/chardet/__init__.py +53 -0
  91. webull/core/vendored/requests/packages/chardet/big5freq.py +400 -0
  92. webull/core/vendored/requests/packages/chardet/big5prober.py +61 -0
  93. webull/core/vendored/requests/packages/chardet/chardistribution.py +247 -0
  94. webull/core/vendored/requests/packages/chardet/charsetgroupprober.py +120 -0
  95. webull/core/vendored/requests/packages/chardet/charsetprober.py +159 -0
  96. webull/core/vendored/requests/packages/chardet/cli/__init__.py +1 -0
  97. webull/core/vendored/requests/packages/chardet/cli/chardetect.py +99 -0
  98. webull/core/vendored/requests/packages/chardet/codingstatemachine.py +102 -0
  99. webull/core/vendored/requests/packages/chardet/compat.py +48 -0
  100. webull/core/vendored/requests/packages/chardet/cp949prober.py +63 -0
  101. webull/core/vendored/requests/packages/chardet/enums.py +90 -0
  102. webull/core/vendored/requests/packages/chardet/escprober.py +115 -0
  103. webull/core/vendored/requests/packages/chardet/escsm.py +260 -0
  104. webull/core/vendored/requests/packages/chardet/eucjpprober.py +106 -0
  105. webull/core/vendored/requests/packages/chardet/euckrfreq.py +209 -0
  106. webull/core/vendored/requests/packages/chardet/euckrprober.py +61 -0
  107. webull/core/vendored/requests/packages/chardet/euctwfreq.py +401 -0
  108. webull/core/vendored/requests/packages/chardet/euctwprober.py +60 -0
  109. webull/core/vendored/requests/packages/chardet/gb2312freq.py +297 -0
  110. webull/core/vendored/requests/packages/chardet/gb2312prober.py +60 -0
  111. webull/core/vendored/requests/packages/chardet/hebrewprober.py +306 -0
  112. webull/core/vendored/requests/packages/chardet/jisfreq.py +339 -0
  113. webull/core/vendored/requests/packages/chardet/jpcntx.py +247 -0
  114. webull/core/vendored/requests/packages/chardet/langbulgarianmodel.py +242 -0
  115. webull/core/vendored/requests/packages/chardet/langcyrillicmodel.py +347 -0
  116. webull/core/vendored/requests/packages/chardet/langgreekmodel.py +239 -0
  117. webull/core/vendored/requests/packages/chardet/langhebrewmodel.py +214 -0
  118. webull/core/vendored/requests/packages/chardet/langhungarianmodel.py +239 -0
  119. webull/core/vendored/requests/packages/chardet/langthaimodel.py +213 -0
  120. webull/core/vendored/requests/packages/chardet/langturkishmodel.py +207 -0
  121. webull/core/vendored/requests/packages/chardet/latin1prober.py +159 -0
  122. webull/core/vendored/requests/packages/chardet/mbcharsetprober.py +105 -0
  123. webull/core/vendored/requests/packages/chardet/mbcsgroupprober.py +68 -0
  124. webull/core/vendored/requests/packages/chardet/mbcssm.py +586 -0
  125. webull/core/vendored/requests/packages/chardet/sbcharsetprober.py +146 -0
  126. webull/core/vendored/requests/packages/chardet/sbcsgroupprober.py +87 -0
  127. webull/core/vendored/requests/packages/chardet/sjisprober.py +106 -0
  128. webull/core/vendored/requests/packages/chardet/universaldetector.py +300 -0
  129. webull/core/vendored/requests/packages/chardet/utf8prober.py +96 -0
  130. webull/core/vendored/requests/packages/chardet/version.py +23 -0
  131. webull/core/vendored/requests/packages/urllib3/__init__.py +114 -0
  132. webull/core/vendored/requests/packages/urllib3/_collections.py +346 -0
  133. webull/core/vendored/requests/packages/urllib3/connection.py +405 -0
  134. webull/core/vendored/requests/packages/urllib3/connectionpool.py +910 -0
  135. webull/core/vendored/requests/packages/urllib3/contrib/__init__.py +0 -0
  136. webull/core/vendored/requests/packages/urllib3/contrib/_appengine_environ.py +44 -0
  137. webull/core/vendored/requests/packages/urllib3/contrib/_securetransport/__init__.py +0 -0
  138. webull/core/vendored/requests/packages/urllib3/contrib/_securetransport/bindings.py +607 -0
  139. webull/core/vendored/requests/packages/urllib3/contrib/_securetransport/low_level.py +360 -0
  140. webull/core/vendored/requests/packages/urllib3/contrib/appengine.py +303 -0
  141. webull/core/vendored/requests/packages/urllib3/contrib/ntlmpool.py +125 -0
  142. webull/core/vendored/requests/packages/urllib3/contrib/pyopenssl.py +484 -0
  143. webull/core/vendored/requests/packages/urllib3/contrib/securetransport.py +818 -0
  144. webull/core/vendored/requests/packages/urllib3/contrib/socks.py +206 -0
  145. webull/core/vendored/requests/packages/urllib3/exceptions.py +260 -0
  146. webull/core/vendored/requests/packages/urllib3/fields.py +192 -0
  147. webull/core/vendored/requests/packages/urllib3/filepost.py +112 -0
  148. webull/core/vendored/requests/packages/urllib3/packages/__init__.py +19 -0
  149. webull/core/vendored/requests/packages/urllib3/packages/backports/__init__.py +0 -0
  150. webull/core/vendored/requests/packages/urllib3/packages/backports/makefile.py +67 -0
  151. webull/core/vendored/requests/packages/urllib3/packages/ordered_dict.py +273 -0
  152. webull/core/vendored/requests/packages/urllib3/packages/six.py +882 -0
  153. webull/core/vendored/requests/packages/urllib3/packages/socks.py +887 -0
  154. webull/core/vendored/requests/packages/urllib3/packages/ssl_match_hostname/__init__.py +19 -0
  155. webull/core/vendored/requests/packages/urllib3/packages/ssl_match_hostname/_implementation.py +170 -0
  156. webull/core/vendored/requests/packages/urllib3/poolmanager.py +467 -0
  157. webull/core/vendored/requests/packages/urllib3/request.py +164 -0
  158. webull/core/vendored/requests/packages/urllib3/response.py +721 -0
  159. webull/core/vendored/requests/packages/urllib3/util/__init__.py +68 -0
  160. webull/core/vendored/requests/packages/urllib3/util/connection.py +148 -0
  161. webull/core/vendored/requests/packages/urllib3/util/queue.py +35 -0
  162. webull/core/vendored/requests/packages/urllib3/util/request.py +132 -0
  163. webull/core/vendored/requests/packages/urllib3/util/response.py +101 -0
  164. webull/core/vendored/requests/packages/urllib3/util/retry.py +426 -0
  165. webull/core/vendored/requests/packages/urllib3/util/selectors.py +601 -0
  166. webull/core/vendored/requests/packages/urllib3/util/ssl_.py +396 -0
  167. webull/core/vendored/requests/packages/urllib3/util/timeout.py +256 -0
  168. webull/core/vendored/requests/packages/urllib3/util/url.py +252 -0
  169. webull/core/vendored/requests/packages/urllib3/util/wait.py +164 -0
  170. webull/core/vendored/requests/packages.py +28 -0
  171. webull/core/vendored/requests/sessions.py +750 -0
  172. webull/core/vendored/requests/status_codes.py +105 -0
  173. webull/core/vendored/requests/structures.py +119 -0
  174. webull/core/vendored/requests/utils.py +916 -0
  175. webull/core/vendored/six.py +905 -0
  176. webull/data/__init__.py +3 -0
  177. webull/data/common/__init__.py +0 -0
  178. webull/data/common/category.py +26 -0
  179. webull/data/common/connect_ack.py +29 -0
  180. webull/data/common/direction.py +25 -0
  181. webull/data/common/exchange_code.py +33 -0
  182. webull/data/common/exercise_style.py +22 -0
  183. webull/data/common/expiration_cycle.py +26 -0
  184. webull/data/common/instrument_status.py +23 -0
  185. webull/data/common/option_type.py +20 -0
  186. webull/data/common/subscribe_type.py +22 -0
  187. webull/data/common/timespan.py +29 -0
  188. webull/data/data_client.py +35 -0
  189. webull/data/data_streaming_client.py +89 -0
  190. webull/data/internal/__init__.py +0 -0
  191. webull/data/internal/default_retry_policy.py +84 -0
  192. webull/data/internal/exceptions.py +60 -0
  193. webull/data/internal/quotes_client.py +314 -0
  194. webull/data/internal/quotes_decoder.py +40 -0
  195. webull/data/internal/quotes_payload_decoder.py +35 -0
  196. webull/data/internal/quotes_topic.py +36 -0
  197. webull/data/quotes/__init__.py +0 -0
  198. webull/data/quotes/instrument.py +33 -0
  199. webull/data/quotes/market_data.py +187 -0
  200. webull/data/quotes/market_streaming_data.py +66 -0
  201. webull/data/quotes/subscribe/__init__.py +0 -0
  202. webull/data/quotes/subscribe/ask_bid_result.py +49 -0
  203. webull/data/quotes/subscribe/basic_result.py +45 -0
  204. webull/data/quotes/subscribe/broker_result.py +33 -0
  205. webull/data/quotes/subscribe/message_pb2.py +37 -0
  206. webull/data/quotes/subscribe/order_result.py +30 -0
  207. webull/data/quotes/subscribe/payload_type.py +19 -0
  208. webull/data/quotes/subscribe/quote_decoder.py +28 -0
  209. webull/data/quotes/subscribe/quote_result.py +47 -0
  210. webull/data/quotes/subscribe/snapshot_decoder.py +30 -0
  211. webull/data/quotes/subscribe/snapshot_result.py +69 -0
  212. webull/data/quotes/subscribe/tick_decoder.py +29 -0
  213. webull/data/quotes/subscribe/tick_result.py +47 -0
  214. webull/data/request/__init__.py +0 -0
  215. webull/data/request/get_batch_historical_bars_request.py +43 -0
  216. webull/data/request/get_corp_action_request.py +47 -0
  217. webull/data/request/get_eod_bars_request.py +32 -0
  218. webull/data/request/get_historical_bars_request.py +43 -0
  219. webull/data/request/get_instruments_request.py +30 -0
  220. webull/data/request/get_quotes_request.py +35 -0
  221. webull/data/request/get_snapshot_request.py +38 -0
  222. webull/data/request/get_tick_request.py +37 -0
  223. webull/data/request/subscribe_request.py +43 -0
  224. webull/data/request/unsubscribe_request.py +42 -0
  225. webull/trade/__init__.py +2 -0
  226. webull/trade/common/__init__.py +0 -0
  227. webull/trade/common/account_type.py +22 -0
  228. webull/trade/common/category.py +29 -0
  229. webull/trade/common/combo_ticker_type.py +23 -0
  230. webull/trade/common/combo_type.py +31 -0
  231. webull/trade/common/currency.py +24 -0
  232. webull/trade/common/forbid_reason.py +27 -0
  233. webull/trade/common/instrument_type.py +27 -0
  234. webull/trade/common/markets.py +27 -0
  235. webull/trade/common/order_entrust_type.py +21 -0
  236. webull/trade/common/order_side.py +23 -0
  237. webull/trade/common/order_status.py +25 -0
  238. webull/trade/common/order_tif.py +24 -0
  239. webull/trade/common/order_type.py +30 -0
  240. webull/trade/common/trade_policy.py +22 -0
  241. webull/trade/common/trading_date_type.py +24 -0
  242. webull/trade/common/trailing_type.py +23 -0
  243. webull/trade/events/__init__.py +0 -0
  244. webull/trade/events/default_retry_policy.py +64 -0
  245. webull/trade/events/events_pb2.py +43 -0
  246. webull/trade/events/events_pb2_grpc.py +66 -0
  247. webull/trade/events/signature_composer.py +61 -0
  248. webull/trade/events/types.py +21 -0
  249. webull/trade/request/__init__.py +0 -0
  250. webull/trade/request/cancel_order_request.py +28 -0
  251. webull/trade/request/get_account_balance_request.py +28 -0
  252. webull/trade/request/get_account_positions_request.py +30 -0
  253. webull/trade/request/get_account_profile_request.py +26 -0
  254. webull/trade/request/get_app_subscriptions.py +28 -0
  255. webull/trade/request/get_open_orders_request.py +30 -0
  256. webull/trade/request/get_order_detail_request.py +27 -0
  257. webull/trade/request/get_today_orders_request.py +31 -0
  258. webull/trade/request/get_trade_calendar_request.py +30 -0
  259. webull/trade/request/get_trade_instrument_detail_request.py +24 -0
  260. webull/trade/request/get_trade_security_detail_request.py +42 -0
  261. webull/trade/request/get_tradeable_instruments_request.py +27 -0
  262. webull/trade/request/palce_order_request.py +91 -0
  263. webull/trade/request/place_order_request_v2.py +58 -0
  264. webull/trade/request/replace_order_request.py +73 -0
  265. webull/trade/request/replace_order_request_v2.py +38 -0
  266. webull/trade/request/v2/__init__.py +0 -0
  267. webull/trade/request/v2/cancel_option_request.py +28 -0
  268. webull/trade/request/v2/cancel_order_request.py +28 -0
  269. webull/trade/request/v2/get_account_balance_request.py +28 -0
  270. webull/trade/request/v2/get_account_list.py +23 -0
  271. webull/trade/request/v2/get_account_positions_request.py +24 -0
  272. webull/trade/request/v2/get_order_detail_request.py +26 -0
  273. webull/trade/request/v2/get_order_history_request.py +35 -0
  274. webull/trade/request/v2/palce_order_request.py +87 -0
  275. webull/trade/request/v2/place_option_request.py +64 -0
  276. webull/trade/request/v2/preview_option_request.py +28 -0
  277. webull/trade/request/v2/preview_order_request.py +59 -0
  278. webull/trade/request/v2/replace_option_request.py +28 -0
  279. webull/trade/request/v2/replace_order_request.py +57 -0
  280. webull/trade/trade/__init__.py +0 -0
  281. webull/trade/trade/account_info.py +83 -0
  282. webull/trade/trade/order_operation.py +246 -0
  283. webull/trade/trade/trade_calendar.py +37 -0
  284. webull/trade/trade/trade_instrument.py +72 -0
  285. webull/trade/trade/v2/__init__.py +0 -0
  286. webull/trade/trade/v2/account_info_v2.py +55 -0
  287. webull/trade/trade/v2/order_operation_v2.py +206 -0
  288. webull/trade/trade_client.py +43 -0
  289. webull/trade/trade_events_client.py +233 -0
  290. webull_openapi_python_sdk-1.0.0.dist-info/METADATA +28 -0
  291. webull_openapi_python_sdk-1.0.0.dist-info/RECORD +295 -0
  292. webull_openapi_python_sdk-1.0.0.dist-info/WHEEL +5 -0
  293. webull_openapi_python_sdk-1.0.0.dist-info/licenses/LICENSE +202 -0
  294. webull_openapi_python_sdk-1.0.0.dist-info/licenses/NOTICE +56 -0
  295. webull_openapi_python_sdk-1.0.0.dist-info/top_level.txt +2 -0
@@ -0,0 +1,750 @@
1
+ # Copyright 2022 Webull
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ # -*- coding: utf-8 -*-
16
+
17
+ """
18
+ requests.session
19
+ ~~~~~~~~~~~~~~~~
20
+
21
+ This module provides a Session object to manage and persist settings across
22
+ requests (cookies, auth, proxies).
23
+ """
24
+ import os
25
+ import platform
26
+ import time
27
+ from datetime import timedelta
28
+
29
+ from .auth import _basic_auth_str
30
+ from .compat import cookielib, is_py3, OrderedDict, urljoin, urlparse, Mapping
31
+ from .cookies import (
32
+ cookiejar_from_dict, extract_cookies_to_jar, RequestsCookieJar, merge_cookies)
33
+ from .models import Request, PreparedRequest, DEFAULT_REDIRECT_LIMIT
34
+ from .hooks import default_hooks, dispatch_hook
35
+ from ._internal_utils import to_native_string
36
+ from .utils import to_key_val_list, default_headers
37
+ from .exceptions import (
38
+ TooManyRedirects, InvalidSchema, ChunkedEncodingError, ContentDecodingError)
39
+
40
+ from .structures import CaseInsensitiveDict
41
+ from .adapters import HTTPAdapter
42
+
43
+ from .utils import (
44
+ requote_uri, get_environ_proxies, get_netrc_auth, should_bypass_proxies,
45
+ get_auth_from_url, rewind_body
46
+ )
47
+
48
+ from .status_codes import codes
49
+
50
+ # formerly defined here, reexposed here for backward compatibility
51
+ from .models import REDIRECT_STATI
52
+
53
+ # Preferred clock, based on which one is more accurate on a given system.
54
+ if platform.system() == 'Windows':
55
+ try: # Python 3.3+
56
+ preferred_clock = time.perf_counter
57
+ except AttributeError: # Earlier than Python 3.
58
+ preferred_clock = time.clock
59
+ else:
60
+ preferred_clock = time.time
61
+
62
+
63
+ def merge_setting(request_setting, session_setting, dict_class=OrderedDict):
64
+ """Determines appropriate setting for a given request, taking into account
65
+ the explicit setting on that request, and the setting in the session. If a
66
+ setting is a dictionary, they will be merged together using `dict_class`
67
+ """
68
+
69
+ if session_setting is None:
70
+ return request_setting
71
+
72
+ if request_setting is None:
73
+ return session_setting
74
+
75
+ # Bypass if not a dictionary (e.g. verify)
76
+ if not (
77
+ isinstance(session_setting, Mapping) and
78
+ isinstance(request_setting, Mapping)
79
+ ):
80
+ return request_setting
81
+
82
+ merged_setting = dict_class(to_key_val_list(session_setting))
83
+ merged_setting.update(to_key_val_list(request_setting))
84
+
85
+ # Remove keys that are set to None. Extract keys first to avoid altering
86
+ # the dictionary during iteration.
87
+ none_keys = [k for (k, v) in merged_setting.items() if v is None]
88
+ for key in none_keys:
89
+ del merged_setting[key]
90
+
91
+ return merged_setting
92
+
93
+
94
+ def merge_hooks(request_hooks, session_hooks, dict_class=OrderedDict):
95
+ """Properly merges both requests and session hooks.
96
+
97
+ This is necessary because when request_hooks == {'response': []}, the
98
+ merge breaks Session hooks entirely.
99
+ """
100
+ if session_hooks is None or session_hooks.get('response') == []:
101
+ return request_hooks
102
+
103
+ if request_hooks is None or request_hooks.get('response') == []:
104
+ return session_hooks
105
+
106
+ return merge_setting(request_hooks, session_hooks, dict_class)
107
+
108
+
109
+ class SessionRedirectMixin(object):
110
+
111
+ def get_redirect_target(self, resp):
112
+ """Receives a Response. Returns a redirect URI or ``None``"""
113
+ # Due to the nature of how requests processes redirects this method will
114
+ # be called at least once upon the original response and at least twice
115
+ # on each subsequent redirect response (if any).
116
+ # If a custom mixin is used to handle this logic, it may be advantageous
117
+ # to cache the redirect location onto the response object as a private
118
+ # attribute.
119
+ if resp.is_redirect:
120
+ location = resp.headers['location']
121
+ # Currently the underlying http module on py3 decode headers
122
+ # in latin1, but empirical evidence suggests that latin1 is very
123
+ # rarely used with non-ASCII characters in HTTP headers.
124
+ # It is more likely to get UTF8 header rather than latin1.
125
+ # This causes incorrect handling of UTF8 encoded location headers.
126
+ # To solve this, we re-encode the location in latin1.
127
+ if is_py3:
128
+ location = location.encode('latin1')
129
+ return to_native_string(location, 'utf8')
130
+ return None
131
+
132
+ def resolve_redirects(self, resp, req, stream=False, timeout=None,
133
+ verify=True, cert=None, proxies=None, yield_requests=False, **adapter_kwargs):
134
+ """Receives a Response. Returns a generator of Responses or Requests."""
135
+
136
+ hist = [] # keep track of history
137
+
138
+ url = self.get_redirect_target(resp)
139
+ while url:
140
+ prepared_request = req.copy()
141
+
142
+ # Update history and keep track of redirects.
143
+ # resp.history must ignore the original request in this loop
144
+ hist.append(resp)
145
+ resp.history = hist[1:]
146
+
147
+ try:
148
+ resp.content # Consume socket so it can be released
149
+ except (ChunkedEncodingError, ContentDecodingError, RuntimeError):
150
+ resp.raw.read(decode_content=False)
151
+
152
+ if len(resp.history) >= self.max_redirects:
153
+ raise TooManyRedirects('Exceeded %s redirects.' % self.max_redirects, response=resp)
154
+
155
+ # Release the connection back into the pool.
156
+ resp.close()
157
+
158
+ # Handle redirection without scheme (see: RFC 1808 Section 4)
159
+ if url.startswith('//'):
160
+ parsed_rurl = urlparse(resp.url)
161
+ url = '%s:%s' % (to_native_string(parsed_rurl.scheme), url)
162
+
163
+ # The scheme should be lower case...
164
+ parsed = urlparse(url)
165
+ url = parsed.geturl()
166
+
167
+ # Facilitate relative 'location' headers, as allowed by RFC 7231.
168
+ # (e.g. '/path/to/resource' instead of 'http://domain.tld/path/to/resource')
169
+ # Compliant with RFC3986, we percent encode the url.
170
+ if not parsed.netloc:
171
+ url = urljoin(resp.url, requote_uri(url))
172
+ else:
173
+ url = requote_uri(url)
174
+
175
+ prepared_request.url = to_native_string(url)
176
+
177
+ self.rebuild_method(prepared_request, resp)
178
+
179
+ # https://github.com/requests/requests/issues/1084
180
+ if resp.status_code not in (codes.temporary_redirect, codes.permanent_redirect):
181
+ # https://github.com/requests/requests/issues/3490
182
+ purged_headers = ('Content-Length', 'Content-Type', 'Transfer-Encoding')
183
+ for header in purged_headers:
184
+ prepared_request.headers.pop(header, None)
185
+ prepared_request.body = None
186
+
187
+ headers = prepared_request.headers
188
+ try:
189
+ del headers['Cookie']
190
+ except KeyError:
191
+ pass
192
+
193
+ # Extract any cookies sent on the response to the cookiejar
194
+ # in the new request. Because we've mutated our copied prepared
195
+ # request, use the old one that we haven't yet touched.
196
+ extract_cookies_to_jar(prepared_request._cookies, req, resp.raw)
197
+ merge_cookies(prepared_request._cookies, self.cookies)
198
+ prepared_request.prepare_cookies(prepared_request._cookies)
199
+
200
+ # Rebuild auth and proxy information.
201
+ proxies = self.rebuild_proxies(prepared_request, proxies)
202
+ self.rebuild_auth(prepared_request, resp)
203
+
204
+ # A failed tell() sets `_body_position` to `object()`. This non-None
205
+ # value ensures `rewindable` will be True, allowing us to raise an
206
+ # UnrewindableBodyError, instead of hanging the connection.
207
+ rewindable = (
208
+ prepared_request._body_position is not None and
209
+ ('Content-Length' in headers or 'Transfer-Encoding' in headers)
210
+ )
211
+
212
+ # Attempt to rewind consumed file-like object.
213
+ if rewindable:
214
+ rewind_body(prepared_request)
215
+
216
+ # Override the original request.
217
+ req = prepared_request
218
+
219
+ if yield_requests:
220
+ yield req
221
+ else:
222
+
223
+ resp = self.send(
224
+ req,
225
+ stream=stream,
226
+ timeout=timeout,
227
+ verify=verify,
228
+ cert=cert,
229
+ proxies=proxies,
230
+ allow_redirects=False,
231
+ **adapter_kwargs
232
+ )
233
+
234
+ extract_cookies_to_jar(self.cookies, prepared_request, resp.raw)
235
+
236
+ # extract redirect url, if any, for the next loop
237
+ url = self.get_redirect_target(resp)
238
+ yield resp
239
+
240
+ def rebuild_auth(self, prepared_request, response):
241
+ """When being redirected we may want to strip authentication from the
242
+ request to avoid leaking credentials. This method intelligently removes
243
+ and reapplies authentication where possible to avoid credential loss.
244
+ """
245
+ headers = prepared_request.headers
246
+ url = prepared_request.url
247
+
248
+ if 'Authorization' in headers:
249
+ # If we get redirected to a new host, we should strip out any
250
+ # authentication headers.
251
+ original_parsed = urlparse(response.request.url)
252
+ redirect_parsed = urlparse(url)
253
+
254
+ if (original_parsed.hostname != redirect_parsed.hostname):
255
+ del headers['Authorization']
256
+
257
+ # .netrc might have more auth for us on our new host.
258
+ new_auth = get_netrc_auth(url) if self.trust_env else None
259
+ if new_auth is not None:
260
+ prepared_request.prepare_auth(new_auth)
261
+
262
+ return
263
+
264
+ def rebuild_proxies(self, prepared_request, proxies):
265
+ """This method re-evaluates the proxy configuration by considering the
266
+ environment variables. If we are redirected to a URL covered by
267
+ NO_PROXY, we strip the proxy configuration. Otherwise, we set missing
268
+ proxy keys for this URL (in case they were stripped by a previous
269
+ redirect).
270
+
271
+ This method also replaces the Proxy-Authorization header where
272
+ necessary.
273
+
274
+ :rtype: dict
275
+ """
276
+ proxies = proxies if proxies is not None else {}
277
+ headers = prepared_request.headers
278
+ url = prepared_request.url
279
+ scheme = urlparse(url).scheme
280
+ new_proxies = proxies.copy()
281
+ no_proxy = proxies.get('no_proxy')
282
+
283
+ bypass_proxy = should_bypass_proxies(url, no_proxy=no_proxy)
284
+ if self.trust_env and not bypass_proxy:
285
+ environ_proxies = get_environ_proxies(url, no_proxy=no_proxy)
286
+
287
+ proxy = environ_proxies.get(scheme, environ_proxies.get('all'))
288
+
289
+ if proxy:
290
+ new_proxies.setdefault(scheme, proxy)
291
+
292
+ if 'Proxy-Authorization' in headers:
293
+ del headers['Proxy-Authorization']
294
+
295
+ try:
296
+ username, password = get_auth_from_url(new_proxies[scheme])
297
+ except KeyError:
298
+ username, password = None, None
299
+
300
+ if username and password:
301
+ headers['Proxy-Authorization'] = _basic_auth_str(username, password)
302
+
303
+ return new_proxies
304
+
305
+ def rebuild_method(self, prepared_request, response):
306
+ """When being redirected we may want to change the method of the request
307
+ based on certain specs or browser behavior.
308
+ """
309
+ method = prepared_request.method
310
+
311
+ # http://tools.ietf.org/html/rfc7231#section-6.4.4
312
+ if response.status_code == codes.see_other and method != 'HEAD':
313
+ method = 'GET'
314
+
315
+ # Do what the browsers do, despite standards...
316
+ # First, turn 302s into GETs.
317
+ if response.status_code == codes.found and method != 'HEAD':
318
+ method = 'GET'
319
+
320
+ # Second, if a POST is responded to with a 301, turn it into a GET.
321
+ # This bizarre behaviour is explained in Issue 1704.
322
+ if response.status_code == codes.moved and method == 'POST':
323
+ method = 'GET'
324
+
325
+ prepared_request.method = method
326
+
327
+
328
+ class Session(SessionRedirectMixin):
329
+ """A Requests session.
330
+
331
+ Provides cookie persistence, connection-pooling, and configuration.
332
+
333
+ Basic Usage::
334
+
335
+ >>> import requests
336
+ >>> s = requests.Session()
337
+ >>> s.get('http://httpbin.org/get')
338
+ <Response [200]>
339
+
340
+ Or as a context manager::
341
+
342
+ >>> with requests.Session() as s:
343
+ >>> s.get('http://httpbin.org/get')
344
+ <Response [200]>
345
+ """
346
+
347
+ __attrs__ = [
348
+ 'headers', 'cookies', 'auth', 'proxies', 'hooks', 'params', 'verify',
349
+ 'cert', 'prefetch', 'adapters', 'stream', 'trust_env',
350
+ 'max_redirects',
351
+ ]
352
+
353
+ def __init__(self):
354
+
355
+ #: A case-insensitive dictionary of headers to be sent on each
356
+ #: :class:`Request <Request>` sent from this
357
+ #: :class:`Session <Session>`.
358
+ self.headers = default_headers()
359
+
360
+ #: Default Authentication tuple or object to attach to
361
+ #: :class:`Request <Request>`.
362
+ self.auth = None
363
+
364
+ #: Dictionary mapping protocol or protocol and host to the URL of the proxy
365
+ #: (e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'}) to
366
+ #: be used on each :class:`Request <Request>`.
367
+ self.proxies = {}
368
+
369
+ #: Event-handling hooks.
370
+ self.hooks = default_hooks()
371
+
372
+ #: Dictionary of querystring data to attach to each
373
+ #: :class:`Request <Request>`. The dictionary values may be lists for
374
+ #: representing multivalued query parameters.
375
+ self.params = {}
376
+
377
+ #: Stream response content default.
378
+ self.stream = False
379
+
380
+ #: SSL Verification default.
381
+ self.verify = True
382
+
383
+ #: SSL client certificate default, if String, path to ssl client
384
+ #: cert file (.pem). If Tuple, ('cert', 'key') pair.
385
+ self.cert = None
386
+
387
+ #: Maximum number of redirects allowed. If the request exceeds this
388
+ #: limit, a :class:`TooManyRedirects` exception is raised.
389
+ #: This defaults to requests.models.DEFAULT_REDIRECT_LIMIT, which is
390
+ #: 30.
391
+ self.max_redirects = DEFAULT_REDIRECT_LIMIT
392
+
393
+ #: Trust environment settings for proxy configuration, default
394
+ #: authentication and similar.
395
+ self.trust_env = True
396
+
397
+ #: A CookieJar containing all currently outstanding cookies set on this
398
+ #: session. By default it is a
399
+ #: :class:`RequestsCookieJar <requests.cookies.RequestsCookieJar>`, but
400
+ #: may be any other ``cookielib.CookieJar`` compatible object.
401
+ self.cookies = cookiejar_from_dict({})
402
+
403
+ # Default connection adapters.
404
+ self.adapters = OrderedDict()
405
+ self.mount('https://', HTTPAdapter())
406
+ self.mount('http://', HTTPAdapter())
407
+
408
+ def __enter__(self):
409
+ return self
410
+
411
+ def __exit__(self, *args):
412
+ self.close()
413
+
414
+ def prepare_request(self, request):
415
+ """Constructs a :class:`PreparedRequest <PreparedRequest>` for
416
+ transmission and returns it. The :class:`PreparedRequest` has settings
417
+ merged from the :class:`Request <Request>` instance and those of the
418
+ :class:`Session`.
419
+
420
+ :param request: :class:`Request` instance to prepare with this
421
+ session's settings.
422
+ :rtype: requests.PreparedRequest
423
+ """
424
+ cookies = request.cookies or {}
425
+
426
+ # Bootstrap CookieJar.
427
+ if not isinstance(cookies, cookielib.CookieJar):
428
+ cookies = cookiejar_from_dict(cookies)
429
+
430
+ # Merge with session cookies
431
+ merged_cookies = merge_cookies(
432
+ merge_cookies(RequestsCookieJar(), self.cookies), cookies)
433
+
434
+ # Set environment's basic authentication if not explicitly set.
435
+ auth = request.auth
436
+ if self.trust_env and not auth and not self.auth:
437
+ auth = get_netrc_auth(request.url)
438
+
439
+ p = PreparedRequest()
440
+ p.prepare(
441
+ method=request.method.upper(),
442
+ url=request.url,
443
+ files=request.files,
444
+ data=request.data,
445
+ json=request.json,
446
+ headers=merge_setting(request.headers, self.headers, dict_class=CaseInsensitiveDict),
447
+ params=merge_setting(request.params, self.params),
448
+ auth=merge_setting(auth, self.auth),
449
+ cookies=merged_cookies,
450
+ hooks=merge_hooks(request.hooks, self.hooks),
451
+ )
452
+ return p
453
+
454
+ def request(self, method, url,
455
+ params=None, data=None, headers=None, cookies=None, files=None,
456
+ auth=None, timeout=None, allow_redirects=True, proxies=None,
457
+ hooks=None, stream=None, verify=None, cert=None, json=None):
458
+ """Constructs a :class:`Request <Request>`, prepares it and sends it.
459
+ Returns :class:`Response <Response>` object.
460
+
461
+ :param method: method for the new :class:`Request` object.
462
+ :param url: URL for the new :class:`Request` object.
463
+ :param params: (optional) Dictionary or bytes to be sent in the query
464
+ string for the :class:`Request`.
465
+ :param data: (optional) Dictionary, bytes, or file-like object to send
466
+ in the body of the :class:`Request`.
467
+ :param json: (optional) json to send in the body of the
468
+ :class:`Request`.
469
+ :param headers: (optional) Dictionary of HTTP Headers to send with the
470
+ :class:`Request`.
471
+ :param cookies: (optional) Dict or CookieJar object to send with the
472
+ :class:`Request`.
473
+ :param files: (optional) Dictionary of ``'filename': file-like-objects``
474
+ for multipart encoding upload.
475
+ :param auth: (optional) Auth tuple or callable to enable
476
+ Basic/Digest/Custom HTTP Auth.
477
+ :param timeout: (optional) How long to wait for the server to send
478
+ data before giving up, as a float, or a :ref:`(connect timeout,
479
+ read timeout) <timeouts>` tuple.
480
+ :type timeout: float or tuple
481
+ :param allow_redirects: (optional) Set to True by default.
482
+ :type allow_redirects: bool
483
+ :param proxies: (optional) Dictionary mapping protocol or protocol and
484
+ hostname to the URL of the proxy.
485
+ :param stream: (optional) whether to immediately download the response
486
+ content. Defaults to ``False``.
487
+ :param verify: (optional) Either a boolean, in which case it controls whether we verify
488
+ the server's TLS certificate, or a string, in which case it must be a path
489
+ to a CA bundle to use. Defaults to ``True``.
490
+ :param cert: (optional) if String, path to ssl client cert file (.pem).
491
+ If Tuple, ('cert', 'key') pair.
492
+ :rtype: requests.Response
493
+ """
494
+ # Create the Request.
495
+ req = Request(
496
+ method=method.upper(),
497
+ url=url,
498
+ headers=headers,
499
+ files=files,
500
+ data=data or {},
501
+ json=json,
502
+ params=params or {},
503
+ auth=auth,
504
+ cookies=cookies,
505
+ hooks=hooks,
506
+ )
507
+ prep = self.prepare_request(req)
508
+
509
+ proxies = proxies or {}
510
+
511
+ settings = self.merge_environment_settings(
512
+ prep.url, proxies, stream, verify, cert
513
+ )
514
+
515
+ # Send the request.
516
+ send_kwargs = {
517
+ 'timeout': timeout,
518
+ 'allow_redirects': allow_redirects,
519
+ }
520
+ send_kwargs.update(settings)
521
+ resp = self.send(prep, **send_kwargs)
522
+
523
+ return resp
524
+
525
+ def get(self, url, **kwargs):
526
+ r"""Sends a GET request. Returns :class:`Response` object.
527
+
528
+ :param url: URL for the new :class:`Request` object.
529
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
530
+ :rtype: requests.Response
531
+ """
532
+
533
+ kwargs.setdefault('allow_redirects', True)
534
+ return self.request('GET', url, **kwargs)
535
+
536
+ def options(self, url, **kwargs):
537
+ r"""Sends a OPTIONS request. Returns :class:`Response` object.
538
+
539
+ :param url: URL for the new :class:`Request` object.
540
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
541
+ :rtype: requests.Response
542
+ """
543
+
544
+ kwargs.setdefault('allow_redirects', True)
545
+ return self.request('OPTIONS', url, **kwargs)
546
+
547
+ def head(self, url, **kwargs):
548
+ r"""Sends a HEAD request. Returns :class:`Response` object.
549
+
550
+ :param url: URL for the new :class:`Request` object.
551
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
552
+ :rtype: requests.Response
553
+ """
554
+
555
+ kwargs.setdefault('allow_redirects', False)
556
+ return self.request('HEAD', url, **kwargs)
557
+
558
+ def post(self, url, data=None, json=None, **kwargs):
559
+ r"""Sends a POST request. Returns :class:`Response` object.
560
+
561
+ :param url: URL for the new :class:`Request` object.
562
+ :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
563
+ :param json: (optional) json to send in the body of the :class:`Request`.
564
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
565
+ :rtype: requests.Response
566
+ """
567
+
568
+ return self.request('POST', url, data=data, json=json, **kwargs)
569
+
570
+ def put(self, url, data=None, **kwargs):
571
+ r"""Sends a PUT request. Returns :class:`Response` object.
572
+
573
+ :param url: URL for the new :class:`Request` object.
574
+ :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
575
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
576
+ :rtype: requests.Response
577
+ """
578
+
579
+ return self.request('PUT', url, data=data, **kwargs)
580
+
581
+ def patch(self, url, data=None, **kwargs):
582
+ r"""Sends a PATCH request. Returns :class:`Response` object.
583
+
584
+ :param url: URL for the new :class:`Request` object.
585
+ :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
586
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
587
+ :rtype: requests.Response
588
+ """
589
+
590
+ return self.request('PATCH', url, data=data, **kwargs)
591
+
592
+ def delete(self, url, **kwargs):
593
+ r"""Sends a DELETE request. Returns :class:`Response` object.
594
+
595
+ :param url: URL for the new :class:`Request` object.
596
+ :param \*\*kwargs: Optional arguments that ``request`` takes.
597
+ :rtype: requests.Response
598
+ """
599
+
600
+ return self.request('DELETE', url, **kwargs)
601
+
602
+ def send(self, request, **kwargs):
603
+ """Send a given PreparedRequest.
604
+
605
+ :rtype: requests.Response
606
+ """
607
+ # Set defaults that the hooks can utilize to ensure they always have
608
+ # the correct parameters to reproduce the previous request.
609
+ kwargs.setdefault('stream', self.stream)
610
+ kwargs.setdefault('verify', self.verify)
611
+ kwargs.setdefault('cert', self.cert)
612
+ kwargs.setdefault('proxies', self.proxies)
613
+
614
+ # It's possible that users might accidentally send a Request object.
615
+ # Guard against that specific failure case.
616
+ if isinstance(request, Request):
617
+ raise ValueError('You can only send PreparedRequests.')
618
+
619
+ # Set up variables needed for resolve_redirects and dispatching of hooks
620
+ allow_redirects = kwargs.pop('allow_redirects', True)
621
+ stream = kwargs.get('stream')
622
+ hooks = request.hooks
623
+
624
+ # Get the appropriate adapter to use
625
+ adapter = self.get_adapter(url=request.url)
626
+
627
+ # Start time (approximately) of the request
628
+ start = preferred_clock()
629
+
630
+ # Send the request
631
+ r = adapter.send(request, **kwargs)
632
+
633
+ # Total elapsed time of the request (approximately)
634
+ elapsed = preferred_clock() - start
635
+ r.elapsed = timedelta(seconds=elapsed)
636
+
637
+ # Response manipulation hooks
638
+ r = dispatch_hook('response', hooks, r, **kwargs)
639
+
640
+ # Persist cookies
641
+ if r.history:
642
+
643
+ # If the hooks create history then we want those cookies too
644
+ for resp in r.history:
645
+ extract_cookies_to_jar(self.cookies, resp.request, resp.raw)
646
+
647
+ extract_cookies_to_jar(self.cookies, request, r.raw)
648
+
649
+ # Redirect resolving generator.
650
+ gen = self.resolve_redirects(r, request, **kwargs)
651
+
652
+ # Resolve redirects if allowed.
653
+ history = [resp for resp in gen] if allow_redirects else []
654
+
655
+ # Shuffle things around if there's history.
656
+ if history:
657
+ # Insert the first (original) request at the start
658
+ history.insert(0, r)
659
+ # Get the last request made
660
+ r = history.pop()
661
+ r.history = history
662
+
663
+ # If redirects aren't being followed, store the response on the Request for Response.next().
664
+ if not allow_redirects:
665
+ try:
666
+ r._next = next(self.resolve_redirects(r, request, yield_requests=True, **kwargs))
667
+ except StopIteration:
668
+ pass
669
+
670
+ if not stream:
671
+ r.content
672
+
673
+ return r
674
+
675
+ def merge_environment_settings(self, url, proxies, stream, verify, cert):
676
+ """
677
+ Check the environment and merge it with some settings.
678
+
679
+ :rtype: dict
680
+ """
681
+ # Gather clues from the surrounding environment.
682
+ if self.trust_env:
683
+ # Set environment's proxies.
684
+ no_proxy = proxies.get('no_proxy') if proxies is not None else None
685
+ env_proxies = get_environ_proxies(url, no_proxy=no_proxy)
686
+ for (k, v) in env_proxies.items():
687
+ proxies.setdefault(k, v)
688
+
689
+ # Look for requests environment configuration and be compatible
690
+ # with cURL.
691
+ if verify is True or verify is None:
692
+ verify = (os.environ.get('REQUESTS_CA_BUNDLE') or
693
+ os.environ.get('CURL_CA_BUNDLE'))
694
+
695
+ # Merge all the kwargs.
696
+ proxies = merge_setting(proxies, self.proxies)
697
+ stream = merge_setting(stream, self.stream)
698
+ verify = merge_setting(verify, self.verify)
699
+ cert = merge_setting(cert, self.cert)
700
+
701
+ return {'verify': verify, 'proxies': proxies, 'stream': stream,
702
+ 'cert': cert}
703
+
704
+ def get_adapter(self, url):
705
+ """
706
+ Returns the appropriate connection adapter for the given URL.
707
+
708
+ :rtype: requests.adapters.BaseAdapter
709
+ """
710
+ for (prefix, adapter) in self.adapters.items():
711
+
712
+ if url.lower().startswith(prefix):
713
+ return adapter
714
+
715
+ # Nothing matches :-/
716
+ raise InvalidSchema("No connection adapters were found for '%s'" % url)
717
+
718
+ def close(self):
719
+ """Closes all adapters and as such the session"""
720
+ for v in self.adapters.values():
721
+ v.close()
722
+
723
+ def mount(self, prefix, adapter):
724
+ """Registers a connection adapter to a prefix.
725
+
726
+ Adapters are sorted in descending order by prefix length.
727
+ """
728
+ self.adapters[prefix] = adapter
729
+ keys_to_move = [k for k in self.adapters if len(k) < len(prefix)]
730
+
731
+ for key in keys_to_move:
732
+ self.adapters[key] = self.adapters.pop(key)
733
+
734
+ def __getstate__(self):
735
+ state = dict((attr, getattr(self, attr, None)) for attr in self.__attrs__)
736
+ return state
737
+
738
+ def __setstate__(self, state):
739
+ for attr, value in state.items():
740
+ setattr(self, attr, value)
741
+
742
+
743
+ def session():
744
+ """
745
+ Returns a :class:`Session` for context-management.
746
+
747
+ :rtype: Session
748
+ """
749
+
750
+ return Session()