Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(2182)

Unified Diff: docs/epy/apiclient.model.ProtocolBufferModel-class.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)
Patch Set: Revert old pydocs, they didn't really change. Created 11 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
Download patch
« no previous file with comments | « docs/epy/apiclient.model.Model-class.html ('k') | docs/epy/apiclient.model.RawModel-class.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/epy/apiclient.model.ProtocolBufferModel-class.html
===================================================================
new file mode 100644
--- /dev/null
+++ b/docs/epy/apiclient.model.ProtocolBufferModel-class.html
@@ -0,0 +1,450 @@
+<?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.model.ProtocolBufferModel</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">
+<!-- ==================== NAVIGATION BAR ==================== -->
+<table class="navbar" border="0" width="100%" cellpadding="0"
+ bgcolor="#a0c0ff" cellspacing="0">
+ <tr valign="middle">
+
+ <!-- Tree link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Index link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Help link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;apiclient</a> ::
+ <a href="apiclient.model-module.html">Module&nbsp;model</a> ::
+ Class&nbsp;ProtocolBufferModel
+ </span>
+ </td>
+ <td>
+ <table cellpadding="0" cellspacing="0">
+ <!-- hide/show private -->
+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
+ onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
+ <tr><td align="right"><span class="options"
+ >[<a href="frames.html" target="_top">frames</a
+ >]&nbsp;|&nbsp;<a href="apiclient.model.ProtocolBufferModel-class.html"
+ target="_top">no&nbsp;frames</a>]</span></td></tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<!-- ==================== CLASS DESCRIPTION ==================== -->
+<h1 class="epydoc">Class ProtocolBufferModel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel">source&nbsp;code</a></span></p>
+<center>
+<center> <map id="uml_class_diagram_for_apiclien_25" name="uml_class_diagram_for_apiclien_25">
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#accept" title="apiclient.model.ProtocolBufferModel.accept" alt="" coords="120,183,291,201"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#content_type" title="apiclient.model.ProtocolBufferModel.content_type" alt="" coords="120,201,291,220"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#alt_param" title="apiclient.model.ProtocolBufferModel.alt_param" alt="" coords="120,220,291,239"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#no_content_response" title="apiclient.model.ProtocolBufferModel.no_content_response" alt="" coords="120,239,291,257"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#__init__" title="Constructs a ProtocolBufferModel." alt="" coords="120,260,291,279"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="120,279,291,297"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="120,297,291,316"/>
+<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html" title="Model class for protocol buffers." alt="" coords="119,165,292,317"/>
+<area shape="rect" href="apiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,97,393,116"/>
+<area shape="rect" href="apiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,116,393,135"/>
+<area shape="rect" href="apiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="16,72,395,136"/>
+<area shape="rect" href="apiclient.model.Model-class.html" title="Model base class." alt="" coords="187,11,224,43"/>
+</map>
+ <img src="uml_class_diagram_for_apiclien_25.gif" alt='' usemap="#uml_class_diagram_for_apiclien_25" ismap="ismap" class="graph-without-title" />
+</center>
+</center>
+<hr />
+<pre class="literalblock">
+Model class for protocol buffers.
+
+Serializes and de-serializes the binary protocol buffer sent in the HTTP
+request and response bodies.
+
+</pre>
+
+<!-- ==================== INSTANCE METHODS ==================== -->
+<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">&nbsp;</span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="apiclient.model.ProtocolBufferModel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">protocol_buffer</span>)</span><br />
+ Constructs a ProtocolBufferModel.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel.__init__">source&nbsp;code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="apiclient.model.ProtocolBufferModel-class.html#serialize" class="summary-sig-name">serialize</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">body_value</span>)</span><br />
+ Perform the actual Python object serialization.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel.serialize">source&nbsp;code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="apiclient.model.ProtocolBufferModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">content</span>)</span><br />
+ Perform the actual deserialization from response string to Python
+object.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel.deserialize">source&nbsp;code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2" class="summary">
+ <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
+ <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
+ <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
+ </p>
+ <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
+ <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
+ <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
+ <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
+ </p></div>
+ <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>
+<!-- ==================== CLASS VARIABLES ==================== -->
+<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">&nbsp;</span>
+ </td><td class="summary">
+ <a name="accept"></a><span class="summary-name">accept</span> = <code title="'application/x-protobuf'"><code class="variable-quote">'</code><code class="variable-string">application/x-protobuf</code><code class="variable-quote">'</code></code>
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</span>
+ </td><td class="summary">
+ <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="'application/x-protobuf'"><code class="variable-quote">'</code><code class="variable-string">application/x-protobuf</code><code class="variable-quote">'</code></code>
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</span>
+ </td><td class="summary">
+ <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="'proto'"><code class="variable-quote">'</code><code class="variable-string">proto</code><code class="variable-quote">'</code></code>
+ </td>
+ </tr>
+</table>
+<!-- ==================== PROPERTIES ==================== -->
+<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 width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</span>
+ </td><td class="summary">
+ <a href="apiclient.model.ProtocolBufferModel-class.html#no_content_response" class="summary-name">no_content_response</a>
+ </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>
+<!-- ==================== METHOD DETAILS ==================== -->
+<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">protocol_buffer</span>)</span>
+ <br /><em class="fname">(Constructor)</em>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel.__init__">source&nbsp;code</a></span>&nbsp;
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Constructs a ProtocolBufferModel.
+
+The serialzed protocol buffer returned in an HTTP response will be
+de-serialized using the given protocol buffer class.
+
+Args:
+ protocol_buffer: The protocol buffer class used to de-serialize a
+ response from the API.
+
+</pre>
+ <dl class="fields">
+ <dt>Overrides:
+ object.__init__
+ </dt>
+ </dl>
+</td></tr></table>
+</div>
+<a name="serialize"></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">serialize</span>(<span class="sig-arg">self</span>,
+ <span class="sig-arg">body_value</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel.serialize">source&nbsp;code</a></span>&nbsp;
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Perform the actual Python object serialization.
+
+Args:
+ body_value: object, the request body as a Python object.
+
+Returns:
+ string, the body in serialized form.
+
+</pre>
+ <dl class="fields">
+ <dt>Overrides:
+ <a href="apiclient.model.BaseModel-class.html#serialize">BaseModel.serialize</a>
+ <dd><em class="note">(inherited documentation)</em></dd>
+ </dt>
+ </dl>
+</td></tr></table>
+</div>
+<a name="deserialize"></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">deserialize</span>(<span class="sig-arg">self</span>,
+ <span class="sig-arg">content</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.model-pysrc.html#ProtocolBufferModel.deserialize">source&nbsp;code</a></span>&nbsp;
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Perform the actual deserialization from response string to Python
+object.
+
+Args:
+ content: string, the body of the HTTP response
+
+Returns:
+ The body de-serialized as a Python object.
+
+</pre>
+ <dl class="fields">
+ <dt>Overrides:
+ <a href="apiclient.model.BaseModel-class.html#deserialize">BaseModel.deserialize</a>
+ <dd><em class="note">(inherited documentation)</em></dd>
+ </dt>
+ </dl>
+</td></tr></table>
+</div>
+<br />
+<!-- ==================== PROPERTY DETAILS ==================== -->
+<a name="section-PropertyDetails"></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">Property Details</span></td>
+ <td align="right" valign="top"
+ ><span class="options">[<a href="#section-PropertyDetails"
+ class="privatelink" onclick="toggle_private();"
+ >hide private</a>]</span></td>
+ </tr>
+ </table>
+ </td>
+</tr>
+</table>
+<a name="no_content_response"></a>
+<div>
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <h3 class="epydoc">no_content_response</h3>
+
+ <dl class="fields">
+ <dt>Get Method:</dt>
+ <dd class="value"><span class="summary-sig"><i>unreachable</i>.no_content_response(<span class="summary-sig-arg">self</span>)</span>
+ </dd>
+ </dl>
+</td></tr></table>
+</div>
+<br />
+<!-- ==================== NAVIGATION BAR ==================== -->
+<table class="navbar" border="0" width="100%" cellpadding="0"
+ bgcolor="#a0c0ff" cellspacing="0">
+ <tr valign="middle">
+
+ <!-- Tree link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Index link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Help link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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.model.Model-class.html ('k') | docs/epy/apiclient.model.RawModel-class.html » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b