Python: urllib.requestでHTTPリクエストを実行する【サンプル付】

urllib.requestでHTTPリクエストを実行する方法を紹介します。

開発環境

• MacOS 11.2
• Python3.9

全体流れ

• urllib.request.Request関数でHTTPリクエストを作成する。
• 作成したHTTPリクエストをurllib.request.urlopen関数の引数にして、関数を実行してレスポンスを取得する。
• jsonモジュールで取得したJSONレスポンスを解析する。

urllib.request.Request

urllib.request.Request(reqUrl, reqData, headers, method)

• reqUrl: リクエストのurl
• reqData: postデータ
• headers: リクエストのヘッダー
• method: デフォルトは、reqDataはNoneであれば'GET'、それ以外は'POST'。

urllib.request.urlopen

urllib.request.urlopen(req)

もし、レスポンスはJSON形式であれば、json.loadを使ってレスポンスの解析ができます。

具体例は、

with urllib.request.urlopen(req) as res:
    body = json.load(res)
    ... # Do something you want.

サンプル

以下の例は、https://randomuser.me/api/という認証なしのAPIを使って、HTTPリクエストを試してみました。
https://randomuser.me/api/は偽ユーザーの情報を返してもらえますので、使えやすいです。

import urllib.request
import json
reqUrl = 'https://randomuser.me/api/'
reqData = None
headers = {
    'Content-Type': 'application/json'
}
method = 'GET'
req = urllib.request.Request(reqUrl, reqData, headers, method=method)
with urllib.request.urlopen(req) as res:
  body = json.load(res)
  print(body)
  print(f"gender: {body['results'][0]['gender']}")
  print(f"name: {body['results'][0]['name']['first']} {body['results'][0]['name']['last']}")
  print(f"country: {body['results'][0]['location']['country']}")

参考

urllib.request — Extensible library for opening URLs
Free API – Top 15 APIs You Can Use For Free (No Key Needed)

以上です。urllib.requestでHTTPリクエストを実行する方法を簡単に紹介しました。