[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / http-redirect-handler.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="http-cookie-processor.html" />
<link rel="prev" href="base-handler-objects.html" />
<link rel="parent" href="module-urllib2.html" />
<link rel="next" href="http-cookie-processor.html" />
<meta name='aesop' content='information' />
<title>11.5.4 HTTPRedirectHandler Objects </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.5.3 BaseHandler Objects"
  href="base-handler-objects.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.5 urllib2  "
  href="module-urllib2.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.5.5 HTTPCookieProcessor Objects"
  href="http-cookie-processor.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="base-handler-objects.html">11.5.3 BaseHandler Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-urllib2.html">11.5 urllib2  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="http-cookie-processor.html">11.5.5 HTTPCookieProcessor Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0013540000000000000000"></A><A NAME="http-redirect-handler"></A>
<BR>
11.5.4 HTTPRedirectHandler Objects 
</H2>

<P>
<span class="note"><b class="label">Note:</b>
Some HTTP redirections require action from this module's client
  code.  If this is the case, <tt class="exception">HTTPError</tt> is raised.  See
  <a class="rfc" id='rfcref-90020' xml:id='rfcref-90020'
href="http://www.faqs.org/rfcs/rfc2616.html">RFC 2616</a> for details of the precise meanings of the various
  redirection codes.</span>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3271' xml:id='l2h-3271' class="method">redirect_request</tt></b>(</nobr></td>
  <td><var>req,
                                                  fp, code, msg, hdrs</var>)</td></tr></table></dt>
<dd>
Return a <tt class="class">Request</tt> or <code>None</code> in response to a redirect.
This is called by the default implementations of the
<tt class="method">http_error_30*()</tt> methods when a redirection is received from
the server.  If a redirection should take place, return a new
<tt class="class">Request</tt> to allow <tt class="method">http_error_30*()</tt> to perform the
redirect.  Otherwise, raise <tt class="exception">HTTPError</tt> if no other handler
should try to handle this URL, or return <code>None</code> if you can't but
another handler might.

<P>
<div class="note"><b class="label">Note:</b>
The default implementation of this method does not strictly
 follow <a class="rfc" id='rfcref-90027' xml:id='rfcref-90027'
href="http://www.faqs.org/rfcs/rfc2616.html">RFC 2616</a>, which says that 301 and 302 responses to <code>POST</code>
 requests must not be automatically redirected without confirmation by
 the user.  In reality, browsers do allow automatic redirection of
 these responses, changing the POST to a <code>GET</code>, and the default
 implementation reproduces this behavior.
</div>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3272' xml:id='l2h-3272' class="method">http_error_301</tt></b>(</nobr></td>
  <td><var>req,
                                                  fp, code, msg, hdrs</var>)</td></tr></table></dt>
<dd>
Redirect to the <code>Location:</code> URL.  This method is called by
the parent <tt class="class">OpenerDirector</tt> when getting an HTTP
`moved permanently' response.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3273' xml:id='l2h-3273' class="method">http_error_302</tt></b>(</nobr></td>
  <td><var>req,
                                                  fp, code, msg, hdrs</var>)</td></tr></table></dt>
<dd>
The same as <tt class="method">http_error_301()</tt>, but called for the
`found' response.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3274' xml:id='l2h-3274' class="method">http_error_303</tt></b>(</nobr></td>
  <td><var>req,
                                                  fp, code, msg, hdrs</var>)</td></tr></table></dt>
<dd>
The same as <tt class="method">http_error_301()</tt>, but called for the
`see other' response.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3275' xml:id='l2h-3275' class="method">http_error_307</tt></b>(</nobr></td>
  <td><var>req,
                                                  fp, code, msg, hdrs</var>)</td></tr></table></dt>
<dd>
The same as <tt class="method">http_error_301()</tt>, but called for the
`temporary redirect' response.
</dl>

<P>

<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.5.3 BaseHandler Objects"
  href="base-handler-objects.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.5 urllib2  "
  href="module-urllib2.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.5.5 HTTPCookieProcessor Objects"
  href="http-cookie-processor.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="base-handler-objects.html">11.5.3 BaseHandler Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-urllib2.html">11.5 urllib2  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="http-cookie-processor.html">11.5.5 HTTPCookieProcessor Objects</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="http-cookie-processor.html" />
	13	<link rel="prev" href="base-handler-objects.html" />
	14	<link rel="parent" href="module-urllib2.html" />
	15	<link rel="next" href="http-cookie-processor.html" />
	16	<meta name='aesop' content='information' />
	17	<title>11.5.4 HTTPRedirectHandler Objects </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.5.3 BaseHandler Objects"
	25	href="base-handler-objects.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.5 urllib2 "
	28	href="module-urllib2.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.5.5 HTTPCookieProcessor Objects"
	31	href="http-cookie-processor.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="base-handler-objects.html">11.5.3 BaseHandler Objects</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="module-urllib2.html">11.5 urllib2 </A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="http-cookie-processor.html">11.5.5 HTTPCookieProcessor Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION0013540000000000000000"></A><A NAME="http-redirect-handler"></A>
	56	<BR>
	57	11.5.4 HTTPRedirectHandler Objects
	58	</H2>
	59
	60	<P>
	61	<span class="note"><b class="label">Note:</b>
	62	Some HTTP redirections require action from this module's client
	63	code. If this is the case, <tt class="exception">HTTPError</tt> is raised. See
	64	<a class="rfc" id='rfcref-90020' xml:id='rfcref-90020'
