\section{\module{httplib} ---
         HTTP プロトコルクライアント}

\declaremodule{standard}{httplib}
\modulesynopsis{HTTP および HTTPS プロトコルのクライアント 
  (ソケットを必要とします) 。}

\indexii{HTTP}{protocol}
\index{HTTP!\module{httplib} (standard module)}

このモジュールでは HTTP および HTTPS プロトコルのクライアント側
を実装しているクラスを定義しています。通常、このモジュールは直接
使いません --- \refmodule{urllib}\refstmodindex{urllib} モジュールが
HTTP や HTTPS を使った URL を扱う上でこのモジュールを使います。
\note{HTTPS のサポートは、SSL をサポートするように
\refmodule{socket} モジュールをコンパイルした場合にのみ利用できます。}

このモジュールでは以下のクラスを提供しています:

\begin{classdesc}{HTTPConnection}{host\optional{, port}}
\class{HTTPConnection} インスタンスは、HTTP サーバとの一回の
トランザクションを表現します。インスタンスの生成はホスト名と
オプションのポート番号を与えて行います。ポート番号を指定しなかった
場合、ホスト名文字列が \code{\var{host}:\var{port}}
の形式であれば、ホスト名からポート番号を導き、そうでない
場合には標準の HTTP ポート番号 (80) を使います。例えば、
以下の呼び出しは全て同じサーバの同じポートに接続するインスタンス
を生成します:

\begin{verbatim}
>>> h1 = httplib.HTTPConnection('www.cwi.nl')
>>> h2 = httplib.HTTPConnection('www.cwi.nl:80')
>>> h3 = httplib.HTTPConnection('www.cwi.nl', 80)
\end{verbatim}
\end{classdesc}

\begin{classdesc}{HTTPSConnection}{host\optional{, port, key_file, cert_file}}
\class{HTTPConnection} のサブクラスで、セキュアなサーバと
通信するために SSL を使います。標準のポート番号は \code{443}
です。
\var{key_file}には、秘密鍵を格納したPEM形式ファイルのファイル名を指定します。\var{cert_file}には、PEM形式の証明書チェーンファイルを指定します。

\warning{この関数は証明書の検査を行いません！}
\end{classdesc}

必要に応じて以下の例外が送出されます:

\begin{excdesc}{HTTPException}
このモジュールにおける他の例外クラスの基底クラスです。
\exception{Exception} のサブクラスです。
\end{excdesc}

\begin{excdesc}{NotConnected}
\exception{HTTPException} サブクラスです。
\end{excdesc}

\begin{excdesc}{InvalidURL}
\exception{HTTPException} のサブクラスです。ポート番号を指定した
ものの、その値が数字でなかったり空のオブジェクトであった場合に送出されます。
\end{excdesc}

\begin{excdesc}{UnknownProtocol}
\exception{HTTPException} のサブクラスです。
\end{excdesc}

\begin{excdesc}{UnknownTransferEncoding}
\exception{HTTPException} のサブクラスです。
\end{excdesc}

\begin{excdesc}{IllegalKeywordArgument}
\exception{HTTPException} のサブクラスです。
\end{excdesc}

\begin{excdesc}{UnimplementedFileMode}
\exception{HTTPException} のサブクラスです。
\end{excdesc}

\begin{excdesc}{IncompleteRead}
\exception{HTTPException} のサブクラスです。
\end{excdesc}

\begin{excdesc}{ImproperConnectionState}
\exception{HTTPException} のサブクラスです。
\end{excdesc}

\begin{excdesc}{CannotSendRequest}
\exception{ImproperConnectionState} のサブクラスです。
\end{excdesc}

\begin{excdesc}{CannotSendHeader}
\exception{ImproperConnectionState} のサブクラスです。
\end{excdesc}

\begin{excdesc}{ResponseNotReady}
\exception{ImproperConnectionState} のサブクラスです。
\end{excdesc}

\begin{excdesc}{BadStatusLine}
\exception{HTTPException} のサブクラスです。
サーバが理解できない HTTP 状態コードで応答した場合に送出されます。
\end{excdesc}

