Python3 – WebAPI

2022-07-29 / tau / コメントする

概要

PythonでWebAPIによってデータをリクエストして取得する方法をまとめる。ここでは郵便番号配信サービスのzipcloudのAPIを利用する。

流れは以下の通り。

準備
1. urllib.requestライブラリーのインポート
2. APIエンドポイントURLのセット
3. パラメーターのセット
4. パラメーターのエンコード
リクエストとレスポンス
1. Requestオブジェクトの生成
2. リクエスト実行とResponseオブジェクトの取得
レスポンスオブジェクトのデコード

API仕様

zipcloudサイトの郵便番号検索APIの内容をまとめると以下の通り。

リクエストURL：https://zipcloud.ibsnet.co.jp/api/search
リクエストパラメーター
- zipcode～必須～郵便番号（ハイフンなし7桁の数字）
- callback～オプション～JSONPとして出力する際のコールバック関数名
- limit～オプション～同一の郵便番号で複数のデータが存在する場合に返される上限件数（デフォルト20）
- urlパターンの例：https://zipcloud.ibsnet.co.jp/api/search?zipcode=1330051

コード

最初に実行コードの全体を示す。

################################################
# ライブラリーのインポート

# JSON 操作用のライブラリー
import json
# HTTPリクエスト用のライブラリー
import urllib.request

################################################
# 変数の設定

# APIエンドポイント
# この例では郵便番号データ配信サービスのAPIエンドポイント
url = 'https://zipcloud.ibsnet.co.jp/api/search'

# APIに渡すパラメーター
# この例ではハイフンなしの郵便番号文字列
params = {
    'zipcode': '1330051'
}

# パラメーターをstringからbyte列にエンコード
# この例ではZIPcodeは半角数字なのでstf-8のほかascii, shift_jisでもok
encoded_params = urllib.parse.urlencode(params).encode('utf-8')

################################################
# リクエストとレスポンスの取得

# エンドポイントとパラメーターを指定してRequestオブジェクトを生成
request = urllib.request.Request(url, data=encoded_params)
# リクエストの結果からResponeseオブジェクトを取得
response = urllib.request.urlopen(request)

print('-------- Reponseオブジェクトの内容 --------')
print(response)

# Responseオブジェクトの文字列をUTF-8でデコード
jsontext = response.read().decode('utf-8')

print('-------- レスポンスをUTF-8でデコードした文字列 --------')
print(jsontext)

print('-------- レスポンスの文字列をJSONとして辞書に展開 --------')
decoded_json = json.loads(jsontext)
print(decoded_json)
print('-------- レスポンスの結果部分のみを取り出す --------')
result_json = decoded_json['results'][0]
print(result_json)
print('-------- 結果部分のJSONを整形 --------')
formatted_json = json.dumps(result_json, indent=4)
print(formatted_json)
print('-------- JSONの整形表示にあたってエスケープを抑制')
json_utf8 = json.dumps(result_json, ensure_ascii=False, indent=4)
print(json_utf8)

################################################

# ライブラリーのインポート

# JSON 操作用のライブラリー

import json

# HTTPリクエスト用のライブラリー

import urllib.request

################################################

# 変数の設定

# APIエンドポイント

# この例では郵便番号データ配信サービスのAPIエンドポイント

url = 'https://zipcloud.ibsnet.co.jp/api/search'

# APIに渡すパラメーター

# この例ではハイフンなしの郵便番号文字列

params = {

'zipcode': '1330051'

}

# パラメーターをstringからbyte列にエンコード

# この例ではZIPcodeは半角数字なのでstf-8のほかascii, shift_jisでもok

encoded_params = urllib.parse.urlencode(params).encode('utf-8')

################################################

# リクエストとレスポンスの取得

# エンドポイントとパラメーターを指定してRequestオブジェクトを生成

request = urllib.request.Request(url, data=encoded_params)

# リクエストの結果からResponeseオブジェクトを取得

response = urllib.request.urlopen(request)

print('-------- Reponseオブジェクトの内容 --------')

print(response)

# Responseオブジェクトの文字列をUTF-8でデコード

jsontext = response.read().decode('utf-8')

print('-------- レスポンスをUTF-8でデコードした文字列 --------')

print(jsontext)

print('-------- レスポンスの文字列をJSONとして辞書に展開 --------')

decoded_json = json.loads(jsontext)

print(decoded_json)

print('-------- レスポンスの結果部分のみを取り出す --------')

result_json = decoded_json['results'][0]

print(result_json)

print('-------- 結果部分のJSONを整形 --------')

formatted_json = json.dumps(result_json, indent=4)

print(formatted_json)

print('-------- JSONの整形表示にあたってエスケープを抑制')

json_utf8 = json.dumps(result_json, ensure_ascii=False, indent=4)

print(json_utf8)

コード説明

準備

urllib.requestライブラリーのインポート

HTTPリクエストに必要なurllib.requestライブラリーをインポートする。

# HTTPリクエスト用のライブラリー
import urllib.request

1 2	# HTTPリクエスト用のライブラリー import urllib.request

APIエンドポイントURLのセット

ここではzipcloudのAPIエンドポイントのURLを変数urlにセットする。

# APIエンドポイント
# この例では郵便番号データ配信サービスのAPIエンドポイント
url = 'https://zipcloud.ibsnet.co.jp/api/search'

# APIエンドポイント

# この例では郵便番号データ配信サービスのAPIエンドポイント

url = 'https://zipcloud.ibsnet.co.jp/api/search'

リクエストパラメーターのセット

リクエストパラメーターを辞書でセット。ここでは仕様に従ってzipcodeに'1130051'を与えている。

# APIに渡すパラメーター
# この例ではハイフンなしの郵便番号文字列
params = {
    'zipcode': '1330051'
}

# APIに渡すパラメーター

# この例ではハイフンなしの郵便番号文字列

params = {

'zipcode': '1330051'

}

パラメーターのエンコード

リクエストに備えて、パラメーター文字列をバイト列にエンコード。ここでは一般的なutf-8を指定しているが、郵便番号は半角数字なのでasciiやshift_jisでも同じ結果となる。その形式は

urllib.parse.urlencode(パラメーター辞書).encode('文字コード')

# パラメーターをstringからbyte列にエンコード
# この例ではZIPcodeは半角数字なのでstf-8のほかascii, shift_jisでもok
encoded_params = urllib.parse.urlencode(params).encode('utf-8')

# パラメーターをstringからbyte列にエンコード

# この例ではZIPcodeは半角数字なのでstf-8のほかascii, shift_jisでもok

encoded_params = urllib.parse.urlencode(params).encode('utf-8')

リクエストとレスポンス

Requestオブジェクトの生成

ベースのURLとエンコードされたパラメーターを与えてRequestオブジェクトを生成する。

urllib.request.Request(URL文字列, data=エンコード後のパラメーター)

# エンドポイントとパラメーターを指定してRequestオブジェクトを生成
request = urllib.request.Request(url, data=encoded_params)

1 2	# エンドポイントとパラメーターを指定してRequestオブジェクトを生成 request = urllib.request.Request(url, data=encoded_params)

リクエスト実行とResponseオブジェクト取得

リクエストはRequestオブジェクトを引数としてurlopenメソッドを実行。戻り値は結果のResponseオブジェクト。

# リクエストの結果からResponseオブジェクトを取得
response = urllib.request.urlopen(request)

1 2	# リクエストの結果からResponseオブジェクトを取得 response = urllib.request.urlopen(request)

Responseオブジェクトのデコード

