クイックスタート—ドキュメントをリクエストします

クイックスタート

始めたいですか？ このページでは、リクエストの開始方法について説明します。

まず、次のことを確認してください。

• リクエストはインストールされています
• リクエストは最新です

いくつかの簡単な例から始めましょう。

リクエストする

Requestsを使用してリクエストを行うのは非常に簡単です。

Requestsモジュールをインポートすることから始めます。

>>> import requests

それでは、Webページを取得してみましょう。 この例では、GitHubの公開タイムラインを取得しましょう。

>>> r = requests.get('https://api.github.com/events')

これで、rという Response オブジェクトができました。 このオブジェクトから必要なすべての情報を取得できます。

リクエストのシンプルなAPIは、すべての形式のHTTPリクエストが同じように明白であることを意味します。 たとえば、これはHTTPPOSTリクエストを作成する方法です。

>>> r = requests.post('https://httpbin.org/post', data = {'key':'value'})

いいですね 他のHTTPリクエストタイプ（PUT、DELETE、HEAD、OPTIONS）はどうですか？ これらはすべて同じように単純です。

>>> r = requests.put('https://httpbin.org/put', data = {'key':'value'})
>>> r = requests.delete('https://httpbin.org/delete')
>>> r = requests.head('https://httpbin.org/get')
>>> r = requests.options('https://httpbin.org/get')

それはすべてうまくいっていますが、それはリクエストができることの始まりにすぎません。

URLでパラメータを渡す

URLのクエリ文字列で何らかのデータを送信したい場合がよくあります。 URLを手動で作成している場合、このデータは、URLの疑問符の後にキーと値のペアとして表示されます。 httpbin.org/get?key=val。 リクエストでは、paramsキーワード引数を使用して、これらの引数を文字列の辞書として提供できます。 たとえば、key1=value1とkey2=value2をhttpbin.org/getに渡す場合は、次のコードを使用します。

>>> payload = {'key1': 'value1', 'key2': 'value2'}
>>> r = requests.get('https://httpbin.org/get', params=payload)

URLを印刷すると、URLが正しくエンコードされていることがわかります。

>>> print(r.url)
https://httpbin.org/get?key2=value2&key1=value1

値がNoneの辞書キーは、URLのクエリ文字列に追加されないことに注意してください。

アイテムのリストを値として渡すこともできます。

>>> payload = {'key1': 'value1', 'key2': ['value2', 'value3']}

>>> r = requests.get('https://httpbin.org/get', params=payload)
>>> print(r.url)
https://httpbin.org/get?key1=value1&key2=value2&key2=value3

応答内容

サーバーの応答の内容を読み取ることができます。 GitHubのタイムラインをもう一度考えてみましょう。

>>> import requests

>>> r = requests.get('https://api.github.com/events')
>>> r.text
'[{"repository":{"open_issues":0,"url":"https://github.com/...

リクエストはサーバーからのコンテンツを自動的にデコードします。 ほとんどのUnicode文字セットはシームレスにデコードされます。

リクエストを行うと、RequestsはHTTPヘッダーに基づいてレスポンスのエンコーディングについて知識に基づいた推測を行います。 r.textにアクセスすると、リクエストによって推測されたテキストエンコーディングが使用されます。 r.encodingプロパティを使用して、リクエストが使用しているエンコーディングを確認し、変更することができます。

>>> r.encoding
'utf-8'
>>> r.encoding = 'ISO-8859-1'

エンコーディングを変更すると、r.textを呼び出すたびに、Requestsはr.encodingの新しい値を使用します。 特別なロジックを適用してコンテンツのエンコーディングを決定できる状況では、これを実行することをお勧めします。 たとえば、HTMLとXMLには、本体でエンコーディングを指定する機能があります。 このような状況では、r.contentを使用してエンコードを検索し、r.encodingを設定する必要があります。 これにより、r.textを正しいエンコーディングで使用できるようになります。

リクエストでは、必要に応じてカスタムエンコーディングも使用されます。 独自のエンコーディングを作成してcodecsモジュールに登録した場合は、コーデック名をr.encodingの値として使用するだけで、リクエストがデコードを処理します。

バイナリ応答コンテンツ

テキスト以外のリクエストの場合は、応答本文にバイトとしてアクセスすることもできます。

>>> r.content
b'[{"repository":{"open_issues":0,"url":"https://github.com/...

gzipおよびdeflate転送エンコーディングは自動的にデコードされます。

brotli や brotlicffi などのBrotliライブラリがインストールされている場合、br転送エンコーディングは自動的にデコードされます。

たとえば、リクエストによって返されたバイナリデータから画像を作成するには、次のコードを使用できます。

