docs/build/html/pyams_utils.protocol.html
changeset 79 e12e18e99a68
parent 78 54aeb42c0d80
child 80 137705383aaf
equal deleted inserted replaced
78:54aeb42c0d80 79:e12e18e99a68
     1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     3 
       
     4 
       
     5 <html xmlns="http://www.w3.org/1999/xhtml">
       
     6   <head>
       
     7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
       
     8     
       
     9     <title>pyams_utils.protocol package &#8212; PyAMS_utils 0.1.4 documentation</title>
       
    10     
       
    11     <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
       
    12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       
    13     
       
    14     <script type="text/javascript">
       
    15       var DOCUMENTATION_OPTIONS = {
       
    16         URL_ROOT:    './',
       
    17         VERSION:     '0.1.4',
       
    18         COLLAPSE_INDEX: false,
       
    19         FILE_SUFFIX: '.html',
       
    20         HAS_SOURCE:  true
       
    21       };
       
    22     </script>
       
    23     <script type="text/javascript" src="_static/jquery.js"></script>
       
    24     <script type="text/javascript" src="_static/underscore.js"></script>
       
    25     <script type="text/javascript" src="_static/doctools.js"></script>
       
    26     <link rel="index" title="Index" href="genindex.html" />
       
    27     <link rel="search" title="Search" href="search.html" />
       
    28     <link rel="top" title="PyAMS_utils 0.1.4 documentation" href="index.html" />
       
    29 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    30 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    31 <!--[if lte IE 6]>
       
    32 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
       
    33 <![endif]-->
       
    34 
       
    35   </head>
       
    36   <body role="document">
       
    37 
       
    38     <div class="related" role="navigation" aria-label="related navigation">
       
    39       <h3>Navigation</h3>
       
    40       <ul>
       
    41         <li class="right" style="margin-right: 10px">
       
    42           <a href="genindex.html" title="General Index"
       
    43              accesskey="I">index</a></li>
       
    44         <li class="right" >
       
    45           <a href="py-modindex.html" title="Python Module Index"
       
    46              >modules</a> |</li>
       
    47         <li class="nav-item nav-item-0"><a href="index.html">PyAMS_utils 0.1.4 documentation</a> &#187;</li> 
       
    48       </ul>
       
    49     </div>  
       
    50 
       
    51     <div class="document">
       
    52       <div class="documentwrapper">
       
    53         <div class="bodywrapper">
       
    54           <div class="body" role="main">
       
    55             
       
    56   <div class="section" id="pyams-utils-protocol-package">
       
    57 <h1>pyams_utils.protocol package<a class="headerlink" href="#pyams-utils-protocol-package" title="Permalink to this headline">¶</a></h1>
       
    58 <div class="section" id="submodules">
       
    59 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
       
    60 </div>
       
    61 <div class="section" id="module-pyams_utils.protocol.http">
       
    62 <span id="pyams-utils-protocol-http-module"></span><h2>pyams_utils.protocol.http module<a class="headerlink" href="#module-pyams_utils.protocol.http" title="Permalink to this headline">¶</a></h2>
       
    63 <dl class="class">
       
    64 <dt id="pyams_utils.protocol.http.HTTPClient">
       
    65 <em class="property">class </em><code class="descclassname">pyams_utils.protocol.http.</code><code class="descname">HTTPClient</code><span class="sig-paren">(</span><em>method</em>, <em>protocol</em>, <em>servername</em>, <em>url</em>, <em>params={}</em>, <em>credentials=()</em>, <em>proxy=()</em>, <em>rdns=True</em>, <em>proxy_auth=()</em>, <em>timeout=None</em>, <em>headers={}</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.http.HTTPClient" title="Permalink to this definition">¶</a></dt>
       
    66 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
    67 <p>HTTP client with proxy support</p>
       
    68 <dl class="method">
       
    69 <dt id="pyams_utils.protocol.http.HTTPClient.get_response">
       
    70 <code class="descname">get_response</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.http.HTTPClient.get_response" title="Permalink to this definition">¶</a></dt>
       
    71 <dd><p>Common HTTP request</p>
       
    72 </dd></dl>
       
    73 
       
    74 </dd></dl>
       
    75 
       
    76 <dl class="function">
       
    77 <dt id="pyams_utils.protocol.http.get_client">
       
    78 <code class="descclassname">pyams_utils.protocol.http.</code><code class="descname">get_client</code><span class="sig-paren">(</span><em>method</em>, <em>protocol</em>, <em>servername</em>, <em>url</em>, <em>params={}</em>, <em>credentials=()</em>, <em>proxy=()</em>, <em>rdns=True</em>, <em>proxy_auth=()</em>, <em>timeout=None</em>, <em>headers={}</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.http.get_client" title="Permalink to this definition">¶</a></dt>
       
    79 <dd><p>HTTP client factory</p>
       
    80 </dd></dl>
       
    81 
       
    82 <dl class="function">
       
    83 <dt id="pyams_utils.protocol.http.get_client_from_url">
       
    84 <code class="descclassname">pyams_utils.protocol.http.</code><code class="descname">get_client_from_url</code><span class="sig-paren">(</span><em>url</em>, <em>credentials=()</em>, <em>proxy=()</em>, <em>rdns=True</em>, <em>proxy_auth=()</em>, <em>timeout=None</em>, <em>headers={}</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.http.get_client_from_url" title="Permalink to this definition">¶</a></dt>
       
    85 <dd><p>HTTP client factory from URL</p>
       
    86 </dd></dl>
       
    87 
       
    88 </div>
       
    89 <div class="section" id="module-pyams_utils.protocol.xmlrpc">
       
    90 <span id="pyams-utils-protocol-xmlrpc-module"></span><h2>pyams_utils.protocol.xmlrpc module<a class="headerlink" href="#module-pyams_utils.protocol.xmlrpc" title="Permalink to this headline">¶</a></h2>
       
    91 <dl class="class">
       
    92 <dt id="pyams_utils.protocol.xmlrpc.SecureXMLRPCCookieAuthTransport">
       
    93 <em class="property">class </em><code class="descclassname">pyams_utils.protocol.xmlrpc.</code><code class="descname">SecureXMLRPCCookieAuthTransport</code><span class="sig-paren">(</span><em>user_agent</em>, <em>credentials=()</em>, <em>cookies=None</em>, <em>timeout=&lt;object object&gt;</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.SecureXMLRPCCookieAuthTransport" title="Permalink to this definition">¶</a></dt>
       
    94 <dd><p>Bases: <a class="reference internal" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport" title="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport</span></code></a></p>
       
    95 <p>Secure XML-RPC transport</p>
       
    96 </dd></dl>
       
    97 
       
    98 <dl class="class">
       
    99 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport">
       
   100 <em class="property">class </em><code class="descclassname">pyams_utils.protocol.xmlrpc.</code><code class="descname">XMLRPCCookieAuthTransport</code><span class="sig-paren">(</span><em>user_agent</em>, <em>credentials=()</em>, <em>cookies=None</em>, <em>timeout=&lt;object object&gt;</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport" title="Permalink to this definition">¶</a></dt>
       
   101 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">xmlrpc.client.Transport</span></code></p>
       
   102 <p>An XML-RPC transport handling authentication via cookies</p>
       
   103 <dl class="class">
       
   104 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieRequest">
       
   105 <em class="property">class </em><code class="descname">CookieRequest</code><span class="sig-paren">(</span><em>url</em>, <em>data=None</em>, <em>headers={}</em>, <em>origin_req_host=None</em>, <em>unverifiable=False</em>, <em>method=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieRequest" title="Permalink to this definition">¶</a></dt>
       
   106 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">urllib.request.Request</span></code></p>
       
   107 </dd></dl>
       
   108 
       
   109 <dl class="class">
       
   110 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponse">
       
   111 <em class="property">class </em><code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">CookieResponse</code><span class="sig-paren">(</span><em>response</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponse" title="Permalink to this definition">¶</a></dt>
       
   112 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   113 <dl class="method">
       
   114 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponse.info">
       
   115 <code class="descname">info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponse.info" title="Permalink to this definition">¶</a></dt>
       
   116 <dd></dd></dl>
       
   117 
       
   118 </dd></dl>
       
   119 
       
   120 <dl class="class">
       
   121 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponseHelper">
       
   122 <em class="property">class </em><code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">CookieResponseHelper</code><span class="sig-paren">(</span><em>response</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponseHelper" title="Permalink to this definition">¶</a></dt>
       
   123 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
       
   124 <dl class="method">
       
   125 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponseHelper.getheaders">
       
   126 <code class="descname">getheaders</code><span class="sig-paren">(</span><em>header</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponseHelper.getheaders" title="Permalink to this definition">¶</a></dt>
       
   127 <dd></dd></dl>
       
   128 
       
   129 </dd></dl>
       
   130 
       
   131 <dl class="method">
       
   132 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.get_response">
       
   133 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">get_response</code><span class="sig-paren">(</span><em>connection</em>, <em>host</em>, <em>handler</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.get_response" title="Permalink to this definition">¶</a></dt>
       
   134 <dd></dd></dl>
       
   135 
       
   136 <dl class="method">
       
   137 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.make_connection">
       
   138 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">make_connection</code><span class="sig-paren">(</span><em>host</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.make_connection" title="Permalink to this definition">¶</a></dt>
       
   139 <dd></dd></dl>
       
   140 
       
   141 <dl class="method">
       
   142 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.request">
       
   143 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">request</code><span class="sig-paren">(</span><em>host</em>, <em>handler</em>, <em>request_body</em>, <em>verbose=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.request" title="Permalink to this definition">¶</a></dt>
       
   144 <dd></dd></dl>
       
   145 
       
   146 <dl class="method">
       
   147 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_auth">
       
   148 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">send_auth</code><span class="sig-paren">(</span><em>connection</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_auth" title="Permalink to this definition">¶</a></dt>
       
   149 <dd></dd></dl>
       
   150 
       
   151 <dl class="method">
       
   152 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_content_type">
       
   153 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">send_content_type</code><span class="sig-paren">(</span><em>connection</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_content_type" title="Permalink to this definition">¶</a></dt>
       
   154 <dd></dd></dl>
       
   155 
       
   156 <dl class="method">
       
   157 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_headers">
       
   158 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">send_headers</code><span class="sig-paren">(</span><em>connection</em>, <em>headers</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_headers" title="Permalink to this definition">¶</a></dt>
       
   159 <dd></dd></dl>
       
   160 
       
   161 <dl class="method">
       
   162 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_request">
       
   163 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">send_request</code><span class="sig-paren">(</span><em>host</em>, <em>handler</em>, <em>request_body</em>, <em>debug</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_request" title="Permalink to this definition">¶</a></dt>
       
   164 <dd></dd></dl>
       
   165 
       
   166 <dl class="method">
       
   167 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_user_agent">
       
   168 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">send_user_agent</code><span class="sig-paren">(</span><em>connection</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_user_agent" title="Permalink to this definition">¶</a></dt>
       
   169 <dd></dd></dl>
       
   170 
       
   171 <dl class="attribute">
       
   172 <dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.verbose">
       
   173 <code class="descclassname">XMLRPCCookieAuthTransport.</code><code class="descname">verbose</code><em class="property"> = False</em><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.verbose" title="Permalink to this definition">¶</a></dt>
       
   174 <dd></dd></dl>
       
   175 
       
   176 </dd></dl>
       
   177 
       
   178 <dl class="function">
       
   179 <dt id="pyams_utils.protocol.xmlrpc.get_client">
       
   180 <code class="descclassname">pyams_utils.protocol.xmlrpc.</code><code class="descname">get_client</code><span class="sig-paren">(</span><em>uri</em>, <em>credentials=()</em>, <em>verbose=False</em>, <em>allow_none=0</em>, <em>timeout=&lt;object object&gt;</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.get_client" title="Permalink to this definition">¶</a></dt>
       
   181 <dd><p>Get an XML-RPC client which supports basic authentication</p>
       
   182 </dd></dl>
       
   183 
       
   184 <dl class="function">
       
   185 <dt id="pyams_utils.protocol.xmlrpc.get_client_with_cookies">
       
   186 <code class="descclassname">pyams_utils.protocol.xmlrpc.</code><code class="descname">get_client_with_cookies</code><span class="sig-paren">(</span><em>uri</em>, <em>credentials=()</em>, <em>verbose=False</em>, <em>allow_none=0</em>, <em>timeout=&lt;object object&gt;</em>, <em>headers=None</em>, <em>cookies=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_utils.protocol.xmlrpc.get_client_with_cookies" title="Permalink to this definition">¶</a></dt>
       
   187 <dd><p>Get an XML-RPC client which supports authentication through cookies</p>
       
   188 </dd></dl>
       
   189 
       
   190 </div>
       
   191 <div class="section" id="module-pyams_utils.protocol">
       
   192 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_utils.protocol" title="Permalink to this headline">¶</a></h2>
       
   193 </div>
       
   194 </div>
       
   195 
       
   196 
       
   197           </div>
       
   198         </div>
       
   199       </div>
       
   200       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
       
   201         <div class="sphinxsidebarwrapper">
       
   202   <h3><a href="index.html">Table Of Contents</a></h3>
       
   203   <ul>
       
   204 <li><a class="reference internal" href="#">pyams_utils.protocol package</a><ul>
       
   205 <li><a class="reference internal" href="#submodules">Submodules</a></li>
       
   206 <li><a class="reference internal" href="#module-pyams_utils.protocol.http">pyams_utils.protocol.http module</a></li>
       
   207 <li><a class="reference internal" href="#module-pyams_utils.protocol.xmlrpc">pyams_utils.protocol.xmlrpc module</a></li>
       
   208 <li><a class="reference internal" href="#module-pyams_utils.protocol">Module contents</a></li>
       
   209 </ul>
       
   210 </li>
       
   211 </ul>
       
   212 
       
   213 <div id="searchbox" style="display: none" role="search">
       
   214   <h3>Quick search</h3>
       
   215     <form class="search" action="search.html" method="get">
       
   216       <div><input type="text" name="q" /></div>
       
   217       <div><input type="submit" value="Go" /></div>
       
   218       <input type="hidden" name="check_keywords" value="yes" />
       
   219       <input type="hidden" name="area" value="default" />
       
   220     </form>
       
   221 </div>
       
   222 <script type="text/javascript">$('#searchbox').show(0);</script>
       
   223         </div>
       
   224       </div>
       
   225       <div class="clearer"></div>
       
   226     </div>
       
   227     <div class="related" role="navigation" aria-label="related navigation">
       
   228       <h3>Navigation</h3>
       
   229       <ul>
       
   230         <li class="right" style="margin-right: 10px">
       
   231           <a href="genindex.html" title="General Index"
       
   232              >index</a></li>
       
   233         <li class="right" >
       
   234           <a href="py-modindex.html" title="Python Module Index"
       
   235              >modules</a> |</li>
       
   236         <li class="nav-item nav-item-0"><a href="index.html">PyAMS_utils 0.1.4 documentation</a> &#187;</li> 
       
   237       </ul>
       
   238     </div>
       
   239     <div class="footer" role="contentinfo">
       
   240         &#169; Copyright 2016, Thierry Florac &lt;tflorac@ulthar.net&gt;.
       
   241       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
       
   242     </div>
       
   243   </body>
       
   244 </html>