取得したままのResponseオブジェクトをそのまま表示しても、クラスの文字列表現となるだけ。

# Responseオブジェクト
print(response)

# <http.client.HTTPResponse object at 0x7fb6598afeb8>

# Responseオブジェクト

print(response)

# <http.client.HTTPResponse object at 0x7fb6598afeb8>

そこで、文字コードを指定してデコードしてやる。ここではutf-8を指定している。

response.read().decode(文字コード)

結果は文字コードで指定されたエンコード方式でデコードされ、レスポンスの文字列が得られる。

zipcloudのレスポンスはJSON形式でインデント整形された文字列となるが、あくまで文字列であり、要素を指定した値の取出しはできない。

# Responseオブジェクトの文字列をUTF-8でデコード
jsontext = response.read().decode('utf-8')

print('-------- レスポンスをUTF-8でデコードした文字列 --------')
print(jsontext)

# {
#         "message": null,
#         "results": [
#                 {
#                         "address1": "東京都",
#                         "address2": "江戸川区",
#                         "address3": "北小岩",
#                         "kana1": "ﾄｳｷｮｳﾄ",
#                         "kana2": "ｴﾄﾞｶﾞﾜｸ",
#                         "kana3": "ｷﾀｺｲﾜ",
#                         "prefcode": "13",
#                         "zipcode": "1330051"
#                 }
#         ],
#         "status": 200
# }

# Responseオブジェクトの文字列をUTF-8でデコード

jsontext = response.read().decode('utf-8')

print('-------- レスポンスをUTF-8でデコードした文字列 --------')

print(jsontext)

# {

# "message": null,

# "results": [

# {

# "address1": "東京都",

# "address2": "江戸川区",

# "address3": "北小岩",

# "kana1": "ﾄｳｷｮｳﾄ",

# "kana2": "ｴﾄﾞｶﾞﾜｸ",

# "kana3": "ｷﾀｺｲﾜ",

# "prefcode": "13",

# "zipcode": "1330051"

# }

# ],

# "status": 200

# }

JSON文字列の取り扱い

準備

JSON形式の文字列を辞書として読み込んだり、整形表示をしてみる（PythonでのJSONの取り扱い）。

まず、JSONを扱うにはjsonライブラリーが必要。

import json

1	import json

辞書への展開

JSON形式の文字列をPythonの辞書として取り込む。

json.loads(JSON形式の文字列)

decoded_json = json.loads(jsontext)
print(decoded_json) 

# {'message': None, 'results': [{'address1': '東京都', 'address2': '江戸川区',
#  'address3': '北小岩', 'kana1': 'ﾄｳｷｮｳﾄ', 'kana2': 'ｴﾄﾞｶﾞﾜｸ', 'kana3': 'ｷﾀｺｲﾜ',
#  'prefcode': '13', 'zipcode': '1330051'}], 'status': 200}

decoded_json = json.loads(jsontext)

print(decoded_json)

# {'message': None, 'results': [{'address1': '東京都', 'address2': '江戸川区',

# 'address3': '北小岩', 'kana1': 'ﾄｳｷｮｳﾄ', 'kana2': 'ｴﾄﾞｶﾞﾜｸ', 'kana3': 'ｷﾀｺｲﾜ',

# 'prefcode': '13', 'zipcode': '1330051'}], 'status': 200}

レスポンス内容の取出し

これはzipcloudの仕様になるが、レスポンスのJSONデータのレスポンス部分は入れ子の内側（'response'キーに対応）にあるので、これを取り出す。

同じ郵便番号に複数の住所が存在する場合もあるが、ここでは最初の1つだけ取り出している。

result_json = decoded_json['results'][0]
print(result_json)

# {'address1': '東京都', 'address2': '江戸川区', 'address3': '北小岩', 'kana1': 'ﾄｳｷｮｳﾄ',
#  'kana2': 'ｴﾄﾞｶﾞﾜｸ', 'kana3': 'ｷﾀｺｲﾜ', 'prefcode': '13', 'zipcode': '1330051'}

result_json = decoded_json['results'][0]

print(result_json)

# {'address1': '東京都', 'address2': '江戸川区', 'address3': '北小岩', 'kana1': 'ﾄｳｷｮｳﾄ',

# 'kana2': 'ｴﾄﾞｶﾞﾜｸ', 'kana3': 'ｷﾀｺｲﾜ', 'prefcode': '13', 'zipcode': '1330051'}

JSON形式での整形出力

辞書の内容を再度整形して文字列化する。

json.dumps(辞書, indent=桁数)

ただし、このままではマルチバイト文字が16進にエスケープされてしまう。

formatted_json = json.dumps(result_json, indent=4)
print(formatted_json)

# {
#     "address1": "\u6771\u4eac\u90fd",
#     "address2": "\u6c5f\u6238\u5ddd\u533a",
#     "address3": "\u5317\u5c0f\u5ca9",
#     "kana1": "\uff84\uff73\uff77\uff6e\uff73\uff84",
#     "kana2": "\uff74\uff84\uff9e\uff76\uff9e\uff9c\uff78",
#     "kana3": "\uff77\uff80\uff7a\uff72\uff9c",
#     "prefcode": "13",
#     "zipcode": "1330051"
# }

formatted_json = json.dumps(result_json, indent=4)

print(formatted_json)

# {

# "address1": "\u6771\u4eac\u90fd",

# "address2": "\u6c5f\u6238\u5ddd\u533a",

# "address3": "\u5317\u5c0f\u5ca9",

# "kana1": "\uff84\uff73\uff77\uff6e\uff73\uff84",

# "kana2": "\uff74\uff84\uff9e\uff76\uff9e\uff9c\uff78",

# "kana3": "\uff77\uff80\uff7a\uff72\uff9c",

# "prefcode": "13",

# "zipcode": "1330051"

# }

エスケープの抑制

json.dumpsでエスケープを抑制することで、もとの文字コードに基づいて処理される。エスケープを抑制するためには引数でensure_ascii=Falseをセットする。

json_utf8 = json.dumps(result_json, ensure_ascii=False, indent=4)
print(json_utf8)

# {
#     "address1": "東京都",
#     "address2": "江戸川区",
#     "address3": "北小岩",
#     "kana1": "ﾄｳｷｮｳﾄ",
#     "kana2": "ｴﾄﾞｶﾞﾜｸ",
#     "kana3": "ｷﾀｺｲﾜ",
#     "prefcode": "13",
#     "zipcode": "1330051"
# }

json_utf8 = json.dumps(result_json, ensure_ascii=False, indent=4)

print(json_utf8)

# {

# "address1": "東京都",

# "address2": "江戸川区",

# "address3": "北小岩",

# "kana1": "ﾄｳｷｮｳﾄ",

# "kana2": "ｴﾄﾞｶﾞﾜｸ",

# "kana3": "ｷﾀｺｲﾜ",

# "prefcode": "13",

# "zipcode": "1330051"

# }

Python3 – cURL

2022-06-26 / tau / コメントする

基本形～GET

Python3で指定したURLのサイトからレスポンスを得る手順は以下のとおり。

urllib.request.urlopenで接続のオブジェクトを得る
接続オブジェクトに対してreadメソッドを実行する

ただし結果はバイト列で得られる。

urlopenの引数にURLを指定

以下はurlopenの引数にURLを指定した手順。

urlopenの戻り値(Responseオブジェクト)を変数responseに保存
responseのreadメソッドメソッドでレスポンスの内容を取得

レスポンスの内容はバイト列で返される。

import urllib.request