>>> from PIL import Image
>>> from io import BytesIO

>>> i = Image.open(BytesIO(r.content))

JSON応答コンテンツ

JSONデータを扱う場合に備えて、組み込みのJSONデコーダーもあります。

>>> import requests

>>> r = requests.get('https://api.github.com/events')
>>> r.json()
[{'repository': {'open_issues': 0, 'url': 'https://github.com/...

JSONデコードが失敗した場合、r.json()は例外を発生させます。 たとえば、応答が204（コンテンツなし）を取得した場合、または応答に無効なJSONが含まれている場合、r.json()を試行するとrequests.exceptions.JSONDecodeErrorが発生します。 このラッパー例外は、異なるpythonバージョンおよびjsonシリアル化ライブラリによってスローされる可能性のある複数の例外の相互運用性を提供します。

r.json()への呼び出しの成功は、応答の成功を示すではないことに注意してください。 一部のサーバーは、失敗した応答でJSONオブジェクトを返す場合があります（例： HTTP 500でのエラーの詳細）。 このようなJSONはデコードされて返されます。 リクエストが成功したことを確認するには、r.raise_for_status()を使用するか、r.status_codeが期待どおりであることを確認します。

生の応答コンテンツ

サーバーからrawソケット応答を取得したいというまれなケースでは、r.rawにアクセスできます。 これを行う場合は、最初のリクエストでstream=Trueを設定してください。 あなたがそうしたら、あなたはこれをすることができます：

>>> r = requests.get('https://api.github.com/events', stream=True)

>>> r.raw
<urllib3.response.HTTPResponse object at 0x101194810>

>>> r.raw.read(10)
'\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x03'

ただし、一般的には、次のようなパターンを使用して、ストリーミングされているものをファイルに保存する必要があります。

with open(filename, 'wb') as fd:
    for chunk in r.iter_content(chunk_size=128):
        fd.write(chunk)

Response.iter_contentを使用すると、Response.rawを直接使用する場合に処理する必要がある多くの処理が実行されます。 ダウンロードをストリーミングする場合、コンテンツを取得するための推奨される方法は上記のとおりです。 chunk_sizeは、ユースケースに適した数に自由に調整できることに注意してください。

ノート

Response.iter_contentとResponse.rawの使用に関する重要な注意事項。 Response.iter_contentは、gzipおよびdeflate転送エンコーディングを自動的にデコードします。 Response.rawはバイトの生のストリームであり、応答コンテンツを変換しません。 返されたバイトに本当にアクセスする必要がある場合は、Response.rawを使用してください。

カスタムヘッダー

リクエストにHTTPヘッダーを追加する場合は、dictをheadersパラメーターに渡すだけです。

たとえば、前の例ではユーザーエージェントを指定していません。

>>> url = 'https://api.github.com/some/endpoint'
>>> headers = {'user-agent': 'my-app/0.0.1'}

>>> r = requests.get(url, headers=headers)

注：カスタムヘッダーには、より具体的な情報ソースよりも優先順位が低くなります。 例えば：

• headers = で設定された認証ヘッダーは、.netrcで資格情報が指定されている場合に上書きされ、auth=パラメーターによって上書きされます。 リクエストは、〜/ .netrc 、〜/ _netrc 、または NETRC 環境変数で指定されたパスでnetrcファイルを検索します。
• オフホストにリダイレクトされると、認証ヘッダーは削除されます。
• Proxy-Authorizationヘッダーは、URLで提供されるプロキシ資格情報によって上書きされます。
• コンテンツの長さを決定できる場合、Content-Lengthヘッダーはオーバーライドされます。

さらに、Requestsは、指定されたカスタムヘッダーに基づいてその動作をまったく変更しません。 ヘッダーは、最終的なリクエストに渡されるだけです。

注：すべてのヘッダー値は、string、バイト文字列、またはユニコードである必要があります。 許可されている間は、Unicodeヘッダー値を渡さないようにすることをお勧めします。

より複雑なPOSTリクエスト

通常、HTMLフォームのように、フォームにエンコードされたデータを送信する必要があります。 これを行うには、辞書をdata引数に渡すだけです。 データの辞書は、リクエストが行われると自動的にフォームエンコードされます。

>>> payload = {'key1': 'value1', 'key2': 'value2'}

>>> r = requests.post("https://httpbin.org/post", data=payload)
>>> print(r.text)
{
  ...
  "form": {
    "key2": "value2",
    "key1": "value1"
  },
  ...
}

data引数は、キーごとに複数の値を持つこともできます。 これは、dataをタプルのリスト、またはリストを値として持つ辞書のいずれかに作成することで実行できます。 これは、フォームに同じキーを使用する複数の要素がある場合に特に便利です。

>>> payload_tuples = [('key1', 'value1'), ('key1', 'value2')]
>>> r1 = requests.post('https://httpbin.org/post', data=payload_tuples)
>>> payload_dict = {'key1': ['value1', 'value2']}
>>> r2 = requests.post('https://httpbin.org/post', data=payload_dict)
>>> print(r1.text)
{
  ...
  "form": {
    "key1": [
      "value1",
      "value2"
    ]
  },
  ...
}
>>> r1.text == r2.text
True

フォームにエンコードされていないデータを送信したい場合があります。 dictの代わりにstringを渡すと、そのデータは直接投稿されます。

たとえば、GitHub APIv3はJSONでエンコードされたPOST / PATCHデータを受け入れます。

>>> import json

>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}

>>> r = requests.post(url, data=json.dumps(payload))

dictを自分でエンコードする代わりに、jsonパラメーター（バージョン2.4.2で追加）を使用して直接渡すこともでき、自動的にエンコードされます。

>>> url = 'https://api.github.com/some/endpoint'
>>> payload = {'some': 'data'}

>>> r = requests.post(url, json=payload)

dataまたはfilesのいずれかが渡された場合、jsonパラメーターは無視されることに注意してください。

リクエストでjsonパラメータを使用すると、ヘッダーのContent-Typeがapplication/jsonに変更されます。

マルチパートエンコードファイルのPOST

リクエストにより、マルチパートでエンコードされたファイルを簡単にアップロードできます。

>>> url = 'https://httpbin.org/post'
>>> files = {'file': open('report.xls', 'rb')}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "<censored...binary...data>"
  },
  ...
}