65	href="http://www.faqs.org/rfcs/rfc2616.html">RFC 2616</a> for details of the precise meanings of the various
66	redirection codes.</span>
67
68	<P>
69	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
70	<td><nobr><b><tt id='l2h-3271' xml:id='l2h-3271' class="method">redirect_request</tt></b>(</nobr></td>
71	<td><var>req,
72	fp, code, msg, hdrs</var>)</td></tr></table></dt>
73	<dd>
74	Return a <tt class="class">Request</tt> or <code>None</code> in response to a redirect.
75	This is called by the default implementations of the
76	<tt class="method">http_error_30*()</tt> methods when a redirection is received from
77	the server. If a redirection should take place, return a new
78	<tt class="class">Request</tt> to allow <tt class="method">http_error_30*()</tt> to perform the
79	redirect. Otherwise, raise <tt class="exception">HTTPError</tt> if no other handler
80	should try to handle this URL, or return <code>None</code> if you can't but
81	another handler might.
82
83	<P>
84	<div class="note"><b class="label">Note:</b>
85	The default implementation of this method does not strictly
86	follow <a class="rfc" id='rfcref-90027' xml:id='rfcref-90027'
87	href="http://www.faqs.org/rfcs/rfc2616.html">RFC 2616</a>, which says that 301 and 302 responses to <code>POST</code>
88	requests must not be automatically redirected without confirmation by
89	the user. In reality, browsers do allow automatic redirection of
90	these responses, changing the POST to a <code>GET</code>, and the default
91	implementation reproduces this behavior.
92	</div>
93	</dl>
94
95	<P>
96	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
97	<td><nobr><b><tt id='l2h-3272' xml:id='l2h-3272' class="method">http_error_301</tt></b>(</nobr></td>
98	<td><var>req,
99	fp, code, msg, hdrs</var>)</td></tr></table></dt>
100	<dd>
101	Redirect to the <code>Location:</code> URL. This method is called by
102	the parent <tt class="class">OpenerDirector</tt> when getting an HTTP
103	`moved permanently' response.
104	</dl>
105
106	<P>
107	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
108	<td><nobr><b><tt id='l2h-3273' xml:id='l2h-3273' class="method">http_error_302</tt></b>(</nobr></td>
109	<td><var>req,
110	fp, code, msg, hdrs</var>)</td></tr></table></dt>
111	<dd>
112	The same as <tt class="method">http_error_301()</tt>, but called for the
113	`found' response.
114	</dl>
115
116	<P>
117	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
118	<td><nobr><b><tt id='l2h-3274' xml:id='l2h-3274' class="method">http_error_303</tt></b>(</nobr></td>
119	<td><var>req,
120	fp, code, msg, hdrs</var>)</td></tr></table></dt>
121	<dd>
122	The same as <tt class="method">http_error_301()</tt>, but called for the
123	`see other' response.
124	</dl>
125
126	<P>
127	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
128	<td><nobr><b><tt id='l2h-3275' xml:id='l2h-3275' class="method">http_error_307</tt></b>(</nobr></td>
129	<td><var>req,
130	fp, code, msg, hdrs</var>)</td></tr></table></dt>
131	<dd>
132	The same as <tt class="method">http_error_301()</tt>, but called for the
133	`temporary redirect' response.
134	</dl>
135
136	<P>
137
138	<DIV CLASS="navigation">
139	<div class='online-navigation'>
140	<p></p><hr />
141	<table align="center" width="100%" cellpadding="0" cellspacing="2">
142	<tr>
143	<td class='online-navigation'><a rel="prev" title="11.5.3 BaseHandler Objects"
144	href="base-handler-objects.html"><img src='../icons/previous.png'
145	border='0' height='32' alt='Previous Page' width='32' /></A></td>
146	<td class='online-navigation'><a rel="parent" title="11.5 urllib2 "
147	href="module-urllib2.html"><img src='../icons/up.png'
148	border='0' height='32' alt='Up One Level' width='32' /></A></td>
149	<td class='online-navigation'><a rel="next" title="11.5.5 HTTPCookieProcessor Objects"
150	href="http-cookie-processor.html"><img src='../icons/next.png'
151	border='0' height='32' alt='Next Page' width='32' /></A></td>
152	<td align="center" width="100%">Python Library Reference</td>
153	<td class='online-navigation'><a rel="contents" title="Table of Contents"
154	href="contents.html"><img src='../icons/contents.png'
155	border='0' height='32' alt='Contents' width='32' /></A></td>
156	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
157	border='0' height='32' alt='Module Index' width='32' /></a></td>
158	<td class='online-navigation'><a rel="index" title="Index"
159	href="genindex.html"><img src='../icons/index.png'
160	border='0' height='32' alt='Index' width='32' /></A></td>
161	</tr></table>
162	<div class='online-navigation'>
163	<b class="navlabel">Previous:</b>
164	<a class="sectref" rel="prev" href="base-handler-objects.html">11.5.3 BaseHandler Objects</A>
165	<b class="navlabel">Up:</b>
166	<a class="sectref" rel="parent" href="module-urllib2.html">11.5 urllib2 </A>
167	<b class="navlabel">Next:</b>
168	<a class="sectref" rel="next" href="http-cookie-processor.html">11.5.5 HTTPCookieProcessor Objects</A>
169	</div>
170	</div>
171	<hr />
172	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
173	</DIV>
174	<!--End of Navigation Panel-->
175	<ADDRESS>
176	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
177	</ADDRESS>
178	</BODY>
179	</HTML>