# URLのセット
url = 'http://www.httpbin.org'

# 指定したURLで接続
with urllib.request.urlopen(url) as response:
    # レスポンスを取得
    html = response.read()

# レスポンスの内容を表示
print(html)

# b'<!DOCTYPE html>\n<html lang="en">\n\n<head>\n    <meta charset="UTF-8">\n ....

import urllib.request

# URLのセット

url = 'http://www.httpbin.org'

# 指定したURLで接続

with urllib.request.urlopen(url) as response:

# レスポンスを取得

html = response.read()

# レスポンスの内容を表示

print(html)

# b'<!DOCTYPE html>\n<html lang="en">\n\n<head>\n <meta charset="UTF-8">\n ....

文字列でレスポンスを得るには、decodeメソッドでバイト列を文字列にデコードする。

import urllib.request

url = 'http://www.httpbin.org'

with urllib.request.urlopen(url) as response:
    html = response.read().decode('utf-8')

print(html)

# <!DOCTYPE html>
# <html lang="en">
# 
# <head>
#     <meta charset="UTF-8">
#     <title>httpbin.org</title>
# ....

import urllib.request

url = 'http://www.httpbin.org'

with urllib.request.urlopen(url) as response:

html = response.read().decode('utf-8')

print(html)

# <!DOCTYPE html>

# <html lang="en">

# <head>

# <meta charset="UTF-8">

# <title>httpbin.org</title>

# ....

urlopenの引数にRequestオブジェクトを指定

まずURLを指定してurllib.request.Requestオブジェクトを生成し、これをurlopenの引数として接続を開く。

import urllib.request

# URLをセット
url = 'http://www.httpbin.org'

# URLを指定してRequestオブジェクトを生成
request = urllib.request.Request(url)

# Requestオブジェクトを指定して接続
with urllib.request.urlopen(request) as response:
    # レスポンスの内容を取得し、UTF-8でデコード
    html = response.read().decode('utf-8')

# レスポンスの内容を表示
print(html)

# <!DOCTYPE html>
# <html lang="en">
# 
# <head>
#     <meta charset="UTF-8">
#     <title>httpbin.org</title>
# ....

import urllib.request

# URLをセット

url = 'http://www.httpbin.org'

# URLを指定してRequestオブジェクトを生成

request = urllib.request.Request(url)

# Requestオブジェクトを指定して接続

with urllib.request.urlopen(request) as response:

# レスポンスの内容を取得し、UTF-8でデコード

html = response.read().decode('utf-8')

# レスポンスの内容を表示

print(html)

# <!DOCTYPE html>

# <html lang="en">

# <head>

# <meta charset="UTF-8">

# <title>httpbin.org</title>

# ....

POST

ポストの流れは以下のとおり。

urllib.requestとurllib.parseをインポートする
urlopenの引数にRequestオブジェクトを渡す
Requestオブジェクト生成時にdata引数を指定するとPOSTメソッドになる（method='POST'がなくてもよい）
dataへ渡す引数は、以下のように処理
- 元のパラメータ群を辞書で準備
- そのデータをurllib.parse.urlencodeでエンコード（utf-8のエンコードも加える）

以下はhttpbin.orgを利用して確認した例。httpbin.org/postからのレスポンスがJSON形式なので、jsonライブラリーをインポートしてレスポンスを整形している。

import json
import urllib.parse
import urllib.request

# URLを設定
url = 'http://www.httpbin.org/post'

# POSTで送るパラメーターを設定
parameters = {
    'name': 'tau',
    'site': 'taustation.com',
}

# 辞書で設定したパラメーターをパース・エンコード
parsed_data = urllib.parse.urlencode(parameters).encode('utf-8')

# data引数にパラメーターを指定してRequestオブジェクトを生成
request = urllib.request.Request(url, data=parsed_data)

# Requestオブジェクトをurlopenに渡して接続
with urllib.request.urlopen(request) as response:
    # レスポンスをUTF-8でデコードして取得
    jsontext = response.read().decode('utf-8')

# httpbin.org/postのレスポンスはJSONなので整形して表示
decoded = json.loads(jsontext)
encoded = json.dumps(decoded, ensure_ascii=False, indent=4)
print(encoded)

# {
#     "args": {},
#     "data": "",
#     "files": {},
#     "form": {
#         "name": "tau",
#         "site": "taustation.com"
#     },
#     "headers": {
#         "Accept-Encoding": "identity",
#         "Content-Length": "28",
#         "Content-Type": "application/x-www-form-urlencoded",
#         "Host": "www.httpbin.org",
#         "User-Agent": "Python-urllib/3.6",
#         "X-Amzn-Trace-Id": "Root=1-62b8487d-6f1d1dee5fe6eb1e2e371679"
#     },
#     "json": null,
#     "origin": "106.155.2.90",
#     "url": "http://www.httpbin.org/post"
# }

import json

import urllib.parse

import urllib.request

# URLを設定

url = 'http://www.httpbin.org/post'

# POSTで送るパラメーターを設定

parameters = {

'name': 'tau',

'site': 'taustation.com',

}

# 辞書で設定したパラメーターをパース・エンコード

parsed_data = urllib.parse.urlencode(parameters).encode('utf-8')

# data引数にパラメーターを指定してRequestオブジェクトを生成

request = urllib.request.Request(url, data=parsed_data)

# Requestオブジェクトをurlopenに渡して接続

with urllib.request.urlopen(request) as response:

# レスポンスをUTF-8でデコードして取得

jsontext = response.read().decode('utf-8')

# httpbin.org/postのレスポンスはJSONなので整形して表示

decoded = json.loads(jsontext)

encoded = json.dumps(decoded, ensure_ascii=False, indent=4)

print(encoded)

# {

# "args": {},

# "data": "",

# "files": {},

# "form": {

# "name": "tau",

# "site": "taustation.com"

# },

# "headers": {

# "Accept-Encoding": "identity",

# "Content-Length": "28",

# "Content-Type": "application/x-www-form-urlencoded",

# "Host": "www.httpbin.org",

# "User-Agent": "Python-urllib/3.6",

# "X-Amzn-Trace-Id": "Root=1-62b8487d-6f1d1dee5fe6eb1e2e371679"

# },

# "json": null,

# "origin": "106.155.2.90",

# "url": "http://www.httpbin.org/post"

# }

Python3 – json

2022-06-26 / tau / コメントする

概要

JSONの文字列が与えられたときの扱い。

json.loadsで文字列をPythonの変数に変換（デコード）
json.dumpsでPythonの変数を文字列に変換（エンコード）
- ensure_ascii=Falseでユニコード文字をエスケープさせない
- indent=nでJSONの構造に即した改行・インデントを適用

json.loads

json.loadsメソッドは、JSON文字列をPythonの変数にデコードする。Pythonの辞書になっていることがわかる。

mport json

jsontext = '{ "要素1": "値1", "要素2": { "要素2-1": "値2-1" } }'

decoded = json.loads(jsontext)
print(type(decoded))
print(decoded)

# <class 'dict'>
# {'要素1': '値1', '要素2': {'要素2-1': '値2-1'}}

mport json

jsontext = '{ "要素1": "値1", "要素2": { "要素2-1": "値2-1" } }'

decoded = json.loads(jsontext)

print(type(decoded))

print(decoded)

# <class 'dict'>

# {'要素1': '値1', '要素2': {'要素2-1': '値2-1'}}

JSONのキーと値が辞書のキーと値に対応している。

json.dumps

そのままエンコードした場合

