Mercurial Mercurial > pyams > pyams_user_guide / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/build/html/pyams_utils.protocol.html
changeset 0 d153941bb745 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_utils.protocol.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,243 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>pyams_utils.protocol package &#8212; PyAMS User Guide 0.1.0 documentation</title>
+    <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.1.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/underscore.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<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" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+  </head>
+  <body>
+
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="pyams-utils-protocol-package">
+<h1>pyams_utils.protocol package<a class="headerlink" href="#pyams-utils-protocol-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="module-pyams_utils.protocol">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_utils.protocol" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="module-pyams_utils.protocol.http">
+<span id="pyams-utils-protocol-http-module"></span><h3>pyams_utils.protocol.http module<a class="headerlink" href="#module-pyams_utils.protocol.http" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_utils.protocol.http.HTTPClient">
+<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>HTTP client with proxy support</p>
+<dl class="method">
+<dt id="pyams_utils.protocol.http.HTTPClient.get_response">
+<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>
+<dd><p>Common HTTP request</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_utils.protocol.http.get_client">
+<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>
+<dd><p>HTTP client factory</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_utils.protocol.http.get_client_from_url">
+<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>
+<dd><p>HTTP client factory from URL</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_utils.protocol.xmlrpc">
+<span id="pyams-utils-protocol-xmlrpc-module"></span><h3>pyams_utils.protocol.xmlrpc module<a class="headerlink" href="#module-pyams_utils.protocol.xmlrpc" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_utils.protocol.xmlrpc.SecureXMLRPCCookieAuthTransport">
+<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>
+<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>
+<p>Secure XML-RPC transport</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport">
+<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">xmlrpc.client.Transport</span></code></p>
+<p>An XML-RPC transport handling authentication via cookies</p>
+<dl class="class">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieRequest">
+<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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">urllib.request.Request</span></code></p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponse">
+<em class="property">class </em><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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponse.info">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponseHelper">
+<em class="property">class </em><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>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.CookieResponseHelper.getheaders">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.get_response">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.make_connection">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.request">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_auth">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_content_type">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_headers">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_request">
+<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>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.send_user_agent">
+<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>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport.verbose">
+<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>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_utils.protocol.xmlrpc.get_client">
+<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>
+<dd><p>Get an XML-RPC client which supports basic authentication</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_utils.protocol.xmlrpc.get_client_with_cookies">
+<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>
+<dd><p>Get an XML-RPC client which supports authentication through cookies</p>
+</dd></dl>
+
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">pyams_utils.protocol package</a><ul>
+<li><a class="reference internal" href="#module-pyams_utils.protocol">Module contents</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a><ul>
+<li><a class="reference internal" href="#module-pyams_utils.protocol.http">pyams_utils.protocol.http module</a></li>
+<li><a class="reference internal" href="#module-pyams_utils.protocol.xmlrpc">pyams_utils.protocol.xmlrpc module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2017, Thierry Florac.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+    </div>
+  </body>
+</html>
\ No newline at end of file
pyams/pyams_user_guide