1 <?xml version="1.0" encoding="ascii"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 3 "DTD/xhtml1-transitional.dtd"> 4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 5 <head> 6 <title>googleapiclient.discovery_cache.base</title> 7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> 8 <script type="text/javascript" src="epydoc.js"></script> 9 </head> 10 11 <body bgcolor="white" text="black" link="blue" vlink="#204080" 12 alink="#204080"> 13 <!-- ==================== NAVIGATION BAR ==================== --> 14 <table class="navbar" border="0" width="100%" cellpadding="0" 15 bgcolor="#a0c0ff" cellspacing="0"> 16 <tr valign="middle"> 17 <!-- Home link --> 18 <th> <a 19 href="googleapiclient-module.html">Home</a> </th> 20 21 <!-- Tree link --> 22 <th> <a 23 href="module-tree.html">Trees</a> </th> 24 25 <!-- Index link --> 26 <th> <a 27 href="identifier-index.html">Indices</a> </th> 28 29 <!-- Help link --> 30 <th> <a 31 href="help.html">Help</a> </th> 32 33 <th class="navbar" width="100%"></th> 34 </tr> 35 </table> 36 <table width="100%" cellpadding="0" cellspacing="0"> 37 <tr valign="top"> 38 <td width="100%"> 39 <span class="breadcrumbs"> 40 <a href="googleapiclient-module.html">Package googleapiclient</a> :: 41 <a href="googleapiclient.discovery_cache-module.html">Package discovery_cache</a> :: 42 Module base 43 </span> 44 </td> 45 <td> 46 <table cellpadding="0" cellspacing="0"> 47 <!-- hide/show private --> 48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" 49 onclick="toggle_private();">hide private</a>]</span></td></tr> 50 <tr><td align="right"><span class="options" 51 >[<a href="frames.html" target="_top">frames</a 52 >] | <a href="googleapiclient.discovery_cache.base-pysrc.html" 53 target="_top">no frames</a>]</span></td></tr> 54 </table> 55 </td> 56 </tr> 57 </table> 58 <h1 class="epydoc">Source Code for <a href="googleapiclient.discovery_cache.base-module.html">Module googleapiclient.discovery_cache.base</a></h1> 59 <pre class="py-src"> 60 <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright 2014 Google Inc. All Rights Reserved.</tt> </tt> 61 <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> 62 <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt> 63 <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># you may not use this file except in compliance with the License.</tt> </tt> 64 <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># You may obtain a copy of the License at</tt> </tt> 65 <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> 66 <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># http://www.apache.org/licenses/LICENSE-2.0</tt> </tt> 67 <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> 68 <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># Unless required by applicable law or agreed to in writing, software</tt> </tt> 69 <a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-comment"># distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt> 70 <a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt> 71 <a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt> 72 <a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt> 73 <a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> </tt> 74 <a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring">"""An abstract class for caching the discovery document."""</tt> </tt> 75 <a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> </tt> 76 <a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">abc</tt> </tt> 77 <a name="Cache"></a><div id="Cache-def"><a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"> </tt> 78 <a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"> </tt> 79 <a name="L20"></a><tt class="py-lineno">20</tt> <a class="py-toggle" href="#" id="Cache-toggle" onclick="return toggle('Cache');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.base.Cache-class.html">Cache</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 80 </div><div id="Cache-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Cache-expanded"><a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"> <tt class="py-docstring">"""A base abstract cache class."""</tt> </tt> 81 <a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"> <tt id="link-0" class="py-name" targets="Variable googleapiclient.discovery_cache.base.Cache.__metaclass__=googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__"><a title="googleapiclient.discovery_cache.base.Cache.__metaclass__" class="py-name" href="#" onclick="return doclink('link-0', '__metaclass__', 'link-0');">__metaclass__</a></tt> <tt class="py-op">=</tt> <tt class="py-name">abc</tt><tt class="py-op">.</tt><tt class="py-name">ABCMeta</tt> </tt> 82 <a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> </tt> 83 <a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">abc</tt><tt class="py-op">.</tt><tt class="py-name">abstractmethod</tt> </tt> 84 <a name="Cache.get"></a><div id="Cache.get-def"><a name="L25"></a><tt class="py-lineno">25</tt> <a class="py-toggle" href="#" id="Cache.get-toggle" onclick="return toggle('Cache.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.base.Cache-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 85 </div><div id="Cache.get-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Cache.get-expanded"><a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"> <tt class="py-docstring">"""Gets the content from the memcache with a given key.</tt> </tt> 86 <a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 87 <a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> 88 <a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"><tt class="py-docstring"> url: string, the key for the cache.</tt> </tt> 89 <a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 90 <a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> 91 <a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"><tt class="py-docstring"> object, the value in the cache for the given key, or None if the key is</tt> </tt> 92 <a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"><tt class="py-docstring"> not in the cache.</tt> </tt> 93 <a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> 94 <a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> 95 </div><a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"> </tt> 96 <a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">abc</tt><tt class="py-op">.</tt><tt class="py-name">abstractmethod</tt> </tt> 97 <a name="Cache.set"></a><div id="Cache.set-def"><a name="L38"></a><tt class="py-lineno">38</tt> <a class="py-toggle" href="#" id="Cache.set-toggle" onclick="return toggle('Cache.set');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient.discovery_cache.base.Cache-class.html#set">set</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">content</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 98 </div><div id="Cache.set-collapsed" style="display:none;" pad="++" indent="++++++"></div><div id="Cache.set-expanded"><a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"> <tt class="py-docstring">"""Sets the given key and content in the cache.</tt> </tt> 99 <a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 100 <a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> 101 <a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"><tt class="py-docstring"> url: string, the key for the cache.</tt> </tt> 102 <a name="L43"></a><tt class="py-lineno">43</tt> <tt class="py-line"><tt class="py-docstring"> content: string, the discovery document.</tt> </tt> 103 <a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> 104 <a name="L45"></a><tt class="py-lineno">45</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> 105 </div></div><a name="L46"></a><tt class="py-lineno">46</tt> <tt class="py-line"> </tt><script type="text/javascript"> 106 <!-- 107 expandto(location.href); 108 // --> 109 </script> 110 </pre> 111 <br /> 112 <!-- ==================== NAVIGATION BAR ==================== --> 113 <table class="navbar" border="0" width="100%" cellpadding="0" 114 bgcolor="#a0c0ff" cellspacing="0"> 115 <tr valign="middle"> 116 <!-- Home link --> 117 <th> <a 118 href="googleapiclient-module.html">Home</a> </th> 119 120 <!-- Tree link --> 121 <th> <a 122 href="module-tree.html">Trees</a> </th> 123 124 <!-- Index link --> 125 <th> <a 126 href="identifier-index.html">Indices</a> </th> 127 128 <!-- Help link --> 129 <th> <a 130 href="help.html">Help</a> </th> 131 132 <th class="navbar" width="100%"></th> 133 </tr> 134 </table> 135 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> 136 <tr> 137 <td align="left" class="footer"> 138 Generated by Epydoc 3.0.1 on Mon Jun 5 13:38:40 2017 139 </td> 140 <td align="right" class="footer"> 141 <a target="mainFrame" href="http://epydoc.sourceforge.net" 142 >http://epydoc.sourceforge.net</a> 143 </td> 144 </tr> 145 </table> 146 147 <script type="text/javascript"> 148 <!-- 149 // Private objects are initially displayed (because if 150 // javascript is turned off then we want them to be 151 // visible); but by default, we want to hide them. So hide 152 // them unless we have a cookie that says to show them. 153 checkCookie(); 154 // --> 155 </script> 156 </body> 157 </html> 158
