[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / lib / module-BaseHTTPServer.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-SimpleHTTPServer.html" />
<link rel="prev" href="module-SocketServer.html" />
<link rel="parent" href="internet.html" />
<link rel="next" href="module-SimpleHTTPServer.html" />
<meta name='aesop' content='information' />
<title>11.17 BaseHTTPServer -- Basic HTTP server</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="11.16.3 RequestHandler Objects"
  href="node537.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="11. Internet Protocols and"
  href="internet.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="11.18 SimpleHTTPServer  "
  href="module-SimpleHTTPServer.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node537.html">11.16.3 RequestHandler Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-SimpleHTTPServer.html">11.18 SimpleHTTPServer  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION00131700000000000000000">
11.17 <tt class="module">BaseHTTPServer</tt> --
         Basic HTTP server</A>
</H1>

<P>
<A NAME="module-BaseHTTPServer"></A>

<P>
<a id='l2h-3569' xml:id='l2h-3569'></a><a id='l2h-3570' xml:id='l2h-3570'></a><a id='l2h-3601' xml:id='l2h-3601'></a>

<P>
This module defines two classes for implementing HTTP servers
(Web servers). Usually, this module isn't used directly, but is used
as a basis for building functioning Web servers. See the
<tt class="module"><a href="module-SimpleHTTPServer.html">SimpleHTTPServer</a></tt><a id='l2h-3602' xml:id='l2h-3602'></a> and
<tt class="module"><a href="module-CGIHTTPServer.html">CGIHTTPServer</a></tt><a id='l2h-3603' xml:id='l2h-3603'></a> modules.

<P>
The first class, <tt class="class">HTTPServer</tt>, is a
<tt class="class">SocketServer.TCPServer</tt> subclass.  It creates and listens at the
HTTP socket, dispatching the requests to a handler.  Code to create and
run the server looks like this:

<P>
<div class="verbatim"><pre>
def run(server_class=BaseHTTPServer.HTTPServer,
        handler_class=BaseHTTPServer.BaseHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    httpd.serve_forever()
</pre></div>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3571' xml:id='l2h-3571' class="class">HTTPServer</tt></b>(</nobr></td>
  <td><var>server_address, RequestHandlerClass</var>)</td></tr></table></dt>
<dd>
This class builds on the <tt class="class">TCPServer</tt> class by
storing the server address as instance
variables named <tt class="member">server_name</tt> and <tt class="member">server_port</tt>. The
server is accessible by the handler, typically through the handler's
<tt class="member">server</tt> instance variable.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3572' xml:id='l2h-3572' class="class">BaseHTTPRequestHandler</tt></b>(</nobr></td>
  <td><var>request, client_address, server</var>)</td></tr></table></dt>
<dd>
This class is used
to handle the HTTP requests that arrive at the server. By itself,
it cannot respond to any actual HTTP requests; it must be subclassed
to handle each request method (e.g. GET or POST).
<tt class="class">BaseHTTPRequestHandler</tt> provides a number of class and instance
variables, and methods for use by subclasses.

<P>
The handler will parse the request and the headers, then call a
method specific to the request type. The method name is constructed
from the request. For example, for the request method "<tt class="samp">SPAM</tt>", the
<tt class="method">do_SPAM()</tt> method will be called with no arguments. All of
the relevant information is stored in instance variables of the
handler.  Subclasses should not need to override or extend the
<tt class="method">__init__()</tt> method.
</dl>

<P>
<tt class="class">BaseHTTPRequestHandler</tt> has the following instance variables:

<P>
<dl><dt><b><tt id='l2h-3573' xml:id='l2h-3573' class="member">client_address</tt></b></dt>
<dd>
Contains a tuple of the form <code>(<var>host</var>, <var>port</var>)</code> referring
to the client's address.
</dl>

<P>
<dl><dt><b><tt id='l2h-3574' xml:id='l2h-3574' class="member">command</tt></b></dt>
<dd>
Contains the command (request type). For example, <code>'GET'</code>.
</dl>

<P>
<dl><dt><b><tt id='l2h-3575' xml:id='l2h-3575' class="member">path</tt></b></dt>
<dd>
Contains the request path.
</dl>

<P>
<dl><dt><b><tt id='l2h-3576' xml:id='l2h-3576' class="member">request_version</tt></b></dt>
<dd>
Contains the version string from the request. For example,
<code>'HTTP/1.0'</code>.
</dl>