このモジュールで定義されている定数は以下の通りです:

\begin{datadesc}{HTTP_PORT}
HTTP プロトコルの標準のポート (通常は \code{80}) です。
\end{datadesc}

\begin{datadesc}{HTTPS_PORT}
HTTPS プロトコルの標準のポート (通常は \code{443}) です。
\end{datadesc}

また、整数の状態コードについて以下の定数が定義されています:

\begin{tableiii}{l|c|l}{constant}{Constant}{Value}{Definition}
  \lineiii{CONTINUE}{\code{100}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.1.1}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.1.1}}
  \lineiii{SWITCHING_PROTOCOLS}{\code{101}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.1.2}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.1.2}}
  \lineiii{PROCESSING}{\code{102}}
    {WEBDAV, \ulink{RFC 2518, Section 10.1}
      {http://www.webdav.org/specs/rfc2518.html#STATUS_102}}

  \lineiii{OK}{\code{200}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.1}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1}}
  \lineiii{CREATED}{\code{201}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.2}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2}}
  \lineiii{ACCEPTED}{\code{202}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.3}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.3}}
  \lineiii{NON_AUTHORITATIVE_INFORMATION}{\code{203}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.4}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.4}}
  \lineiii{NO_CONTENT}{\code{204}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.5}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5}}
  \lineiii{RESET_CONTENT}{\code{205}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.6}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.6}}
  \lineiii{PARTIAL_CONTENT}{\code{206}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.2.7}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.7}}
  \lineiii{MULTI_STATUS}{\code{207}}
    {WEBDAV \ulink{RFC 2518, Section 10.2}
      {http://www.webdav.org/specs/rfc2518.html#STATUS_207}}
  \lineiii{IM_USED}{\code{226}}
    {Delta encoding in HTTP, \rfc{3229}, Section 10.4.1}

  \lineiii{MULTIPLE_CHOICES}{\code{300}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.1}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.1}}
  \lineiii{MOVED_PERMANENTLY}{\code{301}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.2}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.2}}
  \lineiii{FOUND}{\code{302}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.3}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.3}}
  \lineiii{SEE_OTHER}{\code{303}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.4}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.4}}
  \lineiii{NOT_MODIFIED}{\code{304}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.5}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5}}
  \lineiii{USE_PROXY}{\code{305}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.6}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.6}}
  \lineiii{TEMPORARY_REDIRECT}{\code{307}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.3.8}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.8}}

  \lineiii{BAD_REQUEST}{\code{400}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.1}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1}}
  \lineiii{UNAUTHORIZED}{\code{401}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.2}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2}}
  \lineiii{PAYMENT_REQUIRED}{\code{402}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.3}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3}}
  \lineiii{FORBIDDEN}{\code{403}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.4}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4}}
  \lineiii{NOT_FOUND}{\code{404}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.5}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5}}
  \lineiii{METHOD_NOT_ALLOWED}{\code{405}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.6}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6}}
  \lineiii{NOT_ACCEPTABLE}{\code{406}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.7}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7}}
  \lineiii{PROXY_AUTHENTICATION_REQUIRED}
    {\code{407}}{HTTP/1.1, \ulink{RFC 2616, Section 10.4.8}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.8}}
  \lineiii{REQUEST_TIMEOUT}{\code{408}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.9}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.9}}
  \lineiii{CONFLICT}{\code{409}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.10}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10}}
  \lineiii{GONE}{\code{410}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.11}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11}}
  \lineiii{LENGTH_REQUIRED}{\code{411}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.12}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.12}}
  \lineiii{PRECONDITION_FAILED}{\code{412}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.13}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13}}
  \lineiii{REQUEST_ENTITY_TOO_LARGE}
    {\code{413}}{HTTP/1.1, \ulink{RFC 2616, Section 10.4.14}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.14}}
  \lineiii{REQUEST_URI_TOO_LONG}{\code{414}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.15}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.15}}
  \lineiii{UNSUPPORTED_MEDIA_TYPE}{\code{415}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.16}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16}}
  \lineiii{REQUESTED_RANGE_NOT_SATISFIABLE}{\code{416}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.17}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.17}}
  \lineiii{EXPECTATION_FAILED}{\code{417}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.4.18}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.18}}
  \lineiii{UNPROCESSABLE_ENTITY}{\code{422}}
    {WEBDAV, \ulink{RFC 2518, Section 10.3}
      {http://www.webdav.org/specs/rfc2518.html#STATUS_422}}
  \lineiii{LOCKED}{\code{423}}
    {WEBDAV \ulink{RFC 2518, Section 10.4}
      {http://www.webdav.org/specs/rfc2518.html#STATUS_423}}
  \lineiii{FAILED_DEPENDENCY}{\code{424}}
    {WEBDAV, \ulink{RFC 2518, Section 10.5}
      {http://www.webdav.org/specs/rfc2518.html#STATUS_424}}
  \lineiii{UPGRADE_REQUIRED}{\code{426}}
    {HTTP Upgrade to TLS, \rfc{2817}, Section 6}

  \lineiii{INTERNAL_SERVER_ERROR}{\code{500}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.5.1}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1}}
  \lineiii{NOT_IMPLEMENTED}{\code{501}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.5.2}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2}}
  \lineiii{BAD_GATEWAY}{\code{502}}
    {HTTP/1.1 \ulink{RFC 2616, Section 10.5.3}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.3}}
  \lineiii{SERVICE_UNAVAILABLE}{\code{503}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.5.4}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4}}
  \lineiii{GATEWAY_TIMEOUT}{\code{504}}
    {HTTP/1.1 \ulink{RFC 2616, Section 10.5.5}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.5}}
  \lineiii{HTTP_VERSION_NOT_SUPPORTED}{\code{505}}
    {HTTP/1.1, \ulink{RFC 2616, Section 10.5.6}
      {http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.6}}
  \lineiii{INSUFFICIENT_STORAGE}{\code{507}}
    {WEBDAV, \ulink{RFC 2518, Section 10.6}
      {http://www.webdav.org/specs/rfc2518.html#STATUS_507}}
  \lineiii{NOT_EXTENDED}{\code{510}}
    {An HTTP Extension Framework, \rfc{2774}, Section 7}
\end{tableiii}

\begin{datadesc}{responses}
このディクショナリは、HTTP 1.1ステータスコードをW3Cの名前にマップしたものです。

たとえば \code{httplib.responses[httplib.NOT_FOUND]} は \code{'Not Found'}
となります。
\versionadded{2.5}
\end{datadesc}


\subsection{HTTPConnection オブジェクト \label{httpconnection-objects}}

\class{HTTPConnection} インスタンスには以下のメソッドがあります:

\begin{methoddesc}[HTTPConnection]{request}{method, url\optional{, body\optional{, headers}}}
このメソッドは、 HTTP 要求メソッド \var{method} およびセレクタ \var{url}
を使って、要求をサーバに送ります。\var{body} 引数を指定する場合、
ヘッダが終了した後に送信する文字列データでなければなりません。
ヘッダの Content-Length は自動的に正しい値に設定されます。
\var{headers} 引数は要求と同時に送信される拡張 HTTP ヘッダの内容からなる
マップ型でなくてはなりません。
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{getresponse}{}
サーバに対して HTTP 要求を送り出した後に呼び出されなければりません。
要求に対する応答を取得します。\class{HTTPResponse} インスタンスを
返します。
\note{すべての応答を読み込んでからでなければ新しい要求をサーバに送ること
はできないことに注意しましょう。}
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{set_debuglevel}{level}
デバッグレベル (印字されるデバッグ出力の量) を設定します。
標準のデバッグレベルは \code{0} で、デバッグ出力を全く印字
しません。
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{connect}{}
オブジェクトを生成するときに指定したサーバに接続します。
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{close}{}
サーバへの接続を閉じます。
\end{methoddesc}

上で説明した\method{request()}メソッドを使うかわりに、以下の4つの関数を
使用して要求をステップバイステップで送信することもできます。

\begin{methoddesc}[HTTPConnection]{putrequest}{request, selector\optional{,
      skip\_host\optional{, skip_accept_encoding}}}
サーバへの接続が確立したら、最初にこのメソッドを呼び出さなくては
なりません。このメソッドは \var{request} 文字列、\var{selector} 文字列、
そして HTTP バージョン (\code{HTTP/1.1}) からなる一行を送信します。
\code{Host:} や\code{Accept-Encoding:} ヘッダの自動送信を無効にしたい
場合 (例えば別のコンテンツエンコーディングを受け入れたい場合) には、
\var{skip_host} や \var{skip_accept_encoding} を偽でない値に設定
してください。
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{putheader}{header, argument\optional{, ...}}
\rfc{822} 形式のヘッダをサーバに送ります。この処理では、\var{header}、
コロンとスペース、そして最初の引数からなる 1 行をサーバに送ります。
追加の引数を指定した場合、継続して各行にタブ一つと引数の入った引数行が
送信されます。
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{endheaders}{}
サーバに空行を送り、ヘッダ部が終了したことを通知します。
\end{methoddesc}

\begin{methoddesc}[HTTPConnection]{send}{data}
サーバにデータを送ります。このメソッドは \method{endheaders()} 
が呼び出された直後で、かつ \method{getreply()} が呼び出される
前に使わなければなりません。
\end{methoddesc}

\subsection{HTTPResponse オブジェクト \label{httpresponse-objects}}

\class{HTTPResponse} インスタンスは以下のメソッドと属性を持ちます:

\begin{methoddesc}[HTTPResponse]{read}{\optional{amt}}
応答の本体全体か、\var{amt} バイトまで読み出して返します。
\end{methoddesc}

\begin{methoddesc}[HTTPResponse]{getheader}{name\optional{, default}}
ヘッダ \var{name} の内容を取得して返すか、該当するヘッダがない場合には
\var{default} を返します。
\end{methoddesc}

\begin{methoddesc}[HTTPResponse]{getheaders}{}
(header, value) のタプルからなるリストを返します。
\versionadded{2.4}
\end{methoddesc}

\begin{memberdesc}[HTTPResponse]{msg}
応答ヘッダを含む \class{mimetools.Message} インスタンスです。
\end{memberdesc}

\begin{memberdesc}[HTTPResponse]{version}
サーバが使用した HTTP プロトコルバージョンです。10 は HTTP/1.0 を、
11 は HTTP/1.1 を表します。
\end{memberdesc}

\begin{memberdesc}[HTTPResponse]{status}
サーバから返される状態コードです。
\end{memberdesc}

\begin{memberdesc}[HTTPResponse]{reason}
サーバから返される応答の理由文です。
\end{memberdesc}


\subsection{例 \label{httplib-examples}}

以下は\samp{GET} リクエストの送信方法を示した例です:

\begin{verbatim}
>>> import httplib
>>> conn = httplib.HTTPConnection("www.python.org")
>>> conn.request("GET", "/index.html")
>>> r1 = conn.getresponse()
>>> print r1.status, r1.reason
200 OK
>>> data1 = r1.read()
>>> conn.request("GET", "/parrot.spam")
>>> r2 = conn.getresponse()
>>> print r2.status, r2.reason
404 Not Found
>>> data2 = r2.read()
>>> conn.close()
\end{verbatim}

以下は \samp{POST} リクエストの送信方法を示した例です:

\begin{verbatim}
>>> import httplib, urllib
>>> params = urllib.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0})
>>> headers = {"Content-type": "application/x-www-form-urlencoded",
...            "Accept": "text/plain"}
>>> conn = httplib.HTTPConnection("musi-cal.mojam.com:80")
>>> conn.request("POST", "/cgi-bin/query", params, headers)
>>> response = conn.getresponse()
>>> print response.status, response.reason
200 OK
>>> data = response.read()
>>> conn.close()
\end{verbatim}
