<spanid="composer-http-client-module"></span><h2>composer.http_client module<aclass="headerlink"href="#module-composer.http_client"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">api_url</code><spanclass="sig-paren">(</span><emclass="sig-param">api_version</em>, <emclass="sig-param">url</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#api_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.api_url"title="Permalink to this definition">¶</a></dt>
<li><p><strong>api_version</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The version of the API to talk to. eg. "0"</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The API route to talk to</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">append_query</code><spanclass="sig-paren">(</span><emclass="sig-param">url</em>, <emclass="sig-param">query</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#append_query"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.append_query"title="Permalink to this definition">¶</a></dt>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The original URL</p></li>
<li><p><strong>query</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The query to append</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">delete_url_json</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em>, <emclass="sig-param">timeout=120</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#delete_url_json"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.delete_url_json"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">download_file</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em>, <emclass="sig-param">progress=True</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#download_file"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.download_file"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to send POST to</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">get_filename</code><spanclass="sig-paren">(</span><emclass="sig-param">headers</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#get_filename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.get_filename"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">get_url_json</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#get_url_json"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.get_url_json"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to request</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">get_url_json_unlimited</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em>, <emclass="sig-param">total_fn=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#get_url_json_unlimited"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.get_url_json_unlimited"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to request</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">get_url_raw</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#get_url_raw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.get_url_raw"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to request</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">post_url</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em>, <emclass="sig-param">body</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#post_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.post_url"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to send POST to</p></li>
<li><p><strong>body</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The data for the body of the POST</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">post_url_json</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em>, <emclass="sig-param">body</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#post_url_json"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.post_url_json"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to send POST to</p></li>
<li><p><strong>body</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The data for the body of the POST</p></li>
<codeclass="sig-prename descclassname">composer.http_client.</code><codeclass="sig-name descname">post_url_toml</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">url</em>, <emclass="sig-param">body</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/http_client.html#post_url_toml"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.http_client.post_url_toml"title="Permalink to this definition">¶</a></dt>
<li><p><strong>socket_path</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- Path to the Unix socket to use for API communication</p></li>
<li><p><strong>url</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- URL to send POST to</p></li>
<li><p><strong>body</strong> (<aclass="reference external"href="https://docs.python.org/3/library/stdtypes.html#str"title="(in Python v3.8)"><em>str</em></a>) -- The data for the body of the POST</p></li>
<spanid="composer-unix-socket-module"></span><h2>composer.unix_socket module<aclass="headerlink"href="#module-composer.unix_socket"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="sig-prename descclassname">composer.unix_socket.</code><codeclass="sig-name descname">UnixHTTPConnection</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">timeout=60</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/unix_socket.html#UnixHTTPConnection"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.unix_socket.UnixHTTPConnection"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">connect</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/unix_socket.html#UnixHTTPConnection.connect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.unix_socket.UnixHTTPConnection.connect"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">composer.unix_socket.</code><codeclass="sig-name descname">UnixHTTPConnectionPool</code><spanclass="sig-paren">(</span><emclass="sig-param">socket_path</em>, <emclass="sig-param">timeout=60</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/composer/unix_socket.html#UnixHTTPConnectionPool"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#composer.unix_socket.UnixHTTPConnectionPool"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.