<P>
<dl><dt><b><tt id='l2h-3577' xml:id='l2h-3577' class="member">headers</tt></b></dt>
<dd>
Holds an instance of the class specified by the <tt class="member">MessageClass</tt>
class variable. This instance parses and manages the headers in
the HTTP request.
</dl>

<P>
<dl><dt><b><tt id='l2h-3578' xml:id='l2h-3578' class="member">rfile</tt></b></dt>
<dd>
Contains an input stream, positioned at the start of the optional
input data.
</dl>

<P>
<dl><dt><b><tt id='l2h-3579' xml:id='l2h-3579' class="member">wfile</tt></b></dt>
<dd>
Contains the output stream for writing a response back to the client.
Proper adherence to the HTTP protocol must be used when writing
to this stream.
</dl>

<P>
<tt class="class">BaseHTTPRequestHandler</tt> has the following class variables:

<P>
<dl><dt><b><tt id='l2h-3580' xml:id='l2h-3580' class="member">server_version</tt></b></dt>
<dd>
Specifies the server software version.  You may want to override
this.
The format is multiple whitespace-separated strings,
where each string is of the form name[/version].
For example, <code>'BaseHTTP/0.2'</code>.
</dl>

<P>
<dl><dt><b><tt id='l2h-3581' xml:id='l2h-3581' class="member">sys_version</tt></b></dt>
<dd>
Contains the Python system version, in a form usable by the
<tt class="member">version_string</tt> method and the <tt class="member">server_version</tt> class
variable. For example, <code>'Python/1.4'</code>.
</dl>

<P>
<dl><dt><b><tt id='l2h-3582' xml:id='l2h-3582' class="member">error_message_format</tt></b></dt>
<dd>
Specifies a format string for building an error response to the
client. It uses parenthesized, keyed format specifiers, so the
format operand must be a dictionary. The <var>code</var> key should
be an integer, specifying the numeric HTTP error code value.
<var>message</var> should be a string containing a (detailed) error
message of what occurred, and <var>explain</var> should be an
explanation of the error code number. Default <var>message</var>
and <var>explain</var> values can found in the <var>responses</var>
class variable.
</dl>

<P>
<dl><dt><b><tt id='l2h-3583' xml:id='l2h-3583' class="member">protocol_version</tt></b></dt>
<dd>
This specifies the HTTP protocol version used in responses.  If set
to <code>'HTTP/1.1'</code>, the server will permit HTTP persistent
connections; however, your server <em>must</em> then include an
accurate <code>Content-Length</code> header (using <tt class="method">send_header()</tt>)
in all of its responses to clients.  For backwards compatibility,
the setting defaults to <code>'HTTP/1.0'</code>.
</dl>

<P>
<dl><dt><b><tt id='l2h-3584' xml:id='l2h-3584' class="member">MessageClass</tt></b></dt>
<dd>
Specifies a <tt class="class">rfc822.Message</tt>-like class to parse HTTP
headers. Typically, this is not overridden, and it defaults to
<tt class="class">mimetools.Message</tt>.
<a id='l2h-3586' xml:id='l2h-3586'></a></dl>

<P>
<dl><dt><b><tt id='l2h-3587' xml:id='l2h-3587' class="member">responses</tt></b></dt>
<dd>
This variable contains a mapping of error code integers to two-element
tuples containing a short and long message. For example,
<code>{<var>code</var>: (<var>shortmessage</var>, <var>longmessage</var>)}</code>. The
<var>shortmessage</var> is usually used as the <var>message</var> key in an
error response, and <var>longmessage</var> as the <var>explain</var> key
(see the <tt class="member">error_message_format</tt> class variable).
</dl>

