Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
joshourisman
joshourisman / gdata python
Repository URL to install this package:
|
Version:
2.1.0.jo1 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module atom.mock_http_core</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="atom.html"><font color="#ffffff">atom</font></a>.mock_http_core</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/atom/mock_http_core.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/atom/mock_http_core.py</a></font></td></tr></table>
<p><tt># Copyright (C) 2009 Google Inc.<br>
#<br>
# Licensed under the Apache License, Version 2.0 (the "License");<br>
# you may not use this file except in compliance with the License.<br>
# You may obtain a copy of the License at<br>
#<br>
# <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
#<br>
# Unless required by applicable law or agreed to in writing, software<br>
# distributed under the License is distributed on an "AS IS" BASIS,<br>
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br>
# See the License for the specific language governing permissions and<br>
# limitations under the License.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="StringIO.html">StringIO</a><br>
<a href="atom.html">atom</a><br>
</td><td width="25%" valign=top><a href="os.html">os</a><br>
<a href="pickle.html">pickle</a><br>
</td><td width="25%" valign=top><a href="tempfile.html">tempfile</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="atom.mock_http_core.html#EchoHttpClient">EchoHttpClient</a>
</font></dt><dt><font face="helvetica, arial"><a href="atom.mock_http_core.html#MockHttpClient">MockHttpClient</a>
</font></dt><dt><font face="helvetica, arial"><a href="atom.mock_http_core.html#SettableHttpClient">SettableHttpClient</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.http_core.html#HttpResponse">atom.http_core.HttpResponse</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="atom.mock_http_core.html#MockHttpResponse">MockHttpResponse</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="atom.mock_http_core.html#Error">Error</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="atom.mock_http_core.html#NoRecordingFound">NoRecordingFound</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="EchoHttpClient">class <strong>EchoHttpClient</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Sends the request data back in the response.<br>
<br>
Used to check the formatting of the request as it was sent. Always responds<br>
with a 200 OK, and some information from the HTTP request is returned in<br>
special Echo-X headers in the response. The following headers are added<br>
in the response:<br>
'Echo-Host': The host name and port number to which the HTTP connection is<br>
made. If no port was passed in, the header will contain<br>
host:None.<br>
'Echo-Uri': The path portion of the URL being requested. /example?x=1&y=2<br>
'Echo-Scheme': The beginning of the URL, usually 'http' or 'https'<br>
'Echo-Method': The HTTP method being used, 'GET', 'POST', 'PUT', etc.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="EchoHttpClient-request"><strong>request</strong></a>(self, http_request)</dt></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="atom.mock_http_core.html#Error">Error</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="MockHttpClient">class <strong>MockHttpClient</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="MockHttpClient-AddResponse"><strong>AddResponse</strong></a> = <a href="#MockHttpClient-add_response">add_response</a>(self, http_request, status, reason, headers<font color="#909090">=None</font>, body<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="MockHttpClient-Request"><strong>Request</strong></a> = <a href="#MockHttpClient-request">request</a>(self, http_request)</dt></dl>
<dl><dt><a name="MockHttpClient-__init__"><strong>__init__</strong></a>(self, recordings<font color="#909090">=None</font>, real_client<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="MockHttpClient-add_response"><strong>add_response</strong></a>(self, http_request, status, reason, headers<font color="#909090">=None</font>, body<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="MockHttpClient-close_session"><strong>close_session</strong></a>(self)</dt><dd><tt>Saves recordings in the temporary file named in use_cached_session.</tt></dd></dl>
<dl><dt><a name="MockHttpClient-delete_session"><strong>delete_session</strong></a>(self, name<font color="#909090">=None</font>)</dt><dd><tt>Removes recordings from a previous live request.</tt></dd></dl>
<dl><dt><a name="MockHttpClient-get_cache_file_name"><strong>get_cache_file_name</strong></a>(self)</dt></dl>
<dl><dt><a name="MockHttpClient-request"><strong>request</strong></a>(self, http_request)</dt><dd><tt>Provide a recorded response, or record a response for replay.<br>
<br>
If the real_client is set, the request will be made using the<br>
real_client, and the response from the server will be recorded.<br>
If the real_client is None (the default), this method will examine<br>
the recordings and find the first which matches.</tt></dd></dl>
<dl><dt><a name="MockHttpClient-use_cached_session"><strong>use_cached_session</strong></a>(self, name<font color="#909090">=None</font>, real_http_client<font color="#909090">=None</font>)</dt><dd><tt>Attempts to load recordings from a previous live request.<br>
<br>
If a temp file with the recordings exists, then it is used to fulfill<br>
requests. If the file does not exist, then a real client is used to<br>
actually make the desired HTTP requests. Requests and responses are<br>
recorded and will be written to the desired temprary cache file when<br>
close_session is called.<br>
<br>
Args:<br>
name: str (optional) The file name of session file to be used. The file<br>
is loaded from the temporary directory of this machine. If no name<br>
is passed in, a default name will be constructed using the<br>
cache_name_prefix, cache_case_name, and cache_test_name of this<br>
<a href="__builtin__.html#object">object</a>.<br>
real_http_client: atom.http_core.HttpClient the real client to be used<br>
if the cached recordings are not found. If the default<br>
value is used, this will be an<br>
atom.http_core.HttpClient.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>cache_case_name</strong> = ''</dl>
<dl><dt><strong>cache_name_prefix</strong> = 'gdata_live_test'</dl>
<dl><dt><strong>cache_test_name</strong> = ''</dl>
<dl><dt><strong>debug</strong> = None</dl>
<dl><dt><strong>last_request_was_live</strong> = False</dl>
<dl><dt><strong>real_client</strong> = None</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="MockHttpResponse">class <strong>MockHttpResponse</strong></a>(<a href="atom.http_core.html#HttpResponse">atom.http_core.HttpResponse</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="atom.mock_http_core.html#MockHttpResponse">MockHttpResponse</a></dd>
<dd><a href="atom.http_core.html#HttpResponse">atom.http_core.HttpResponse</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="MockHttpResponse-__init__"><strong>__init__</strong></a>(self, status<font color="#909090">=None</font>, reason<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, body<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="MockHttpResponse-read"><strong>read</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.http_core.html#HttpResponse">atom.http_core.HttpResponse</a>:<br>
<dl><dt><a name="MockHttpResponse-getheader"><strong>getheader</strong></a>(self, name, default<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="MockHttpResponse-getheaders"><strong>getheaders</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="atom.http_core.html#HttpResponse">atom.http_core.HttpResponse</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="atom.http_core.html#HttpResponse">atom.http_core.HttpResponse</a>:<br>
<dl><dt><strong>reason</strong> = None</dl>
<dl><dt><strong>status</strong> = None</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="NoRecordingFound">class <strong>NoRecordingFound</strong></a>(<a href="atom.mock_http_core.html#Error">Error</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="atom.mock_http_core.html#NoRecordingFound">NoRecordingFound</a></dd>
<dd><a href="atom.mock_http_core.html#Error">Error</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors inherited from <a href="atom.mock_http_core.html#Error">Error</a>:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="NoRecordingFound-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#NoRecordingFound-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="NoRecordingFound-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoRecordingFound-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoRecordingFound-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#NoRecordingFound-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="NoRecordingFound-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="SettableHttpClient">class <strong>SettableHttpClient</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An HTTP Client which responds with the data given in set_response.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="SettableHttpClient-__init__"><strong>__init__</strong></a>(self, status, reason, body, headers)</dt><dd><tt>Configures the response for the server.<br>
<br>
See set_response for details on the arguments to the constructor.</tt></dd></dl>
<dl><dt><a name="SettableHttpClient-request"><strong>request</strong></a>(self, http_request)</dt></dl>
<dl><dt><a name="SettableHttpClient-set_response"><strong>set_response</strong></a>(self, status, reason, body, headers)</dt><dd><tt>Determines the response which will be sent for each request.<br>
<br>
Args:<br>
status: An int for the HTTP status code, example: 200, 404, etc.<br>
reason: String for the HTTP reason, example: OK, NOT FOUND, etc.<br>
body: The body of the HTTP response as a string or a file-like<br>
<a href="__builtin__.html#object">object</a> (something with a read method).<br>
headers: dict of strings containing the HTTP headers in the response.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>__author__</strong> = 'j.s@google.com (Jeff Scudder)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">j.s@google.com (Jeff Scudder)</td></tr></table>
</body></html>