json.dumpsは、辞書に変換されたJSONの内容を文字列にエンコードする。

ただしこのとき、ユニコードはエスケープされ、改行を含まない文字列となる。

mport json

jsontext = '{ "要素1": "値1", "要素2": { "要素2-1": "値2-1" } }'

decoded = json.loads(jsontext)

encoded = json.dumps(decoded)
print(type(encoded))
print(encoded)

# <class 'str'>
# {"\u8981\u7d201": "\u50241", "\u8981\u7d202": {"\u8981\u7d202-1": "\u50242-1"}}

mport json

jsontext = '{ "要素1": "値1", "要素2": { "要素2-1": "値2-1" } }'

decoded = json.loads(jsontext)

encoded = json.dumps(decoded)

print(type(encoded))

print(encoded)

# <class 'str'>

# {"\u8981\u7d201": "\u50241", "\u8981\u7d202": {"\u8981\u7d202-1": "\u50242-1"}}

引数設定によるJSONの構造表現

以下の2つの引数を指定する。

ensure_ascii=False: ユニコードをエスケープせずそのままの表現とする。
indent=n: JSONの構造に即した改行・インデントを適用する。

これによって、ユニコード文字列はエスケープされず、JSONの構造に即した改行・インデントが適用された文字列が得られる。

import json

jsontext = '{ "要素1": "値1", "要素2": { "要素2-1": "値2-1" } }'

decoded = json.loads(jsontext)

encoded = json.dumps(decoded, ensure_ascii=False, indent=4)
print(encoded)

# {
#     "要素1": "値1",
#     "要素2": {
#         "要素2-1": "値2-1"
#     }
# }

import json

jsontext = '{ "要素1": "値1", "要素2": { "要素2-1": "値2-1" } }'

decoded = json.loads(jsontext)

encoded = json.dumps(decoded, ensure_ascii=False, indent=4)

print(encoded)

# {

# "要素1": "値1",

# "要素2": {

# "要素2-1": "値2-1"

# }

Python3 – bytesとString

2022-06-26 / tau / コメントする

概要

Pythonでの文字列表現をバイト列に変換するにはencodeメソッドを用い、バイト列を文字列に変換するにはdecodeメソッドを用いる。encode/decodeの引数には文字コードを指定する。

バイト列をPythonのprint文で出力すると、b'文字列'で表現され、改行文字などはエスケープコード（\nなど）で表示される。

ASCII文字列

encode/decode

ASCII文字列はencode/decodeの引数を'ascii'とする。

# String->bytesへエンコード
s = 'ABC\nDEF'
print(s.encode('ascii'))
# b'ABC\nDEF'

# bytes->Stringへデコード
b = b'ABC\nDEF'
print(b.decode('ascii'))
# ABC
# DEF

# String->bytesへエンコード

s = 'ABC\nDEF'

print(s.encode('ascii'))

# b'ABC\nDEF'

# bytes->Stringへデコード

b = b'ABC\nDEF'

print(b.decode('ascii'))

# ABC

# DEF

ASCIIの場合は引数が'utf-8'や'shift_jis'としても結果は同じ。

16進表現

bytes.hexメソッドの引数にバイト列を与えると、その16進表現の文字列が得られる。

print(bytes.hex(b'ABC\nDEF'))
# 4142430a444546

1 2	print(bytes.hex(b'ABC\nDEF')) # 4142430a444546

UTF-8/Shift_JIS

encode/decode

マルチバイト文字の場合、encodeとdecodeで文字コードを整合させる。

# String->bytesへエンコード
s = 'あい\nうえ'
print(s.encode('utf-8'))
# b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'

# bytes->Stringへデコード
b = b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'
print(b.decode('utf-8'))
# あい
# うえ

# String->bytesへエンコード

s = 'あい\nうえ'

print(s.encode('utf-8'))

# b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'

# bytes->Stringへデコード

b = b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'

print(b.decode('utf-8'))

# あい

# うえ

encodeとdecodeで文字コードが違うと、文字化けするのではなくエラーになる。

b = b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'
print(b.decode('shift_jis'))
# Traceback (most recent call last):
#  File "bytestring.py", line 5, in <module>
#    print(b.decode('shift_jis'))
# UnicodeDecodeError: 'shift_jis' codec can't decode byte 0x86 in position 9: illegal multibyte sequence

b = b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'

print(b.decode('shift_jis'))

# Traceback (most recent call last):

# File "bytestring.py", line 5, in <module>

# print(b.decode('shift_jis'))

# UnicodeDecodeError: 'shift_jis' codec can't decode byte 0x86 in position 9: illegal multibyte sequence

ただしerrors引数の設定をデフォルトの'strict’から変更すると、文字化けした文字列などが返される。

16進表現

マルチバイト文字の16進表現はバイト列の表現のとおりになる。