<P>
A <tt class="class">BaseHTTPRequestHandler</tt> instance has the following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3588' xml:id='l2h-3588' class="method">handle</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Calls <tt class="method">handle_one_request()</tt> once (or, if persistent connections
are enabled, multiple times) to handle incoming HTTP requests.
You should never need to override it; instead, implement appropriate
<tt class="method">do_*()</tt> methods.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3589' xml:id='l2h-3589' class="method">handle_one_request</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
This method will parse and dispatch
the request to the appropriate <tt class="method">do_*()</tt> method.  You should
never need to override it.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3590' xml:id='l2h-3590' class="method">send_error</tt></b>(</nobr></td>
  <td><var>code</var><big>[</big><var>, message</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Sends and logs a complete error reply to the client. The numeric
<var>code</var> specifies the HTTP error code, with <var>message</var> as
optional, more specific text. A complete set of headers is sent,
followed by text composed using the <tt class="member">error_message_format</tt>
class variable.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3591' xml:id='l2h-3591' class="method">send_response</tt></b>(</nobr></td>
  <td><var>code</var><big>[</big><var>, message</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Sends a response header and logs the accepted request. The HTTP
response line is sent, followed by <em>Server</em> and <em>Date</em>
headers. The values for these two headers are picked up from the
<tt class="method">version_string()</tt> and <tt class="method">date_time_string()</tt> methods,
respectively.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3592' xml:id='l2h-3592' class="method">send_header</tt></b>(</nobr></td>
  <td><var>keyword, value</var>)</td></tr></table></dt>
<dd>
Writes a specific HTTP header to the output stream. <var>keyword</var>
should specify the header keyword, with <var>value</var> specifying
its value.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3593' xml:id='l2h-3593' class="method">end_headers</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Sends a blank line, indicating the end of the HTTP headers in
the response.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3594' xml:id='l2h-3594' class="method">log_request</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>code</var><big>[</big><var>, size</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Logs an accepted (successful) request. <var>code</var> should specify
the numeric HTTP code associated with the response. If a size of
the response is available, then it should be passed as the
<var>size</var> parameter.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3595' xml:id='l2h-3595' class="method">log_error</tt></b>(</nobr></td>
  <td><var>...</var>)</td></tr></table></dt>
<dd>
Logs an error when a request cannot be fulfilled. By default,
it passes the message to <tt class="method">log_message()</tt>, so it takes the
same arguments (<var>format</var> and additional values).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3596' xml:id='l2h-3596' class="method">log_message</tt></b>(</nobr></td>
  <td><var>format, ...</var>)</td></tr></table></dt>
<dd>
Logs an arbitrary message to <code>sys.stderr</code>. This is typically
overridden to create custom error logging mechanisms. The
<var>format</var> argument is a standard printf-style format string,
where the additional arguments to <tt class="method">log_message()</tt> are applied
as inputs to the formatting. The client address and current date
and time are prefixed to every message logged.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3597' xml:id='l2h-3597' class="method">version_string</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the server software's version string. This is a combination
of the <tt class="member">server_version</tt> and <tt class="member">sys_version</tt> class variables.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3598' xml:id='l2h-3598' class="method">date_time_string</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the current date and time, formatted for a message header.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3599' xml:id='l2h-3599' class="method">log_data_time_string</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the current date and time, formatted for logging.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3600' xml:id='l2h-3600' class="method">address_string</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the client address, formatted for logging. A name lookup
is performed on the client's IP address.
</dl>

<P>
<div class="seealso">
  <p class="heading">See Also:</p>

  <dl compact="compact" class="seemodule">
    <dt>Module <b><tt class="module"><a href="module-CGIHTTPServer.html">CGIHTTPServer</a></tt>:</b>
    <dd>Extended request handler that supports CGI
                            scripts.
  </dl>

<P>
<dl compact="compact" class="seemodule">
    <dt>Module <b><tt class="module"><a href="module-SimpleHTTPServer.html">SimpleHTTPServer</a></tt>:</b>
    <dd>Basic request handler that limits response
                               to files actually under the document root.
  </dl>
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="11.16.3 RequestHandler Objects"
  href="node537.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="11. Internet Protocols and"
  href="internet.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="11.18 SimpleHTTPServer  "
  href="module-SimpleHTTPServer.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node537.html">11.16.3 RequestHandler Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-SimpleHTTPServer.html">11.18 SimpleHTTPServer  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="module-SimpleHTTPServer.html" />
	13	<link rel="prev" href="module-SocketServer.html" />
	14	<link rel="parent" href="internet.html" />
	15	<link rel="next" href="module-SimpleHTTPServer.html" />
	16	<meta name='aesop' content='information' />
	17	<title>11.17 BaseHTTPServer -- Basic HTTP server</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="11.16.3 RequestHandler Objects"
	25	href="node537.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="11. Internet Protocols and"
	28	href="internet.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="11.18 SimpleHTTPServer "
	31	href="module-SimpleHTTPServer.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="node537.html">11.16.3 RequestHandler Objects</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="module-SimpleHTTPServer.html">11.18 SimpleHTTPServer </A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H1><A NAME="SECTION00131700000000000000000">
	56	11.17 <tt class="module">BaseHTTPServer</tt> --
	57	Basic HTTP server</A>
	58	</H1>
	59
	60	<P>
	61	<A NAME="module-BaseHTTPServer"></A>
	62
	63	<P>
	64	<a id='l2h-3569' xml:id='l2h-3569'></a><a id='l2h-3570' xml:id='l2h-3570'></a><a id='l2h-3601' xml:id='l2h-3601'></a>