ファイル名、content_type、およびヘッダーを明示的に設定できます。

>>> url = 'https://httpbin.org/post'
>>> files = {'file': ('report.xls', open('report.xls', 'rb'), 'application/vnd.ms-excel', {'Expires': '0'})}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "<censored...binary...data>"
  },
  ...
}

必要に応じて、ファイルとして受信する文字列を送信できます。

>>> url = 'https://httpbin.org/post'
>>> files = {'file': ('report.csv', 'some,data,to,send\nanother,row,to,send\n')}

>>> r = requests.post(url, files=files)
>>> r.text
{
  ...
  "files": {
    "file": "some,data,to,send\\nanother,row,to,send\\n"
  },
  ...
}

非常に大きなファイルをmultipart/form-dataリクエストとして投稿する場合は、リクエストをストリーミングすることをお勧めします。 デフォルトでは、requestsはこれをサポートしていませんが、requests-toolbeltをサポートする別のパッケージがあります。 使用方法の詳細については、ツールベルトのドキュメントをお読みください。

1回のリクエストで複数のファイルを送信する場合は、 Advanced セクションを参照してください。

警告

バイナリモードでファイルを開くことを強くお勧めします。 これは、リクエストがContent-Lengthヘッダーを提供しようとする可能性があるためです。提供される場合、この値はファイル内のバイトの数に設定されます。 テキストモードでファイルを開くと、エラーが発生する場合があります。

応答ステータスコード

応答ステータスコードを確認できます。

>>> r = requests.get('https://httpbin.org/get')
>>> r.status_code
200

リクエストには、簡単に参照できるように、組み込みのステータスコードルックアップオブジェクトも付属しています。

>>> r.status_code == requests.codes.ok
True

不正なリクエスト（4XXクライアントエラーまたは5XXサーバーエラー応答）を行った場合は、 Response.raise_for_status（）で発生させることができます。

>>> bad_r = requests.get('https://httpbin.org/status/404')
>>> bad_r.status_code
404

>>> bad_r.raise_for_status()
Traceback (most recent call last):
  File "requests/models.py", line 832, in raise_for_status
    raise http_error
requests.exceptions.HTTPError: 404 Client Error

ただし、rのstatus_codeは200であったため、raise_for_status()を呼び出すと次のようになります。

>>> r.raise_for_status()
None

すべては順調です。

応答ヘッダー

Pythonディクショナリを使用して、サーバーの応答ヘッダーを表示できます。

>>> r.headers
{
    'content-encoding': 'gzip',
    'transfer-encoding': 'chunked',
    'connection': 'close',
    'server': 'nginx/1.0.4',
    'x-runtime': '148ms',
    'etag': '"e1ca502697e5c9317743dc078f67693f"',
    'content-type': 'application/json'
}

ただし、辞書は特別です。HTTPヘッダー専用に作成されています。 RFC 7230 によると、HTTPヘッダー名では大文字と小文字が区別されません。

したがって、必要な大文字と小文字を使用してヘッダーにアクセスできます。

