-
-
Notifications
You must be signed in to change notification settings - Fork 73
/
client.py
260 lines (227 loc) · 8.35 KB
/
client.py
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
from __future__ import annotations
import json
import logging
import os
from typing import Any, Mapping, Optional, Union
import aiohttp
from aiohttp import hdrs
from aiohttp.client import _RequestContextManager
from .auth import Auth
from .request import ClientRequest
from .typedefs import WsBytesHandler, WsJsonHandler, WsStrHandler
from .ws import ClientWebSocketResponse, WebSocketRunner
logger = logging.getLogger(__name__)
class Client:
"""
HTTPリクエストクライアントクラス
.. note::
引数 apis は省略できます。
:Example:
.. code-block:: python
async def main():
async with pybotters.Client(apis={'example': ['KEY', 'SECRET']}) as client:
r = await client.get('https://...', params={'foo': 'bar'})
print(await r.json())
.. code-block:: python
async def main():
async with pybotters.Client(apis={'example': ['KEY', 'SECRET']}) as client:
wstask = await client.ws_connect(
'wss://...',
send_json={'foo': 'bar'},
hdlr_json=pybotters.print_handler
)
await wstask
# Ctrl+C to break
Basic API
パッケージトップレベルで利用できるHTTPリクエスト関数です。 これらは同期関数です。 内部的にpybotters.Clientをラップしています。
:Example:
.. code-block:: python
r = pybotters.get(
'https://...',
params={'foo': 'bar'},
apis={'example': ['KEY', 'SECRET']}
)
print(r.text())
print(r.json())
.. code-block:: python
pybotters.ws_connect(
'wss://...',
send_json={'foo': 'bar'},
hdlr_json=pybotters.print_handler,
apis={'example': ['KEY', 'SECRET']}
)
# Ctrl+C to break
"""
_session: aiohttp.ClientSession
_base_url: str
def __init__(
self,
apis: Optional[Union[dict[str, list[str]], str]] = None,
base_url: str = '',
**kwargs: Any,
) -> None:
"""
:param apis: APIキー・シークレットのデータ(optional) ex: {'exchange': ['key', 'secret']}
:param base_url: リクエストメソッドの url の前方に自動付加するURL(optional)
:param ``**kwargs``: aiohttp.Client.requestに渡されるキーワード引数(optional)
"""
self._session = aiohttp.ClientSession(
request_class=ClientRequest,
ws_response_class=ClientWebSocketResponse,
**kwargs,
)
apis = self._load_apis(apis)
self._session.__dict__['_apis'] = self._encode_apis(apis)
self._base_url = base_url
async def __aenter__(self) -> 'Client':
return self
async def __aexit__(self, *args: Any) -> None:
await self.close()
async def close(self) -> None:
await self._session.close()
def _request(
self,
method: str,
url: str,
*,
params: Optional[Mapping[str, Any]] = None,
data: Optional[dict[str, Any]] = None,
auth: Optional[Auth] = Auth,
**kwargs: Any,
) -> _RequestContextManager:
return self._session.request(
method=method,
url=self._base_url + url,
params=params,
data=data,
auth=auth,
**kwargs,
)
def request(
self,
method: str,
url: str,
*,
params: Optional[Mapping[str, str]] = None,
data: Any = None,
**kwargs: Any,
) -> _RequestContextManager:
"""
:param method: GET, POST, PUT, DELETE などのHTTPメソッド
:param url: リクエストURL
:param params: URLのクエリ文字列(optional)
:param data: リクエストボディ(optional)
:param headers: リクエストヘッダー(optional)
:param auth: API自動認証の機能の有効/無効。デフォルトで有効。auth=Noneを指定することで無効になります(optional)
:param ``kwargs``: aiohttp.Client.requestに渡されるキーワード引数(optional)
"""
return self._request(method, url, params=params, data=data, **kwargs)
def get(
self,
url: str,
*,
params: Optional[Mapping[str, str]] = None,
**kwargs: Any,
) -> _RequestContextManager:
return self._request(hdrs.METH_GET, url, params=params, **kwargs)
def post(
self,
url: str,
*,
data: Any = None,
**kwargs: Any,
) -> _RequestContextManager:
return self._request(hdrs.METH_POST, url, data=data, **kwargs)
def put(
self,
url: str,
*,
data: Any = None,
**kwargs: Any,
) -> _RequestContextManager:
return self._request(hdrs.METH_PUT, url, data=data, **kwargs)
def delete(
self,
url: str,
*,
data: Any = None,
**kwargs: Any,
) -> _RequestContextManager:
return self._request(hdrs.METH_DELETE, url, data=data, **kwargs)
async def ws_connect(
self,
url: str,
*,
send_str: Optional[Union[str, list[str]]] = None,
send_bytes: Optional[Union[bytes, list[bytes]]] = None,
send_json: Any = None,
hdlr_str: Optional[WsStrHandler] = None,
hdlr_bytes: Optional[WsBytesHandler] = None,
hdlr_json: Optional[WsJsonHandler] = None,
**kwargs: Any,
) -> WebSocketRunner:
"""
:param url: WebSocket URL
:param send_str: WebSocketで送信する文字列。文字列、または文字列のリスト形式(optional)
:param send_json: WebSocketで送信する辞書オブジェクト。辞書、または辞書のリスト形式(optional)
:param hdlr_str: WebSocketの受信データをハンドリングする関数。
第1引数 msg に _str_型, 第2引数 ws にWebSocketClientResponse 型の変数が渡されます(optional)
:param hdlr_json: WebSocketの受信データをハンドリングする関数。
第1引数 msg に Any 型(JSON-like), 第2引数 ws に WebSocketClientResponse 型の変数が渡されます
(optional)
:param headers: リクエストヘッダー(optional)
:param auth: API自動認証の機能の有効/無効。デフォルトで有効。auth=Noneを指定することで無効になります(optional)
:param ``**kwargs``: aiohttp.ClientSession.ws_connectに渡されるキーワード引数(optional)
"""
ws = WebSocketRunner(
url,
self._session,
send_str=send_str,
send_bytes=send_bytes,
send_json=send_json,
hdlr_str=hdlr_str,
hdlr_bytes=hdlr_bytes,
hdlr_json=hdlr_json,
**kwargs,
)
await ws.wait()
return ws
@staticmethod
def _load_apis(
apis: Optional[Union[dict[str, list[str]], str]]
) -> dict[str, list[str]]:
if apis is None:
apis = {}
if isinstance(apis, dict):
if apis:
return apis
else:
current_apis = os.path.join(os.getcwd(), 'apis.json')
if os.path.isfile(current_apis):
with open(current_apis) as fp:
return json.load(fp)
else:
env_apis = os.getenv('PYBOTTERS_APIS')
if env_apis and os.path.isfile(env_apis):
with open(env_apis) as fp:
return json.load(fp)
else:
return apis
elif isinstance(apis, str):
with open(apis) as fp:
return json.load(fp)
else:
logger.warning(f'apis must be dict or str, not {apis.__class__.__name__}')
return {}
@staticmethod
def _encode_apis(
apis: Optional[dict[str, list[str]]]
) -> dict[str, tuple[str | bytes, ...]]:
if apis is None:
apis = {}
encoded = {}
for name in apis:
if len(apis[name]) >= 2:
apis[name][1] = apis[name][1].encode()
encoded[name] = tuple(apis[name])
return encoded