docs/epy/oauth2client.tools.ClientRedirectServer-class.html - Issue 6305043: Switch to epydoc for documenting library.

Unified Diff: docs/epy/oauth2client.tools.ClientRedirectServer-class.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)

Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 10 months ago

Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.

Jump to:

View side-by-side diff with in-line comments

Index: docs/epy/oauth2client.tools.ClientRedirectServer-class.html

===================================================================

new file mode 100644

--- /dev/null

+++ b/docs/epy/oauth2client.tools.ClientRedirectServer-class.html

@@ -0,0 +1,225 @@

+<?xml version="1.0" encoding="ascii"?>

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

+ "DTD/xhtml1-transitional.dtd">

+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

+<head>

+ <title>oauth2client.tools.ClientRedirectServer</title>

+ <link rel="stylesheet" href="epydoc.css" type="text/css" />

+ <script type="text/javascript" src="epydoc.js"></script>

+</head>

+<body bgcolor="white" text="black" link="blue" vlink="#204080"

+ alink="#204080">

+

+<table class="navbar" border="0" width="100%" cellpadding="0"

+ bgcolor="#a0c0ff" cellspacing="0">

+ <tr valign="middle">

+

+ <th>   <a

+ href="module-tree.html">Trees</a>   </th>

+

+ <th>   <a

+ href="identifier-index.html">Indices</a>   </th>

+

+ <th>   <a

+ href="help.html">Help</a>   </th>

+ <th class="navbar" width="100%"></th>

+ </tr>

+</table>

+<table width="100%" cellpadding="0" cellspacing="0">

+ <tr valign="top">

+ <td width="100%">

+ <span class="breadcrumbs">

+ <a href="oauth2client-module.html">Package oauth2client</a> ::

+ <a href="oauth2client.tools-module.html">Module tools</a> ::

+ Class ClientRedirectServer

+ </span>

+ </td>

+ <td>

+ <table cellpadding="0" cellspacing="0">

+

+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"

+ onclick="toggle_private();">hide private</a>]</span></td></tr>

+ <tr><td align="right"><span class="options"

+ >[<a href="frames.html" target="_top">frames</a

+ >] | <a href="oauth2client.tools.ClientRedirectServer-class.html"

+ target="_top">no frames</a>]</span></td></tr>

+ </table>

+ </td>

+ </tr>

+</table>

+

+<h1 class="epydoc">Class ClientRedirectServer</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectServer">source code</a></span></p>

+<center>

+<center> <map id="uml_class_diagram_for_oauth2cl_40" name="uml_class_diagram_for_oauth2cl_40">

+<area shape="rect" href="oauth2client.tools.ClientRedirectServer-class.html#query_params" title="oauth2client.tools.ClientRedirectServer.query_params" alt="" coords="184,553,301,572"/>

+<area shape="rect" href="oauth2client.tools.ClientRedirectServer-class.html" title="A server to handle OAuth 2.0 redirects back to localhost." alt="" coords="183,536,303,581"/>

+<area shape="rect" href="javascript:void(0);" title="BaseHTTPServer.HTTPServer.allow_reuse_address" alt="" coords="157,465,328,484"/>

+<area shape="rect" href="javascript:void(0);" title="Override server_bind to store the server name." alt="" coords="157,487,328,505"/>

+<area shape="rect" href="javascript:void(0);" title="BaseHTTPServer.HTTPServer" alt="" coords="156,448,329,507"/>

+<area shape="rect" href="javascript:void(0);" title="SocketServer.BaseServer.timeout" alt="" coords="107,28,379,47"/>

+<area shape="rect" href="javascript:void(0);" title="Handle one request at a time until shutdown." alt="" coords="107,49,379,68"/>

+<area shape="rect" href="javascript:void(0);" title="Stops the serve_forever loop." alt="" coords="107,68,379,87"/>

+<area shape="rect" href="javascript:void(0);" title="Handle one request, possibly blocking." alt="" coords="107,87,379,105"/>

+<area shape="rect" href="javascript:void(0);" title="Called if no new request arrives within self.timeout." alt="" coords="107,105,379,124"/>

+<area shape="rect" href="javascript:void(0);" title="Verify the request." alt="" coords="107,124,379,143"/>

+<area shape="rect" href="javascript:void(0);" title="Call finish_request." alt="" coords="107,143,379,161"/>

+<area shape="rect" href="javascript:void(0);" title="Finish one request by instantiating RequestHandlerClass." alt="" coords="107,161,379,180"/>

+<area shape="rect" href="javascript:void(0);" title="Handle an error gracefully." alt="" coords="107,180,379,199"/>

