AIOHTTP-Client Quickstart ========================== - Doc: `Client — aiohttp 3.7.4.post0 documentation `_ async with ---------- .. literalinclude:: ./code/aiohttp/aiohttp_qs1.py :linenos: - 非同期のコンテキストマネージャ - ClientSessionを使った処理が終わったら session を close してくれる。 - もし session context manager を使わない場合は以下のように ``.close()`` メソッドを呼び出し必ずクローズする。 .. literalinclude:: ./code/aiohttp/aiohttp_qs2.py :linenos: with文のネスト ^^^^^^^^^^^^^^ - `Python 3.10の新機能(その2） with文のネスト: Python3.10の新機能 `_ - これを async with でもやってみたところ出来ました。 - (実はpython3.9でも可) .. code-block:: python async with (aiohttp.ClientSession() as session, session.get("http://httpbin.org/get") as resp): : : async for --------- - 非同期イテレータ/ジェネレータ用の ``for`` 文 - 下記２つは同じ意味 .. code-block:: python async for a in async_iterable: await do_a_thing(a) .. code-block:: python it = async_iterable.__aiter__() while True: try: a = await it.__anext__() except StopAsyncIteration: break await do_a_thing(a) - 参照： `Python Asyncio Part 3 – Asynchronous Context Managers and Asynchronous Iterators `_ ClientSession ------------- - `aiohttp.ClientSession `_ - クライアントセッションクラス。 - インスタンス化して(以下 ``session`` で表現)、そのオブジェクトメソッドを使ってリクエストを行う session.request() ^^^^^^^^^^^^^^^^^ - `aiohttp.ClientSession.request `_ - 非同期のHTTPリクエストを実行 - 引数(必須) - ``method (str)`` – HTTP method - ``url`` – URL。文字列もしくは yarl URL オブジェクト - オプション引数：ドキュメント参照 - 返り値は `aiohttp.ClientResponse `_ インスタンスオブジェクト session.get() ^^^^^^^^^^^^^ - `aiohttp.ClientSession.get `_ - GET リクエスト - ``session.request()`` の第一引数が `GET` に固定されているメソッド - 引数(必須) - ``url`` – URL。文字列もしくは yarl URL オブジェクト - オプション引数：ドキュメント参照 - 返り値は `aiohttp.ClientResponse `_ インスタンスオブジェクト .. _parameter: URLリクエストにパラメータ を渡す ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: ./code/aiohttp/aiohttp_qs3.py :linenos: - ``params`` オプションで渡す - 同じキーに対して2つ以上の値を渡したい場合は、`MultiDict `_ もしくは、タプルのリストで渡す - ``MultiDict({'a': [1, 3]})`` - ``MultiDict([('a', 1), ('a', 3)])`` - ``([('a', 1), ('a', 3)])`` その他HTTPメソッド ^^^^^^^^^^^^^^^^^^ - `.post() `_ `.put() `_ `.delete() `_ `.patch() `_ 等用意されている。 - 返り値は `aiohttp.ClientResponse `_ インスタンスオブジェクト ClientResponse --------------- - `aiohttp.ClientResponse `_ - ``session.request()`` とそのファミリーが返すクラス - API call だけがインスタンス化する(以下 ``resp`` と表現する) - ユーザがこのクラスをインスタンス化することは一切ない - コンテキストマネージャ ``async with`` での処理が完了すると release される - 主なインスタンスメソッド - `resp.read() `_ : レスポンス body を byte で読み込む。 - `resp.text(encoding=None) `_: レスポンス body を文字列で読み込む。エンコーディング指定可 - `resp.json(encoding=None) `_ : レスポンス body を JSON で読み込み、辞書型オブジェクトで返す。エンコーディング指定可 .. _binary: バイナリデータの読み込み ^^^^^^^^^^^^^^^^^^^^^^^^ - バイナリデータは `.read() `_ で取得可 .. literalinclude:: ./code/aiohttp/aiohttp_qs4.py :linenos: streaming response ^^^^^^^^^^^^^^^^^^ - ``read()`` ``json()`` ``text()`` は メモリにロードするので、巨大なサイズのファイルの読み込みには `aiohttp.StreamReader `_ のインスタンスの ``.content`` アトリビュートの利用を検討したほうがよい - よく使われる方法としては、chunk size を指定してファイル等に書き込むなどする .. literalinclude:: ./code/aiohttp/aiohttp_qs5.py :linenos: .. _websockets: websockets ^^^^^^^^^^ .. literalinclude:: ./code/aiohttp/aiohttp_qs6.py :linenos: * client session を確立後、`aiohttp.ClientSession.ws_connect() `_ メソッドでウェブソケットへ接続 * URL を渡して初期化すると、ウェブソケットサーバーに接続状態になる。返り値は `aiohttp.ClientWebSocketResponse `_ 。(以下 ``ws`` で表現) * `ws.send_str() `_ メソッドで ping を投げて `ws.receive() `_ メソッドでレスポンスを待つ。 * `ws.send_json() `_ メソッドで json を投げることも可 * `ws.receive() `_ の返り値は `aiohttp.WSMessage `_ オブジェクト。その ``type`` 属性が `aiohttp.WSMsgType `_ で、そのタイプによって処理を切り分ける