>>> r.headers['Content-Type']
'application/json'

>>> r.headers.get('content-type')
'application/json'

また、サーバーが同じヘッダーを異なる値で複数回送信する可能性があるという点でも特別ですが、 RFC 7230 のように、リクエストはそれらを組み合わせて、単一のマッピング内でディクショナリに表すことができます。

受信者は、メッセージのセマンティクスを変更せずに、結合されたフィールド値に後続の各フィールド値を順番に追加することにより、同じフィールド名を持つ複数のヘッダーフィールドを1つの「フィールド名：フィールド値」ペアに結合できます（MAY）。コンマ。

クッキー

応答にいくつかのCookieが含まれている場合は、それらにすばやくアクセスできます。

>>> url = 'http://example.com/some/cookie/setting/url'
>>> r = requests.get(url)

>>> r.cookies['example_cookie_name']
'example_cookie_value'

独自のCookieをサーバーに送信するには、cookiesパラメーターを使用できます。

>>> url = 'https://httpbin.org/cookies'
>>> cookies = dict(cookies_are='working')

>>> r = requests.get(url, cookies=cookies)
>>> r.text
'{"cookies": {"cookies_are": "working"}}'

Cookieは RequestsCookieJar で返されます。これは、dictのように機能しますが、複数のドメインまたはパスでの使用に適した、より完全なインターフェイスも提供します。 Cookiejarをリクエストに渡すこともできます。

>>> jar = requests.cookies.RequestsCookieJar()
>>> jar.set('tasty_cookie', 'yum', domain='httpbin.org', path='/cookies')
>>> jar.set('gross_cookie', 'blech', domain='httpbin.org', path='/elsewhere')
>>> url = 'https://httpbin.org/cookies'
>>> r = requests.get(url, cookies=jar)
>>> r.text
'{"cookies": {"tasty_cookie": "yum"}}'

リダイレクトと履歴

デフォルトでは、リクエストはHEADを除くすべての動詞に対してロケーションリダイレクトを実行します。

Responseオブジェクトのhistoryプロパティを使用して、リダイレクトを追跡できます。

Response.history リストには、リクエストを完了するために作成された Response オブジェクトが含まれています。 リストは、古い応答から最新の応答の順に並べ替えられます。

たとえば、GitHubはすべてのHTTPリクエストをHTTPSにリダイレクトします。

>>> r = requests.get('http://github.com/')

>>> r.url
'https://github.com/'

>>> r.status_code
200

>>> r.history
[<Response [301]>]

GET、OPTIONS、POST、PUT、PATCH、またはDELETEを使用している場合は、allow_redirectsパラメーターを使用してリダイレクト処理を無効にできます。

>>> r = requests.get('http://github.com/', allow_redirects=False)

>>> r.status_code
301

>>> r.history
[]

HEADを使用している場合は、リダイレクトを有効にすることもできます。

>>> r = requests.head('http://github.com/', allow_redirects=True)

>>> r.url
'https://github.com/'

>>> r.history
[<Response [301]>]

タイムアウト

timeoutパラメーターを使用して、指定された秒数後に応答の待機を停止するようにRequestsに指示できます。 ほぼすべての本番コードは、ほぼすべてのリクエストでこのパラメーターを使用する必要があります。 そうしないと、プログラムが無期限にハングする可能性があります。

>>> requests.get('https://github.com/', timeout=0.001)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
requests.exceptions.Timeout: HTTPConnectionPool(host='github.com', port=80): Request timed out. (timeout=0.001)

ノート

timeoutは、応答のダウンロード全体の時間制限ではありません。 むしろ、サーバーがtimeout秒間応答を発行しなかった場合（より正確には、timeout秒間、基になるソケットでバイトが受信されなかった場合）、例外が発生します。 タイムアウトが明示的に指定されていない場合、リクエストはタイムアウトしません。

エラーと例外

ネットワークに問題が発生した場合（例： DNSの失敗、接続の拒否など）、リクエストは ConnectionError 例外を発生させます。

Response.raise_for_status（）は、HTTPリクエストが失敗したステータスコードを返した場合、 HTTPError を発生させます。

リクエストがタイムアウトすると、 Timeout 例外が発生します。

リクエストが設定された最大リダイレクト数を超えると、 TooManyRedirects 例外が発生します。

Requestsが明示的に発生させるすべての例外は、 requests.exceptions.RequestException から継承されます。

---

もっと準備はいいですか？ 詳細セクションを確認してください。

求人市場にいる場合は、このプログラミングクイズの受講を検討してください。 このプラットフォームを通じて仕事を見つけた場合、このプロジェクトに多額の寄付が行われます。