+<area shape="rect" href="javascript:void(0);" title="Base class for server classes." alt="" coords="105,11,380,200"/>

+<area shape="rect" href="javascript:void(0);" title="SocketServer.TCPServer.address_family" alt="" coords="17,247,468,265"/>

+<area shape="rect" href="javascript:void(0);" title="SocketServer.TCPServer.socket_type" alt="" coords="17,265,468,284"/>

+<area shape="rect" href="javascript:void(0);" title="SocketServer.TCPServer.request_queue_size" alt="" coords="17,284,468,303"/>

+<area shape="rect" href="javascript:void(0);" title="Constructor." alt="" coords="17,305,468,324"/>

+<area shape="rect" href="javascript:void(0);" title="Called by constructor to activate the server." alt="" coords="17,324,468,343"/>

+<area shape="rect" href="javascript:void(0);" title="Called to clean-up the server." alt="" coords="17,343,468,361"/>

+<area shape="rect" href="javascript:void(0);" title="Return socket file number." alt="" coords="17,361,468,380"/>

+<area shape="rect" href="javascript:void(0);" title="Get the request and client address from the socket." alt="" coords="17,380,468,399"/>

+<area shape="rect" href="javascript:void(0);" title="Called to clean up an individual request." alt="" coords="17,399,468,417"/>

+<area shape="rect" href="javascript:void(0);" title="Base class for various socket-based server classes." alt="" coords="16,229,469,419"/>

+</map>

+ <img src="uml_class_diagram_for_oauth2cl_40.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_40" ismap="ismap" class="graph-without-title" />

+</center>

+<hr />

+<pre class="literalblock">

+A server to handle OAuth 2.0 redirects back to localhost.

+Waits for a single request and parses the query parameters

+into query_params and then stops serving.

+</pre>

+

+<a name="section-InstanceMethods"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Instance Methods</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-InstanceMethods"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+ <tr>

+ <td colspan="2" class="summary">

+ <p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.HTTPServer</code></b>:

+ <code>server_bind</code>

+ </p>

+ <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.TCPServer</code></b>:

+ <code>__init__</code>,

+ <code>close_request</code>,

+ <code>fileno</code>,

+ <code>get_request</code>,

+ <code>server_activate</code>,

+ <code>server_close</code>

+ </p>

+ <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b>:

+ <code>finish_request</code>,

+ <code>handle_error</code>,

+ <code>handle_request</code>,

+ <code>handle_timeout</code>,

+ <code>process_request</code>,

+ <code>serve_forever</code>,

+ <code>shutdown</code>,

+ <code>verify_request</code>

+ </p>

+ <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b> (private):

+ <code>_handle_request_noblock</code>

+ </p></div>

+ </td>

+ </tr>

+</table>

+

+<a name="section-ClassVariables"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Class Variables</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-ClassVariables"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a name="query_params"></a><span class="summary-name">query_params</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>

+ </td>

+ </tr>

+ <tr>

+ <td colspan="2" class="summary">

+ <p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.HTTPServer</code></b>:

+ <code>allow_reuse_address</code>

+ </p>

+ <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.TCPServer</code></b>:

+ <code>address_family</code>,

+ <code>request_queue_size</code>,

+ <code>socket_type</code>

+ </p>

+ <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b>:

+ <code>timeout</code>

+ </p>

+ </td>

+ </tr>

+</table>

+

+<table class="navbar" border="0" width="100%" cellpadding="0"

+ bgcolor="#a0c0ff" cellspacing="0">

+ <tr valign="middle">

+

+ <th>   <a

+ href="module-tree.html">Trees</a>   </th>

+

+ <th>   <a

+ href="identifier-index.html">Indices</a>   </th>

+

+ <th>   <a

+ href="help.html">Help</a>   </th>

+ <th class="navbar" width="100%"></th>

+ </tr>

+</table>

+<table border="0" cellpadding="0" cellspacing="0" width="100%%">

+ <tr>

+ <td align="left" class="footer">

+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:11 2012

+ </td>

+ <td align="right" class="footer">

+ <a target="mainFrame" href="http://epydoc.sourceforge.net"

+ >http://epydoc.sourceforge.net</a>

+ </td>

+ </tr>

+</table>

+<script type="text/javascript">

+ <!--

+ // Private objects are initially displayed (because if

+ // javascript is turned off then we want them to be

+ // visible); but by default, we want to hide them. So hide

+ // them unless we have a cookie that says to show them.

+ checkCookie();

+ // -->

+</script>

+</body>

+</html>

« no previous file with comments | « docs/epy/oauth2client.tools.ClientRedirectHandler-class.html ('k') | docs/epy/redirect.html » ('j') | no next file with comments »