docs/epy/apiclient.http.RequestMockBuilder-class.html - Issue 6305043: Switch to epydoc for documenting library.

Unified Diff: docs/epy/apiclient.http.RequestMockBuilder-class.html

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

Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 9 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/apiclient.http.RequestMockBuilder-class.html

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

new file mode 100644

--- /dev/null

+++ b/docs/epy/apiclient.http.RequestMockBuilder-class.html

@@ -0,0 +1,335 @@

+<?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>apiclient.http.RequestMockBuilder</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="apiclient-module.html">Package apiclient</a> ::

+ <a href="apiclient.http-module.html">Module http</a> ::

+ Class RequestMockBuilder

+ </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="apiclient.http.RequestMockBuilder-class.html"

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

+ </table>

+ </td>

+ </tr>

+</table>

+

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

+<center>

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

+<area shape="rect" href="apiclient.http.RequestMockBuilder-class.html#__init__" title="Constructor for RequestMockBuilder" alt="" coords="17,36,671,55"/>

+<area shape="rect" href="apiclient.http.RequestMockBuilder-class.html#__call__" title="Implements the callable interface that discovery.build() expects of requestBuilder, which is to build an object compatible with HttpRequest.execute()." alt="" coords="17,55,671,73"/>

+<area shape="rect" href="apiclient.http.RequestMockBuilder-class.html" title="A simple mock of HttpRequest" alt="" coords="16,11,672,75"/>

+</map>

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

+</center>

+<hr />

+<pre class="literalblock">

+A simple mock of HttpRequest

+Pass in a dictionary to the constructor that maps request methodIds to

+tuples of (httplib2.Response, content, opt_expected_body) that should be

+returned when that method is called. None may also be passed in for the

+httplib2.Response, in which case a 200 OK response will be generated.

+If an opt_expected_body (str or dict) is provided, it will be compared to

+the body and UnexpectedBodyError will be raised on inequality.

+Example:

+ response = '{"data": {"id": "tag:google.c...'

+ requestBuilder = RequestMockBuilder(

+ {

+ 'plus.activities.get': (None, response),

+ }

+ )

+ apiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)

+Methods that you do not supply a response for will return a

+200 OK with an empty string as the response content or raise an excpetion

+if check_unexpected is set to True. The methodId is taken from the rpcName

+in the discovery document.

+For more details see the project wiki.

+</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 width="15%" align="right" valign="top" class="summary">

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

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

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

+ <tr>

+ <td><span class="summary-sig"><a href="apiclient.http.RequestMockBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,

+ <span class="summary-sig-arg">responses</span>,

+ <span class="summary-sig-arg">check_unexpected</span>=<span class="summary-sig-default">False</span>)</span><br />

+ Constructor for RequestMockBuilder</td>

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

+ <span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__init__">source code</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">

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

+ <tr>

+ <td><span class="summary-sig"><a href="apiclient.http.RequestMockBuilder-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,

+ <span class="summary-sig-arg">http</span>,

+ <span class="summary-sig-arg">postproc</span>,

+ <span class="summary-sig-arg">uri</span>,

+ <span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,

+ <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>,

+ <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,

+ <span class="summary-sig-arg">methodId</span>=<span class="summary-sig-default">None</span>,

+ <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">None</span>)</span><br />

+ Implements the callable interface that discovery.build() expects

+of requestBuilder, which is to build an object compatible with

+HttpRequest.execute().</td>

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

+ <span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__call__">source code</a></span>

+ </td>

+ </tr>

+ </table>

+ </td>

+ </tr>

+ <tr>

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

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

+ <code>__delattr__</code>,

+ <code>__format__</code>,

+ <code>__getattribute__</code>,

+ <code>__hash__</code>,

+ <code>__new__</code>,

+ <code>__reduce__</code>,

+ <code>__reduce_ex__</code>,

+ <code>__repr__</code>,

+ <code>__setattr__</code>,

+ <code>__sizeof__</code>,

+ <code>__str__</code>,

+ <code>__subclasshook__</code>

+ </p>

+ </td>

+ </tr>

+</table>

+

+<a name="section-Properties"></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">Properties</span></td>

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

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

+ 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>object</code></b>:

+ <code>__class__</code>

+ </p>

+ </td>

+ </tr>

+</table>

+

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

+<table class="details" 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">Method Details</span></td>

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

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

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

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

+ </tr>

+ </table>

+ </td>

+</tr>

+</table>

+<a name="__init__"></a>

+<div>

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

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

+<tr><td>

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

+ <tr valign="top"><td>

+ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,

+ <span class="sig-arg">responses</span>,

+ <span class="sig-arg">check_unexpected</span>=<span class="sig-default">False</span>)</span>

+ <br /><em class="fname">(Constructor)</em>

+ </h3>

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

+ ><span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__init__">source code</a></span> 

+ </td>

+ </tr></table>

+ <pre class="literalblock">

+Constructor for RequestMockBuilder

+The constructed object should be a callable object

+that can replace the class HttpResponse.

+responses - A dictionary that maps methodIds into tuples

+ of (httplib2.Response, content). The methodId

+ comes from the 'rpcName' field in the discovery

+ document.

+check_unexpected - A boolean setting whether or not UnexpectedMethodError

+ should be raised on unsupplied method.

+</pre>

+ <dl class="fields">

+ <dt>Overrides:

+ object.__init__

+ </dt>

+ </dl>

+</td></tr></table>

+</div>

+<a name="__call__"></a>

+<div>

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

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

+<tr><td>

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

+ <tr valign="top"><td>

+ <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>,

+ <span class="sig-arg">http</span>,

+ <span class="sig-arg">postproc</span>,

+ <span class="sig-arg">uri</span>,

+ <span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,

+ <span class="sig-arg">body</span>=<span class="sig-default">None</span>,

+ <span class="sig-arg">headers</span>=<span class="sig-default">None</span>,

+ <span class="sig-arg">methodId</span>=<span class="sig-default">None</span>,

+ <span class="sig-arg">resumable</span>=<span class="sig-default">None</span>)</span>

+ <br /><em class="fname">(Call operator)</em>

+ </h3>

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

+ ><span class="codelink"><a href="apiclient.http-pysrc.html#RequestMockBuilder.__call__">source code</a></span> 

+ </td>

+ </tr></table>

+ <pre class="literalblock">

+Implements the callable interface that discovery.build() expects

+of requestBuilder, which is to build an object compatible with

+HttpRequest.execute(). See that method for the description of the

+parameters and the expected response.

+</pre>

+ <dl class="fields">

+ </dl>

+</td></tr></table>

+</div>

+<br />

+

+<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:07 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/apiclient.http.MediaUploadProgress-class.html ('k') | docs/epy/apiclient.mimeparse-module.html » ('j') | no next file with comments »