print(bytes.hex(b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88'))
# e38182e381840ae38186e38188

1 2	print(bytes.hex(b'\xe3\x81\x82\xe3\x81\x84\n\xe3\x81\x86\xe3\x81\x88')) # e38182e381840ae38186e38188

Python3 – ファイル操作

2022-06-26 / tau / コメントする

ファイル操作の流れ

大まかな流れは以下のとおり。

モードを指定してファイルを開く～open
ファイルへの読み書きを実行
ファイルを閉じる～close

具体的には、openでファイルオブジェクトを取得し、読み書きやcloseなどの操作はファイルオブジェクトに対して実行。

基本形

以下のファイルを準備。行末は全て改行コードで終わっている。

When the dog bytes
When the bee stings
When I'm feeling sad

When the dog bytes

When the bee stings

When I'm feeling sad

以下のコードは、ファイルを読み込みモードで開き、内容を一つの文字列に一括して読み込んで表示している。

# 読み込みモードでファイルをオープン
f = open('test.txt', 'r')

# ファイルの内容を一括読み込み
text = f.read()

# ファイルをクローズ
f.close()

# 読み込んだファイル内容を表示
print(text)

# 読み込みモードでファイルをオープン

f = open('test.txt', 'r')

# ファイルの内容を一括読み込み

text = f.read()

# ファイルをクローズ

f.close()

# 読み込んだファイル内容を表示

print(text)

実行結果は以下のとおり。

$ python3 filetest.py
When the dog bytes
When the bee stings
When I'm feeling sad

$

$ python3 filetest.py

When the dog bytes

When the bee stings

When I'm feeling sad

ファイルの各行末に改行コードがあるため、そこで改行されて表示される。さらにprint関数で自動的に改行コードが付加されるため、最後に空白行が入っている。

with文

with文でopenを指定することにより、withブロック終了時に自動的に終了処理(close)が実行される。

# 読み込みモードでファイルを使う
with open('test.txt', 'r') as f:
    # ファイル内容を行に分割してリストに格納
    text = f.read()

# リストの要素＝各行を表示
print(text, end='')

# 読み込みモードでファイルを使う

with open('test.txt', 'r') as f:

# ファイル内容を行に分割してリストに格納

text = f.read()

# リストの要素＝各行を表示

print(text, end='')

ファイルからの読み込み

read～一括読み込み

readメソッドはファイルの全内容を一つのテキストとして読み込む。

# ファイル内容を行に分割してリストに格納
text = f.read()

# リストの要素＝各行を表示
print(text, end='')

# When the dog bytes
# When the bee stings
# When I'm feeling sad

# ファイル内容を行に分割してリストに格納

text = f.read()

# リストの要素＝各行を表示

print(text, end='')

# When the dog bytes

# When the bee stings

# When I'm feeling sad

readline～一行読み込み

readlineは実行のたびにファイルから1行ずつ読み込み、ポインターを次の行に進める。読み込む内容がない場合には''を返す。

以下はファイルの内容を2行だけ読みだす例。

// 1行ずつファイルを読み込みながら表示
line = f.readline()
print(line, end='')
line = f.readline()
print(line, end='')

# When the dog bytes
# When the bee stings

// 1行ずつファイルを読み込みながら表示

line = f.readline()

print(line, end='')

line = f.readline()

print(line, end='')

# When the dog bytes

# When the bee stings

以下はファイル内容の全行を1行ずつ取り出す例。

while True:
    text = f.read()
    if text == '':
        break
    print(text, end='')

# When the dog bytes
# When the bee stings
# When I'm feeling sad

while True:

text = f.read()

if text == '':

break

print(text, end='')

# When the dog bytes

# When the bee stings

# When I'm feeling sad

readlines～行に分割して読み込み

readlinesはファイルの内容を行に分解し、各行の内容を要素としたリストを返す。

# ファイル内容を行に分割してリストに格納
lines = f.readlines()

# リストの要素＝各行を表示
for line in lines:
    print(line, end='')

# When the dog bytes
# When the bee stings
# When I'm feeling sad

# ファイル内容を行に分割してリストに格納

lines = f.readlines()

# リストの要素＝各行を表示

for line in lines:

print(line, end='')

# When the dog bytes

# When the bee stings

# When I'm feeling sad

ファイルへの書き込み

ファイルに書き込む場合、オプションに'w'を指定。既にファイルが存在する場合、その内容は無視されて上書きされる。

write文

write文は引数の文字列を単に書き込む。

# 読み込みモードでファイルをオープン
with open('test.txt', 'w') as f:
    # 1行ずつファイルへ書込み
    f.write('Raindrops on roses and whiskers on kittens\n')
    f.write('Bright copper kettles and warm woolen mittens\n')

# test.txtの内容
# Raindrops on roses and whiskers on kittens
# Bright copper kettles and warm woolen mittens

# 読み込みモードでファイルをオープン

with open('test.txt', 'w') as f:

# 1行ずつファイルへ書込み

f.write('Raindrops on roses and whiskers on kittens\n')

f.write('Bright copper kettles and warm woolen mittens\n')

# test.txtの内容

# Raindrops on roses and whiskers on kittens

# Bright copper kettles and warm woolen mittens

print文

print文のfile引数にファイルオブジェクトを指定すると、ファイルに書き込むことができる。この場合、書式設定などを活用することができる。

with open('test2.txt', 'w') as f:# 1行ずつファイルへ書込み
    print('1 million yen', file=f)
    print('{:,} yen'.format(1000000), file=f)

# test2.txtの内容
# 1 million yen
# 1,000,000 yen

with open('test2.txt', 'w') as f:# 1行ずつファイルへ書込み

print('1 million yen', file=f)

print('{:,} yen'.format(1000000), file=f)

# test2.txtの内容

# 1 million yen

# 1,000,000 yen

ファイルへの追記

既存のファイルに追記するには'a'オプションを指定。以下の例では、上で作成されたtest.txtに1行追記している。

# 読み込みモードでファイルをオープン
with open('test.txt', 'a') as f:# 1行ずつファイルへ書込み
    # 1行追記
    f.write('Brown paper packages tied up with strings\n')

# test.txtの内容
# Raindrops on roses and whiskers on kittens
# Bright copper kettles and warm woolen mittens
# Brown paper packages tied up with strings

# 読み込みモードでファイルをオープン

with open('test.txt', 'a') as f:# 1行ずつファイルへ書込み

# 1行追記

f.write('Brown paper packages tied up with strings\n')

# test.txtの内容

# Raindrops on roses and whiskers on kittens

# Bright copper kettles and warm woolen mittens

# Brown paper packages tied up with strings

ファイルが存在しない場合は、'w'と同様にファイルが作成されて新規に書き込みされる。

$ rm test.txt
$ ls
filetest.py
$ python3 filetest.py
$ cat test.txt
Brown paper packages tied up with strings

$ rm test.txt

$ ls

filetest.py

$ python3 filetest.py

$ cat test.txt

Brown paper packages tied up with strings

Django – Tutorial4 – フォーム

2022-06-23 / tau / コメントする

フォームの配置

このページはDjangoのDocumentation、Writing your first Django app, part 4に対応している。

detailページの機能

チュートリアルのテンプレートのところで作成したindexページでは、データベースのquestionテーブルに保存されたQuestionデータの一覧が表示される。

各Questionデータのリンクをクリックすると、polls.viewsモジュールのdetail関数にルーティングされ、detailテンプレートが呼ばれてページが表示される。

現状でこのページでは、"You're looking at question 1."のようにクリックしたQuestionデータのidを含むテキストが表示されるだけ。

ここでdetailページに以下のような機能を持たせる。

クリックしたQuestionデータのquestion_textを表示する
そのQuestionデータに関連付けられた（すなわちその回答選択肢となる）Choiceデータ群を、ラジオボタンとともに表示する
Voteボタンを押すと、選択した回答のidが送信される

id送信後の振る舞いについては後に実装することとして、ここでは上の機能をテンプレートで実装していく。

コードの変更

pollsアプリケーションのdetailテンプレートを以下の内容に変更する。

<form action="{% url 'polls:vote' question.id %}" method="post">
  {% csrf_token %}
  <fieldset>
    <legend><h1>{{ question.question_text }}</h1></legend>
    {% if error_message %}
      <p><strong>{{ error_message }}</strong></p>
    {% endif %}
    {% for choice in question.choice_set.all %}
      <input type="radio" name="choice" id="choice{{ forloop.counter }}" value="{{ choice.id }}">
      <label for="choice{{ forloop.counter }}">{{ choice.choice_text }}</label>
    {% endfor %}
  </fieldset>
  <input type="submit" value="Vote">
</form>

{% csrf_token %}

<legend><h1>{{ question.question_text }}</h1></legend>

{% if error_message %}

<p><strong>{{ error_message }}</strong></p>

{% endif %}

{% for choice in question.choice_set.all %}

<label for="choice{{ forloop.counter }}">{{ choice.choice_text }}</label>

{% endfor %}

</fieldset>

</form>

テンプレートがビューから受け取る変数

questionオブジェクトとerror_message(テキスト)が渡されることを想定している（上記コードのL4, 6, 8）。

form要素のactionとmethod

form要素のオプション設定は以下の通り。

actionの呼び出し先はpollsアプリケーションのname='vote'ルート→vote関数で、questionデータのidをURLパラメーターで渡す
メソッドはPOST

csrf_tokenタグ

form要素内の最初にCSRF/XSRF (cross-site request forgery)対策として{% csrf_token %}を置いている。form要素にこのタグを置かないと、Djangoによりアクセス禁止のエラーとなる。

qustion_textの表示

ビューから受け取ったquestionオブジェクトのquestion_textプロパティーの内容をh1要素として表示させる。

エラー表示

ビューの処理でエラーになった場合error_message変数が定義されることを前提としている。DTLのifタグにより、error_messageがセットされているときはこれが表示され、選択肢とラジオボタンが表示される。

選択肢の表示

questionデータに対する選択肢はChoiceデータが関連付けられていて、そのコレクションはDTLのドット検索によりquestion.choice_set.allで得られる。

フォームでは、このコレクションの要素（各Choiceデータ）をDTLのforタグで1つずつ取出している。そして、各choiceについてラジオボタンとラベルテキストを生成している。

ラジオボタンの属性は以下のとおり。

name=”choice”: すべての選択肢に同じname属性を適用してグループ化している。
id=”choice{{ forloop.counter }}”: label要素で参照するidで、先頭から連番でchoice1, choice2, …のような値となる。forloop.counterはDTLのforタグの変数で、ループカウンターの値が得られる。
value=”{{ choice.id }}”: 選択されたラジオボタンに対応する値で、Choiceデータのidが充てられる。このidによって、データベース上の指定したデータが得られる。

このテンプレートがレンダリングされたときのHTMLは以下のとおり。valueの値が1, 2, 4となっているが、データの削除・追加によってAUTO_INCREMENTの値は必ずしも連続にならない。一方、forloop.counterを利用したidの数字部分は連番となっている。

<form action="/polls/1/vote/" method="post">
  <input type="hidden" name="csrfmiddlewaretoken" value="AkC8p5sJzHblsYxvYtn124PmXPt9u9SC8qJqa6QMinL8MzCuiMsMmAhrCfHuR1YZ">
  <fieldset>
    <legend><h1>What&#x27;s up?</h1></legend>
    
    
      <input type="radio" name="choice" id="choice1" value="1">
      <label for="choice1">Not much</label>
    
      <input type="radio" name="choice" id="choice2" value="2">
      <label for="choice2">The sky</label>
    
      <input type="radio" name="choice" id="choice3" value="4">
      <label for="choice3">Just hacking again</label>
    
  </fieldset>
  <input type="submit" value="Vote">
</form>

<label for="choice3">Just hacking again</label>

</fieldset>

</form>

ここでindexページのQuestionデータのうち"What's up?"をクリックすると、レンダリングされたdetail.htmlにより以下のページが表示される。

この段階でVoteボタンを押すと、polls.viewsモジュールのvote関数にルーティングされるが、この段階では”You’re voting on question 1.”とだけ表示される。

def vote(request, question_id):
    return HttpResponse("You're voting on question %s." % question_id)

1 2	def vote(request, question_id): return HttpResponse("You're voting on question %s." % question_id)

vote関数の実装

vote関数での処理

ここではフォームのアクション先であるvote関数の処理を実装する。処理内容は、Questionの持つ選択肢のうちditailページで選択・送信されたChoiceデータのvoteカウンターを1つ増やしてデータベースを変更するというもの。

コード

vote関数の内容を以下のように変更する。

from django.http import HttpResponse, HttpResponseRedirect
from django.shortcuts import render, get_object_or_404
from django.urls import reverse

from .models import Choice, Question

  ....

def vote(request, question_id):
    question = get_object_or_404(Question, pk=question_id)

    try:
        selected_choice = question.choice_set.get(pk=request.POST['choice'])
    except (KeyError, Choice.DoesNotExist):
        # エラーメッセージを加えて元の内容を表示
        return render(request, 'polls/detail.html', {
            'question': question,
            'error_message': "You didn't select a choice.",
        })
    else:
        selected_choice.votes += 1
        selected_choice.save()
        # POSTデータが正常に処理された場合、HttpResponseRedirectを返す。こにより
        # ユーザーが戻るボタンを押しても繰り返してデータが投稿されるのを防ぐ
        return HttpResponseRedirect(reverse('polls:results', args=(question_id,)))

from django.http import HttpResponse, HttpResponseRedirect

from django.shortcuts import render, get_object_or_404

from django.urls import reverse

from .models import Choice, Question

....

def vote(request, question_id):

question = get_object_or_404(Question, pk=question_id)

try:

selected_choice = question.choice_set.get(pk=request.POST['choice'])

except (KeyError, Choice.DoesNotExist):

# エラーメッセージを加えて元の内容を表示

return render(request, 'polls/detail.html', {

'question': question,

'error_message': "You didn't select a choice.",

})

else:

selected_choice.votes += 1

selected_choice.save()

# POSTデータが正常に処理された場合、HttpResponseRedirectを返す。こにより

# ユーザーが戻るボタンを押しても繰り返してデータが投稿されるのを防ぐ

return HttpResponseRedirect(reverse('polls:results', args=(question_id,)))

モジュールのインポート

パッケージ先頭でHttpResponseRedirectモジュールをインポートしている。このモジュールは、URLconfで定義したルート名とパラメーターを与えてレスポンスを返す。

またChoiceモデルを扱うために、Questionに加えてChoiceモジュールもインポートしている。

Questionの取得

フォームのaction属性で、Questionデータのidをクエリーパラメーターで渡すようになっていて、vote関数の引数でこれを受け取る。

そのidでQuestionデータを取得し、存在しなければ404エラーとなる。

投票登録：try～except～elseブロック

このブロックで、Questionデータに対する選択肢をデータベースから取得し、エラーならエラー処理をし、成功したならその選択肢の得票数を1つ増やす。詳細は以下の通り。

try節

try節では、前段で得られたQuestionデータの選択肢Coiceデータのうちフォームで選択されたものを取得する。

getメソッドでpkがPOST['choice']に等しいデータを取り出している
POST['choice']はフォームにおいてname='choice'のINPUT要素から得られるvalue属性の内容
今回のフォームではラジオボタンのグループが'choice'であり、POST['choice']から選択されたボタンのvalue属性の値が得られる
フォームではvalue={{ choice.id }}としているので、この値は選択された選択肢に対応するChoiceデータのidの値

except節

except節では、引数で指定したKeyErrorとChoice.DoesNotExistの2つの例外をキャッチしている。いずれかの例外が発生した場合に、現在処理中のQuestionデータを与えて元のdetailページを表示させるが、このときエラーメッセージをセットしているのでこれも表示される。

KeyErrorはPOST['choice']でデータを取り出すときに'choice'というキーが存在しない場合に発生する。このような状況は次の場合に発生する。

選択肢を持たないQuestionデータに対してVoteボタンを押した場合（今回の例の場合question_textが"Hou're you doing?"のデータ）
HTMLのラジオボタンのname属性が改ざんされた場合

Choice.DoesNotExistの方は、getメソッドで条件に合うデータがデータベース上にないときに発生する。ただ今回のコードでは、DB上のデータが取得できない場合はget_object_or_404により404エラーへと飛ぶようになっているので、ここでDoesNotExist例外は発火しないのではないか。

else節

else節はtry節の処理が正常終了した場合に実行される。今回の場合、フォームで選択された選択肢のChoiceデータが無事取得できたことになるので、データベース上の得票数カウンターを1つ増やして投票結果表示のresultページにリダイレクトする。

得票数のカウントアップは簡単で、取得済みのデータについて以下を実行。

selected_choice.votes += 1

1	selected_choice.votes += 1

ただしこれはデータベースからメモリー上に取得されたデータを変更しただけなので、変更後のデータをデータベースに登録する必要がある。

selected_choice.save()

1	selected_choice.save()

最後に戻り値としてHttpResponseRedirectを返している。これはDjangoに特化したものではなく、HTTPでの処理の標準的な手筋。

動作確認

mysql> select * from choices;
+----+--------------------+-------+-------------+
| id | choice_text        | votes | question_id |
+----+--------------------+-------+-------------+
|  1 | Not much           |     1 |           1 |
|  2 | The sky            |     0 |           1 |
|  4 | Just hacking again |     0 |           1 |
+----+--------------------+-------+-------------+
3 rows in set (0.00 sec)

mysql> select * from choices;

+----+--------------------+-------+-------------+

+----+--------------------+-------+-------------+

| 1 | Not much | 1 | 1 |

| 2 | The sky | 0 | 1 |

| 4 | Just hacking again | 0 | 1 |

+----+--------------------+-------+-------------+

3 rows in set (0.00 sec)

Django – render/redirect/HttpResponseなど

2022-06-20 / tau / コメントする

概要

ビュー関数／ビュークラスのメソッドはHttpResponseクラスやその派生クラスのインスタンスを戻り値として、テンプレートをレンダリングしたり指定したURLに遷移する。

この戻り値の与え方としては、HttpResponseやその派生クラスのインスタンスを直接与える方法と、django.shortcutsで定義された関数(render、 redirect)を使う方法がある。

HttpResponseはレスポンスボディ―を指定して表示。ショートカットのrenderは引数にテンプレートファイルを指定し、それを表示する。

URLを指定したリダイレクトには、HttpResponseRedirectやショートカットのrenderを使う。

レンダリング

HttpResponse

HttpResponseはdjango.httpパッケージのモジュールで、ヘッダーや内容などを持つHTTPレスポンスのクラス。インスタンス生成時に引数にテキストを指定したテキストがレスポンスボディ―になり、直接表示される。

テキストのほか、イテレーターやファイルも指定できる。

from django.http import HttpResponse

def http_response_text(request):
    return HttpResponse('<h1>HttpResponse Test</h1>')

from django.http import HttpResponse

def http_response_text(request):

return HttpResponse('<h1>HttpResponse Test</h1>')

render

renderはdjango.shortcutsパッケージのモジュールで、指定したテンプレートファイルの内容をHttpRequestインスタンスとして返す。

テンプレートファイルに加えて、テンプレートに引き渡す変数コンテキストも指定できる。

from django.shortcuts import render

def target(request):
    return render(request, 'appname/target.html')

from django.shortcuts import render

def target(request):

return render(request, 'appname/target.html')

リダイレクト

HttpResponseRedirect

HttpResponseRedirectはdjango.httpパッケージのモジュールで、指定したURLに遷移するためのHTTPレスポンスのインスタンスを生成する。

HttpResponseRedirectはHttpResponseRedirectBaseを継承し、HttpResponseRedirectBaseはHttpResponseを継承している。

ビュー関数／メソッドの中で、URLを引数に与えてHttpResponseRedirectのインスタンスを生成し、戻り値にそのインスタンスを渡すことで、指定したURLにリダイレクトされる。

引数のURLは以下のように与えることができる。

ホスト名を含む絶対URL
アプリケーション名から始まるサブディレクトリーによる相対URL
urls.pyのpath関数で設定したルート名をreverse関数の引数に与えた戻り値（ルート名を直接与えることはできない）

from django.http import HttpResponseRedirect

# 絶対URL指定
def http_response_redirect_absolute(request):
    return HttpResponseRedirect('http://localhost:8000/appname/target')

# アプリケーション相対URL指定
def http_response_redirect_relative(request):
    return HttpResponseRedirect('/appname/target')

# urls.pyのルート名もreverse関数を通して指定可能
def http_response_redirect_name(request):
    return HttpResponseRedirect(reverse('appname:target'))
#    return HttpResponseRedirect('appname:target') -> ERROR!
#    直接ルート名は指定できない

from django.http import HttpResponseRedirect

# 絶対URL指定

def http_response_redirect_absolute(request):

return HttpResponseRedirect('http://localhost:8000/appname/target')

# アプリケーション相対URL指定

def http_response_redirect_relative(request):

return HttpResponseRedirect('/appname/target')

# urls.pyのルート名もreverse関数を通して指定可能

def http_response_redirect_name(request):

return HttpResponseRedirect(reverse('appname:target'))

# return HttpResponseRedirect('appname:target') -> ERROR!

# 直接ルート名は指定できない

redirect

redirectはdjango.shortcutsパッケージのモジュールで、指定したURLにリダイレクトするためのHTTPレスポンのためのスインスタンスを返す。

redirectは関数として定義され、デフォルトではHttpResponseRedirectのインスタンスを返すが、引数にpermanent=Trueを設定すると、HttpResponsePermanentRedirectのインスタンスを返す(このクラスは301ステータスを返す)。

redirectがHttpResponseRedirectを返す際、resolve_url関数を介していて、reverse関数を使わず直接ルート名を渡すことができる。

from django.shortcuts import redirect

# 絶対URL指定
def redirect_absolute(request):
    return redirect('http://localhost:8000/appname/target')

# アプリケーション相対URL指定
def redirect_relative(request):
    return redirect('/appname/target')

# ルート名も指定可能
def redirect_name(request):
    return redirect(reverse('appname:target'))
#    return redirect('appname:target') -> OK!
#    ルート名のみを指定してもよい

from django.shortcuts import redirect

# 絶対URL指定

def redirect_absolute(request):

return redirect('http://localhost:8000/appname/target')

# アプリケーション相対URL指定

def redirect_relative(request):

return redirect('/appname/target')

# ルート名も指定可能

def redirect_name(request):

return redirect(reverse('appname:target'))

# return redirect('appname:target') -> OK!

# ルート名のみを指定してもよい

Django – HttpResponse

2022-06-19 / tau / コメントする

概要

HttpResponseはdjango.httpパッケージにあり、HTTPリクエストに対してサーバーからクライアントに返されるHTTPレスポンスを表すクラス。

Django Documentation – Request and response objects

プロパティー

HttpResponseは以下のプロパティーを持つ（一部記載）。

status_code: ステータスコードの値
headers: ヘッダーの各項目の内容
content: レスポンスボディの内容。バイトストリング。

charset: 文字コード名
reason_phrase: ステータスコードのフレーズ。RFCに準拠。

インスタンス生成例

まずモジュールをインポートし、文字列を渡してHttpResponseインスタンスを生成。インスタンス表現や型を確認。

>>> from django.http import HttpResponse
>>> response = HttpResponse('HTTP content')
>>> response
<HttpResponse status_code=200, "text/html; charset=utf-8">
>>> type(response)
<class 'django.http.response.HttpResponse'>

>>> from django.http import HttpResponse

>>> response = HttpResponse('HTTP content')

>>> response

>>> type(response)

ステータスコードとステータスフレーズを確認。

>>> response.status_code
200
>>> response.reason_phrase
'OK'

>>> response.status_code

200

>>> response.reason_phrase

'OK'

ヘッダーとそのうちの文字コードを確認。

>>> response.headers
{'Content-Type': 'text/html; charset=utf-8'}
>>> response.headers['Content-Type']
'text/html; charset=utf-8'

>>> response.headers

{'Content-Type': 'text/html; charset=utf-8'}

>>> response.headers['Content-Type']

'text/html; charset=utf-8'

ボディー部の確認。バイトストリングになっている。

>>> response.content
b'HTTP content'

1 2	>>> response.content b'HTTP content'

Django – フォームデータ

2022-06-18 / tau / コメントする

概要

テンプレートのフォームで入力・送信されたデータをビューで受け取って処理する方法の基本。

ビュー関数／メソッドの引数(たとえばrequest)のPOST配列でフォームのINPUT要素のname属性値を指定して値を取得する。

request.POST['name属性値']

実装例

2つのページへのルーティング

urls.pyでinputページとresultページへのルーティングを設定。inputページにフォームを置き、そこから送信されたデータをresultページで表示することとする。

DTLのurlタグを使うため、各ルートにname引数でルート名を付けている。

from django.urls import path
from formtest import views

app_name = 'formtest'

urlpatterns = [
    path('', views.input, name='input'),
    path('result', views.result, name='result'),
]

from django.urls import path

from formtest import views

app_name = 'formtest'

urlpatterns = [

path('', views.input, name='input'),

path('result', views.result, name='result'),

]

inputページのためのビュー

ルート名formtest:inputでルーティングされるview関数。単にinput.htmlテンプレートをレンダリングしている。

from django.shortcuts import render

def index(request):
    return render(request, 'formtest/input.html')

from django.shortcuts import render

def index(request):

return render(request, 'formtest/input.html')

input.htmlテンプレート

input.htmlテンプレート。フォームには、textタイプのINPUT要素と、3つの選択肢を持つradioタイプのINPUT要素群が置かれている。

textタイプのINPUT要素のname属性はinput_test
radioタイプの3つのINPUT要素のname属性はradio_choiceで値はpine、bamboo、plum

送信ボタンが押されると、methodで指定したURLに飛ぶが、ここではurls.pyで定義したformtest:resultに飛ぶようにDTLのurlタグを使っている。

<h1>フォームテスト</h1>

<form action="{{ url formtest:result }}" method="post">
  {% csrf_token %}

  {# text #}
  <div>
    <input type="text" name="input_text" value="">
  </div>

  {# radio #}
  <div>
    <label>
      <input type="radio" name="radio_choice" value="pine">松
    </label>
    <label>
      <input type="radio" name="radio_choice" value="bamboo">竹
    </label>
    <label>
      <input type="radio" name="radio_choice" value="plum">梅
    </label>
  </div>
  <input type="submit" value="送信">
</form>

<h1>フォームテスト</h1>

{% csrf_token %}

{# text #}

<div>

</div>

{# radio #}

<div>

<label>

<input type="radio" name="radio_choice" value="pine">松

</label>

<label>

<input type="radio" name="radio_choice" value="bamboo">竹

</label>

<label>

<input type="radio" name="radio_choice" value="plum">梅

</label>

</div>

</form>

resultビュー

フォームからの送信に対してviews.pyのresult関数が呼ばれる。result.htmlテンプレートにcontext辞書を介して2つの変数input_textとradio_choiceを渡している。

input_text変数には、name='input_text'で指定されたテキストの内容がrequest.POST['input_text']で取得されて代入される
radio_choice変数には、name='radio_choice'で指定されたラジオボタンのうち選択されたもののvalue値がrequest.POST[‘radio_choice’]で取得され、これに対応する文字列が代入される

from django.shortcuts import render

def input(request):
    return render(request, 'formtest/index.html')

def result(request):
    radio_result = { 'pine': '松', 'bamboo': '竹', 'plum': '梅' }
    context = {
            'input_text': request.POST['input_text'],
            'radio_choice': radio_result[request.POST['radio_choice']],
        }
    return render(request, 'formtest/result.html', context)

from django.shortcuts import render

def input(request):

return render(request, 'formtest/index.html')

def result(request):

radio_result = { 'pine': '松', 'bamboo': '竹', 'plum': '梅' }

context = {

'input_text': request.POST['input_text'],

'radio_choice': radio_result[request.POST['radio_choice']],

}

return render(request, 'formtest/result.html', context)

result.htmlテンプレート

resultテンプレートでは、ビューのcontextで設定された変数の内容を表示する。

<h1>送信結果</h1>

<p>
  入力されたテキストは"{{ input_text }}"です。
</p>
<p>
  選択されたのは"{{ radio_choice }}"です。
</p>

<a href="{% url 'formtest:input' %}">フォームに戻る</a>

<p>

入力されたテキストは"{{ input_text }}"です。

</p>

<p>

選択されたのは"{{ radio_choice }}"です。

</p>

<a href="{% url 'formtest:input' %}">フォームに戻る</a>

Django – DTL – URL

2022-06-15 / tau / コメントする

概要

urls.pyでURLパターンからビューへのルーティングを指定しただけの場合、テンプレートでそのルーティングを使うにはURLを直書きしなければならない。

これに対して、urls.pyのURLパターンを任意に変更しても影響が及ばないようにするには、DTLのurlタグを使う。

URLハードコーティングの場合

たとえばmyappアプリケーションのmainページからsubページへのリンクを貼りたいとする。

アプリケーションのurls.pyは以下のようになっているとする。

from django.urls import path
from myapp import views

urlpatterns = [
    path('', views.main),
    path('sub', views.sub),
]

from django.urls import path

from myapp import views

urlpatterns = [

path('', views.main),

path('sub', views.sub),

]

ルーティングされたビュー関数が以下のように書かれているとする。

from django.shortcuts import render

def main(request):
    return render(request, 'myapp/main.html')

def sub(request):
    return render(request, 'myapp/sub.html')

from django.shortcuts import render

def main(request):

return render(request, 'myapp/main.html')

def sub(request):

return render(request, 'myapp/sub.html')

レンダリングされるテンプレートでURLをハードコーティングした場合は以下のようになる。

main.html

<h1>メインページ</h1>

<a href="/myapp/sub">サブページへ</a>

<h1>メインページ</h1>

<a href="/myapp/sub">サブページへ</a>

sub.html

<h1>サブページ</h1>

1	<h1>サブページ</h1>

このときのURL指定と各ページの対応は以下のとおり。

[DOMAIN]/myapp/　→　views.main　→　main.html
[DOMAIN]/myapp/sub　→　views.sub　→　sub.html

URLハードコーティングの問題

urls.py中のpath関数のURLのパターンを任意に変化させると、各テンプレート中のURLを全て見直さなければならない。これの影響を及ぼさせないようにしたい。

urls.pyでのname指定

urls.py中、抽象化したいpath関数にname引数を追加する。この場合はsubページへのpath関数を以下のように変更。

from django.urls import path
from myapp import views

urlpatterns = [
    path('', views.main),
    path('sub', views.sub, name='sub'),
]

from django.urls import path

from myapp import views

urlpatterns = [

path('', views.main),

path('sub', views.sub, name='sub'),

]

そして、subページへのURLの代わりにDTLのurlタグを使い、その引数にurls.pyのnameで指定した値を与える。

<h1>メインページ</h1>

<a href="{% url 'sub' %}">サブページへ</a>

<h1>メインページ</h1>

<a href="{% url 'sub' %}">サブページへ</a>

アプリケーションを指定する場合

異なるアプリケーションでnameに指定したい値が重複する場合、[app_name]:[path_name]で指定できるようにする。

path()関数でnameを指定する際、urls.pyの冒頭でapp_name変数にアプリケーション名の文字列を指定しておく。

from django.urls import path
from myapp import views

app_name = 'myapp'

urlpatterns = [
    path('', views.main),
    path('sub', views.sub, name='sub'),
]

from django.urls import path

from myapp import views

app_name = 'myapp'

urlpatterns = [

path('', views.main),

path('sub', views.sub, name='sub'),

]

そして、DTLのurlタグの引数にapp_nameで指定した値を加える。

<h1>メインページ</h1>

<a href="{% url 'myapp:sub' %}">サブページへ</a>

<h1>メインページ</h1>

<a href="{% url 'myapp:sub' %}">サブページへ</a>

まとめ

グローバルなパス名の場合

urls.pyのpath関数にname引数でパス名を指定
URLの代わりに{% url 'パス名' %}を指定

アプリケーションローカルなパス名の場合

urls.pyのpath関数にname引数でパス名を指定
urls.pyの冒頭でapp_name='アプリケーション名'を記述
URLの代わりに{% url 'アプリケーション名:パス名' %}を指定