65
66	<P>
67	This module defines two classes for implementing HTTP servers
68	(Web servers). Usually, this module isn't used directly, but is used
69	as a basis for building functioning Web servers. See the
70	<tt class="module"><a href="module-SimpleHTTPServer.html">SimpleHTTPServer</a></tt><a id='l2h-3602' xml:id='l2h-3602'></a> and
71	<tt class="module"><a href="module-CGIHTTPServer.html">CGIHTTPServer</a></tt><a id='l2h-3603' xml:id='l2h-3603'></a> modules.
72
73	<P>
74	The first class, <tt class="class">HTTPServer</tt>, is a
75	<tt class="class">SocketServer.TCPServer</tt> subclass. It creates and listens at the
76	HTTP socket, dispatching the requests to a handler. Code to create and
77	run the server looks like this:
78
79	<P>
80	<div class="verbatim"><pre>
81	def run(server_class=BaseHTTPServer.HTTPServer,
82	handler_class=BaseHTTPServer.BaseHTTPRequestHandler):
83	server_address = ('', 8000)
84	httpd = server_class(server_address, handler_class)
85	httpd.serve_forever()
86	</pre></div>
87
88	<P>
89	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
90	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3571' xml:id='l2h-3571' class="class">HTTPServer</tt></b>(</nobr></td>
91	<td><var>server_address, RequestHandlerClass</var>)</td></tr></table></dt>
92	<dd>
93	This class builds on the <tt class="class">TCPServer</tt> class by
94	storing the server address as instance
95	variables named <tt class="member">server_name</tt> and <tt class="member">server_port</tt>. The
96	server is accessible by the handler, typically through the handler's
97	<tt class="member">server</tt> instance variable.
98	</dl>
99
100	<P>
101	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
102	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3572' xml:id='l2h-3572' class="class">BaseHTTPRequestHandler</tt></b>(</nobr></td>
103	<td><var>request, client_address, server</var>)</td></tr></table></dt>
104	<dd>
105	This class is used
106	to handle the HTTP requests that arrive at the server. By itself,
107	it cannot respond to any actual HTTP requests; it must be subclassed
108	to handle each request method (e.g. GET or POST).
109	<tt class="class">BaseHTTPRequestHandler</tt> provides a number of class and instance
110	variables, and methods for use by subclasses.
111
112	<P>
113	The handler will parse the request and the headers, then call a
114	method specific to the request type. The method name is constructed
115	from the request. For example, for the request method "<tt class="samp">SPAM</tt>", the
116	<tt class="method">do_SPAM()</tt> method will be called with no arguments. All of
117	the relevant information is stored in instance variables of the
118	handler. Subclasses should not need to override or extend the
119	<tt class="method">__init__()</tt> method.
120	</dl>
121
122	<P>
123	<tt class="class">BaseHTTPRequestHandler</tt> has the following instance variables:
124
125	<P>
126	<dl><dt><b><tt id='l2h-3573' xml:id='l2h-3573' class="member">client_address</tt></b></dt>
127	<dd>
128	Contains a tuple of the form <code>(<var>host</var>, <var>port</var>)</code> referring
129	to the client's address.
130	</dl>
131
132	<P>
133	<dl><dt><b><tt id='l2h-3574' xml:id='l2h-3574' class="member">command</tt></b></dt>
134	<dd>
135	Contains the command (request type). For example, <code>'GET'</code>.
136	</dl>
137
138	<P>
139	<dl><dt><b><tt id='l2h-3575' xml:id='l2h-3575' class="member">path</tt></b></dt>
140	<dd>
141	Contains the request path.
142	</dl>
143
144	<P>
145	<dl><dt><b><tt id='l2h-3576' xml:id='l2h-3576' class="member">request_version</tt></b></dt>
146	<dd>
147	Contains the version string from the request. For example,
148	<code>'HTTP/1.0'</code>.
149	</dl>
150
151	<P>
152	<dl><dt><b><tt id='l2h-3577' xml:id='l2h-3577' class="member">headers</tt></b></dt>
153	<dd>
154	Holds an instance of the class specified by the <tt class="member">MessageClass</tt>
155	class variable. This instance parses and manages the headers in
156	the HTTP request.
157	</dl>
158
159	<P>
160	<dl><dt><b><tt id='l2h-3578' xml:id='l2h-3578' class="member">rfile</tt></b></dt>
161	<dd>
162	Contains an input stream, positioned at the start of the optional
163	input data.
164	</dl>
165
166	<P>
167	<dl><dt><b><tt id='l2h-3579' xml:id='l2h-3579' class="member">wfile</tt></b></dt>
168	<dd>
169	Contains the output stream for writing a response back to the client.
170	Proper adherence to the HTTP protocol must be used when writing
171	to this stream.
172	</dl>
173
174	<P>
175	<tt class="class">BaseHTTPRequestHandler</tt> has the following class variables:
176
177	<P>
178	<dl><dt><b><tt id='l2h-3580' xml:id='l2h-3580' class="member">server_version</tt></b></dt>
179	<dd>
180	Specifies the server software version. You may want to override
181	this.
182	The format is multiple whitespace-separated strings,
183	where each string is of the form name[/version].
184	For example, <code>'BaseHTTP/0.2'</code>.
185	</dl>
186
187	<P>
188	<dl><dt><b><tt id='l2h-3581' xml:id='l2h-3581' class="member">sys_version</tt></b></dt>
189	<dd>
190	Contains the Python system version, in a form usable by the
191	<tt class="member">version_string</tt> method and the <tt class="member">server_version</tt> class
192	variable. For example, <code>'Python/1.4'</code>.
193	</dl>
194
195	<P>
196	<dl><dt><b><tt id='l2h-3582' xml:id='l2h-3582' class="member">error_message_format</tt></b></dt>
197	<dd>
198	Specifies a format string for building an error response to the
199	client. It uses parenthesized, keyed format specifiers, so the
200	format operand must be a dictionary. The <var>code</var> key should
201	be an integer, specifying the numeric HTTP error code value.
202	<var>message</var> should be a string containing a (detailed) error
203	message of what occurred, and <var>explain</var> should be an
204	explanation of the error code number. Default <var>message</var>
205	and <var>explain</var> values can found in the <var>responses</var>
206	class variable.
207	</dl>
208
209	<P>
210	<dl><dt><b><tt id='l2h-3583' xml:id='l2h-3583' class="member">protocol_version</tt></b></dt>
211	<dd>
212	This specifies the HTTP protocol version used in responses. If set
213	to <code>'HTTP/1.1'</code>, the server will permit HTTP persistent
214	connections; however, your server <em>must</em> then include an
215	accurate <code>Content-Length</code> header (using <tt class="method">send_header()</tt>)
216	in all of its responses to clients. For backwards compatibility,
217	the setting defaults to <code>'HTTP/1.0'</code>.
218	</dl>
219
220	<P>
221	<dl><dt><b><tt id='l2h-3584' xml:id='l2h-3584' class="member">MessageClass</tt></b></dt>
222	<dd>
223	Specifies a <tt class="class">rfc822.Message</tt>-like class to parse HTTP
224	headers. Typically, this is not overridden, and it defaults to
225	<tt class="class">mimetools.Message</tt>.
226	<a id='l2h-3586' xml:id='l2h-3586'></a></dl>
227
228	<P>
229	<dl><dt><b><tt id='l2h-3587' xml:id='l2h-3587' class="member">responses</tt></b></dt>
230	<dd>
231	This variable contains a mapping of error code integers to two-element
232	tuples containing a short and long message. For example,
233	<code>{<var>code</var>: (<var>shortmessage</var>, <var>longmessage</var>)}</code>. The
234	<var>shortmessage</var> is usually used as the <var>message</var> key in an
235	error response, and <var>longmessage</var> as the <var>explain</var> key
236	(see the <tt class="member">error_message_format</tt> class variable).
237	</dl>
238
239	<P>
240	A <tt class="class">BaseHTTPRequestHandler</tt> instance has the following methods:
241
242	<P>
243	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
244	<td><nobr><b><tt id='l2h-3588' xml:id='l2h-3588' class="method">handle</tt></b>(</nobr></td>
245	<td><var></var>)</td></tr></table></dt>
246	<dd>
247	Calls <tt class="method">handle_one_request()</tt> once (or, if persistent connections
248	are enabled, multiple times) to handle incoming HTTP requests.
249	You should never need to override it; instead, implement appropriate
250	<tt class="method">do_*()</tt> methods.
251	</dl>
252
253	<P>
254	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
255	<td><nobr><b><tt id='l2h-3589' xml:id='l2h-3589' class="method">handle_one_request</tt></b>(</nobr></td>
256	<td><var></var>)</td></tr></table></dt>
257	<dd>
258	This method will parse and dispatch
259	the request to the appropriate <tt class="method">do_*()</tt> method. You should
260	never need to override it.
261	</dl>
262
263	<P>
264	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
265	<td><nobr><b><tt id='l2h-3590' xml:id='l2h-3590' class="method">send_error</tt></b>(</nobr></td>
266	<td><var>code</var><big>[</big><var>, message</var><big>]</big><var></var>)</td></tr></table></dt>
267	<dd>
268	Sends and logs a complete error reply to the client. The numeric
269	<var>code</var> specifies the HTTP error code, with <var>message</var> as
270	optional, more specific text. A complete set of headers is sent,
271	followed by text composed using the <tt class="member">error_message_format</tt>
272	class variable.
273	</dl>
274
275	<P>
276	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
277	<td><nobr><b><tt id='l2h-3591' xml:id='l2h-3591' class="method">send_response</tt></b>(</nobr></td>
278	<td><var>code</var><big>[</big><var>, message</var><big>]</big><var></var>)</td></tr></table></dt>
279	<dd>
280	Sends a response header and logs the accepted request. The HTTP
281	response line is sent, followed by <em>Server</em> and <em>Date</em>
282	headers. The values for these two headers are picked up from the
283	<tt class="method">version_string()</tt> and <tt class="method">date_time_string()</tt> methods,
284	respectively.
285	</dl>
286
287	<P>
288	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
289	<td><nobr><b><tt id='l2h-3592' xml:id='l2h-3592' class="method">send_header</tt></b>(</nobr></td>
290	<td><var>keyword, value</var>)</td></tr></table></dt>
291	<dd>
292	Writes a specific HTTP header to the output stream. <var>keyword</var>
293	should specify the header keyword, with <var>value</var> specifying
294	its value.
295	</dl>
296
297	<P>
298	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
299	<td><nobr><b><tt id='l2h-3593' xml:id='l2h-3593' class="method">end_headers</tt></b>(</nobr></td>
300	<td><var></var>)</td></tr></table></dt>
301	<dd>
302	Sends a blank line, indicating the end of the HTTP headers in
303	the response.
304	</dl>
305
306	<P>
307	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
308	<td><nobr><b><tt id='l2h-3594' xml:id='l2h-3594' class="method">log_request</tt></b>(</nobr></td>
309	<td><var></var><big>[</big><var>code</var><big>[</big><var>, size</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
310	<dd>
311	Logs an accepted (successful) request. <var>code</var> should specify
312	the numeric HTTP code associated with the response. If a size of
313	the response is available, then it should be passed as the
314	<var>size</var> parameter.
315	</dl>
316
317	<P>
318	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
319	<td><nobr><b><tt id='l2h-3595' xml:id='l2h-3595' class="method">log_error</tt></b>(</nobr></td>
320	<td><var>...</var>)</td></tr></table></dt>
321	<dd>
322	Logs an error when a request cannot be fulfilled. By default,
323	it passes the message to <tt class="method">log_message()</tt>, so it takes the
324	same arguments (<var>format</var> and additional values).
325	</dl>
326
327	<P>
328	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
329	<td><nobr><b><tt id='l2h-3596' xml:id='l2h-3596' class="method">log_message</tt></b>(</nobr></td>
330	<td><var>format, ...</var>)</td></tr></table></dt>
331	<dd>
332	Logs an arbitrary message to <code>sys.stderr</code>. This is typically
333	overridden to create custom error logging mechanisms. The
334	<var>format</var> argument is a standard printf-style format string,
335	where the additional arguments to <tt class="method">log_message()</tt> are applied
336	as inputs to the formatting. The client address and current date
337	and time are prefixed to every message logged.
338	</dl>
339
340	<P>
341	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
342	<td><nobr><b><tt id='l2h-3597' xml:id='l2h-3597' class="method">version_string</tt></b>(</nobr></td>
343	<td><var></var>)</td></tr></table></dt>
344	<dd>
345	Returns the server software's version string. This is a combination
346	of the <tt class="member">server_version</tt> and <tt class="member">sys_version</tt> class variables.
347	</dl>
348
349	<P>
350	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
351	<td><nobr><b><tt id='l2h-3598' xml:id='l2h-3598' class="method">date_time_string</tt></b>(</nobr></td>
352	<td><var></var>)</td></tr></table></dt>
353	<dd>
354	Returns the current date and time, formatted for a message header.
355	</dl>
356
357	<P>
358	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
359	<td><nobr><b><tt id='l2h-3599' xml:id='l2h-3599' class="method">log_data_time_string</tt></b>(</nobr></td>
360	<td><var></var>)</td></tr></table></dt>
361	<dd>
362	Returns the current date and time, formatted for logging.
363	</dl>
364
365	<P>
366	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
367	<td><nobr><b><tt id='l2h-3600' xml:id='l2h-3600' class="method">address_string</tt></b>(</nobr></td>
368	<td><var></var>)</td></tr></table></dt>
369	<dd>
370	Returns the client address, formatted for logging. A name lookup
371	is performed on the client's IP address.
372	</dl>
373
374	<P>
375	<div class="seealso">
376	<p class="heading">See Also:</p>
377
378	<dl compact="compact" class="seemodule">
379	<dt>Module <b><tt class="module"><a href="module-CGIHTTPServer.html">CGIHTTPServer</a></tt>:</b>
380	<dd>Extended request handler that supports CGI
381	scripts.
382	</dl>
383
384	<P>
385	<dl compact="compact" class="seemodule">
386	<dt>Module <b><tt class="module"><a href="module-SimpleHTTPServer.html">SimpleHTTPServer</a></tt>:</b>
387	<dd>Basic request handler that limits response
388	to files actually under the document root.
389	</dl>
390	</div>
391
392	<DIV CLASS="navigation">
393	<div class='online-navigation'>
394	<p></p><hr />
395	<table align="center" width="100%" cellpadding="0" cellspacing="2">
396	<tr>
397	<td class='online-navigation'><a rel="prev" title="11.16.3 RequestHandler Objects"
398	href="node537.html"><img src='../icons/previous.png'
399	border='0' height='32' alt='Previous Page' width='32' /></A></td>
400	<td class='online-navigation'><a rel="parent" title="11. Internet Protocols and"
401	href="internet.html"><img src='../icons/up.png'
402	border='0' height='32' alt='Up One Level' width='32' /></A></td>
403	<td class='online-navigation'><a rel="next" title="11.18 SimpleHTTPServer "
404	href="module-SimpleHTTPServer.html"><img src='../icons/next.png'
405	border='0' height='32' alt='Next Page' width='32' /></A></td>
406	<td align="center" width="100%">Python Library Reference</td>
407	<td class='online-navigation'><a rel="contents" title="Table of Contents"
408	href="contents.html"><img src='../icons/contents.png'
409	border='0' height='32' alt='Contents' width='32' /></A></td>
410	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
411	border='0' height='32' alt='Module Index' width='32' /></a></td>
412	<td class='online-navigation'><a rel="index" title="Index"
413	href="genindex.html"><img src='../icons/index.png'
414	border='0' height='32' alt='Index' width='32' /></A></td>
415	</tr></table>
416	<div class='online-navigation'>
417	<b class="navlabel">Previous:</b>
418	<a class="sectref" rel="prev" href="node537.html">11.16.3 RequestHandler Objects</A>
419	<b class="navlabel">Up:</b>
420	<a class="sectref" rel="parent" href="internet.html">11. Internet Protocols and</A>
421	<b class="navlabel">Next:</b>
422	<a class="sectref" rel="next" href="module-SimpleHTTPServer.html">11.18 SimpleHTTPServer </A>
423	</div>
424	</div>
425	<hr />
426	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
427	</DIV>
428	<!--End of Navigation Panel-->
429	<ADDRESS>
430	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
431	</ADDRESS>
432	</BODY>
433	</HTML>