delhi09の勉強日記

技術トピック専用のブログです。自分用のメモ書きの投稿が多いです。あくまで「勉強日記」なので記事の内容は鵜呑みにしないでください。

requestsの公式ドキュメントは英語版を参照すること

Googleで「requests」を検索すると最初に以下の日本語版のドキュメントが出てくる。

requests-docs-ja.readthedocs.io

私はこれまで、ずっとこの日本語版を参照していたが、対象としているrequestのバージョンが1.0.4とかなり古いバージョンであることに最近気づいた。
※ 最新版は2.25.1

Copyrightも2012になっていることから、日本語翻訳版のドキュメントは久しく更新されていないようである。

従って、現行のバージョンを情報を得たければ、以下の英語版の方のドキュメントを参照する必要がある。

docs.python-requests.org

経緯

requestsでJSONをpostするときに以下のように書けるという指摘をコードレビューでもらった。

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

私は日本語版のドキュメントをいつも見ていたので、jsonパラメータの説明がドキュメントを探しても見つからなくて、「そんなパラメータ使えるってドキュメントのどこに記載されているんだろう?」と疑問に思った。
jsonパラメータはバージョン2.4.2から使えるようになったとのこと。

よく見たら、そもそも日本語版はバージョンがかなり古いことに気がついた。