2018-05-14 21:33:22 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2019-12-19 21:50:22 +00:00
< title > composer.http_client — Lorax 32.4 documentation< / title >
2018-05-14 21:33:22 +00:00
2019-03-27 23:44:17 +00:00
< script type = "text/javascript" src = "../../_static/js/modernizr.min.js" > < / script >
2018-05-14 21:33:22 +00:00
2019-03-27 23:44:17 +00:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../" src = "../../_static/documentation_options.js" > < / 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 >
< script type = "text/javascript" src = "../../_static/language_data.js" > < / script >
< script type = "text/javascript" src = "../../_static/js/theme.js" > < / script >
2018-05-14 21:33:22 +00:00
2019-03-27 23:44:17 +00:00
2018-05-14 21:33:22 +00:00
2019-03-27 23:44:17 +00:00
< link rel = "stylesheet" href = "../../_static/css/theme.css" type = "text/css" / >
2018-05-14 21:33:22 +00:00
< link rel = "stylesheet" href = "../../_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "../../genindex.html" / >
< link rel = "search" title = "Search" href = "../../search.html" / >
< / head >
< body class = "wy-body-for-nav" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
2019-03-27 23:44:17 +00:00
< div class = "wy-side-nav-search" >
2018-05-14 21:33:22 +00:00
< a href = "../../index.html" class = "icon icon-home" > Lorax
< / a >
< div class = "version" >
2019-12-19 21:50:22 +00:00
32.4
2018-05-14 21:33:22 +00:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "../../search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../intro.html" > Introduction to Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../intro.html#before-lorax" > Before Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../lorax.html" > Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../livemedia-creator.html" > livemedia-creator< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../lorax-composer.html" > lorax-composer< / a > < / li >
2018-10-29 20:42:44 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../composer-cli.html" > composer-cli< / a > < / li >
2019-11-05 22:45:24 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../mkksiso.html" > mkksiso< / a > < / li >
2018-05-14 21:33:22 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../product-images.html" > Product and Updates Images< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../modules.html" > src< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "../../index.html" > Lorax< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "../../index.html" > Docs< / a > » < / li >
< li > < a href = "../index.html" > Module code< / a > » < / li >
< li > composer.http_client< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 > Source code for composer.http_client< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "c1" > #< / span >
< span class = "c1" > # Copyright (C) 2018 Red Hat, Inc.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is free software; you can redistribute it and/or modify< / span >
< span class = "c1" > # it under the terms of the GNU General Public License as published by< / span >
< span class = "c1" > # the Free Software Foundation; either version 2 of the License, or< / span >
< span class = "c1" > # (at your option) any later version.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is distributed in the hope that it will be useful,< / span >
< span class = "c1" > # but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< span class = "c1" > # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< span class = "c1" > # GNU General Public License for more details.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # You should have received a copy of the GNU General Public License< / span >
< span class = "c1" > # along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< span class = "c1" > #< / span >
< span class = "kn" > import< / span > < span class = "nn" > logging< / span >
2018-10-29 20:42:44 +00:00
< span class = "n" > log< / span > < span class = "o" > =< / span > < span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > getLogger< / span > < span class = "p" > (< / span > < span class = "s2" > " composer-cli" < / span > < span class = "p" > )< / span >
2018-05-14 21:33:22 +00:00
< span class = "kn" > import< / span > < span class = "nn" > os< / span >
< span class = "kn" > import< / span > < span class = "nn" > sys< / span >
< span class = "kn" > import< / span > < span class = "nn" > json< / span >
2018-09-06 17:40:16 +00:00
< span class = "kn" > from< / span > < span class = "nn" > urllib.parse< / span > < span class = "k" > import< / span > < span class = "n" > urlparse< / span > < span class = "p" > ,< / span > < span class = "n" > urlunparse< / span >
2018-05-14 21:33:22 +00:00
< span class = "kn" > from< / span > < span class = "nn" > composer.unix_socket< / span > < span class = "k" > import< / span > < span class = "n" > UnixHTTPConnectionPool< / span >
< div class = "viewcode-block" id = "api_url" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.api_url" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > api_url< / span > < span class = "p" > (< / span > < span class = "n" > api_version< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return the versioned path to the API route< / span >
< span class = "sd" > :param api_version: The version of the API to talk to. eg. " 0" < / span >
< span class = "sd" > :type api_version: str< / span >
< span class = "sd" > :param url: The API route to talk to< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :returns: The full url to use for the route and API version< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > normpath< / span > < span class = "p" > (< / span > < span class = "s2" > " /api/v< / span > < span class = "si" > %s< / span > < span class = "s2" > /< / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > api_version< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ))< / span > < / div >
2018-09-06 17:40:16 +00:00
< div class = "viewcode-block" id = "append_query" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.append_query" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > append_query< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > query< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Add a query argument to a URL< / span >
< span class = "sd" > The query should be of the form " param1=what& param2=ever" , i.e., no< / span >
< span class = "sd" > leading ' ?' . The new query data will be appended to any existing< / span >
< span class = "sd" > query string.< / span >
< span class = "sd" > :param url: The original URL< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :param query: The query to append< / span >
< span class = "sd" > :type query: str< / span >
< span class = "sd" > :returns: The new URL with the query argument included< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > url_parts< / span > < span class = "o" > =< / span > < span class = "n" > urlparse< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > url_parts< / span > < span class = "o" > .< / span > < span class = "n" > query< / span > < span class = "p" > :< / span >
< span class = "n" > new_query< / span > < span class = "o" > =< / span > < span class = "n" > url_parts< / span > < span class = "o" > .< / span > < span class = "n" > query< / span > < span class = "o" > +< / span > < span class = "s2" > " & " < / span > < span class = "o" > +< / span > < span class = "n" > query< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "n" > new_query< / span > < span class = "o" > =< / span > < span class = "n" > query< / span >
< span class = "k" > return< / span > < span class = "n" > urlunparse< / span > < span class = "p" > ([< / span > < span class = "n" > url_parts< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ],< / span > < span class = "n" > url_parts< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > ],< / span > < span class = "n" > url_parts< / span > < span class = "p" > [< / span > < span class = "mi" > 2< / span > < span class = "p" > ],< / span >
< span class = "n" > url_parts< / span > < span class = "p" > [< / span > < span class = "mi" > 3< / span > < span class = "p" > ],< / span > < span class = "n" > new_query< / span > < span class = "p" > ,< / span > < span class = "n" > url_parts< / span > < span class = "p" > [< / span > < span class = "mi" > 5< / span > < span class = "p" > ]])< / span > < / div >
2018-05-14 21:33:22 +00:00
< div class = "viewcode-block" id = "get_url_raw" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.get_url_raw" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_url_raw< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return the raw results of a GET request< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to request< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :returns: The raw response from the server< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > status< / span > < span class = "o" > ==< / span > < span class = "mi" > 400< / span > < span class = "p" > :< / span >
< span class = "n" > err< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span >
< span class = "k" > if< / span > < span class = "s2" > " status" < / span > < span class = "ow" > in< / span > < span class = "n" > err< / span > < span class = "ow" > and< / span > < span class = "n" > err< / span > < span class = "p" > [< / span > < span class = "s2" > " status" < / span > < span class = "p" > ]< / span > < span class = "o" > ==< / span > < span class = "kc" > False< / span > < span class = "p" > :< / span >
2018-08-13 23:44:47 +00:00
< span class = "n" > msgs< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "n" > e< / span > < span class = "p" > [< / span > < span class = "s2" > " msg" < / span > < span class = "p" > ]< / span > < span class = "k" > for< / span > < span class = "n" > e< / span > < span class = "ow" > in< / span > < span class = "n" > err< / span > < span class = "p" > [< / span > < span class = "s2" > " errors" < / span > < span class = "p" > ]]< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " , " < / span > < span class = "o" > .< / span > < span class = "n" > join< / span > < span class = "p" > (< / span > < span class = "n" > msgs< / span > < span class = "p" > ))< / span >
2018-05-14 21:33:22 +00:00
< span class = "k" > return< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s1" > ' utf-8' < / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "get_url_json" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.get_url_json" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_url_json< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return the JSON results of a GET request< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to request< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :returns: The json response from the server< / span >
< span class = "sd" > :rtype: dict< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s1" > ' utf-8' < / span > < span class = "p" > ))< / span > < / div >
2018-09-06 17:40:16 +00:00
< div class = "viewcode-block" id = "get_url_json_unlimited" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.get_url_json_unlimited" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_url_json_unlimited< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > total_fn< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return the JSON results of a GET request< / span >
< span class = "sd" > For URLs that use offset/limit arguments, this command will< / span >
< span class = "sd" > fetch all results for the given request.< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to request< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :returns: The json response from the server< / span >
< span class = "sd" > :rtype: dict< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > def< / span > < span class = "nf" > default_total_fn< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return the total number of available results" " " < / span >
< span class = "k" > return< / span > < span class = "n" > data< / span > < span class = "p" > [< / span > < span class = "s2" > " total" < / span > < span class = "p" > ]< / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "c1" > # Start with limit=0 to just get the number of objects< / span >
< span class = "n" > total_url< / span > < span class = "o" > =< / span > < span class = "n" > append_query< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "s2" > " limit=0" < / span > < span class = "p" > )< / span >
< span class = "n" > r_total< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span > < span class = "n" > total_url< / span > < span class = "p" > )< / span >
< span class = "n" > json_total< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r_total< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s1" > ' utf-8' < / span > < span class = "p" > ))< / span >
< span class = "c1" > # Where to get the total from< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > total_fn< / span > < span class = "p" > :< / span >
< span class = "n" > total_fn< / span > < span class = "o" > =< / span > < span class = "n" > default_total_fn< / span >
< span class = "c1" > # Add the " total" returned by limit=0 as the new limit< / span >
< span class = "n" > unlimited_url< / span > < span class = "o" > =< / span > < span class = "n" > append_query< / span > < span class = "p" > (< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "s2" > " limit=< / span > < span class = "si" > %d< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "n" > total_fn< / span > < span class = "p" > (< / span > < span class = "n" > json_total< / span > < span class = "p" > ))< / span >
< span class = "n" > r_unlimited< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span > < span class = "n" > unlimited_url< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r_unlimited< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s1" > ' utf-8' < / span > < span class = "p" > ))< / span > < / div >
2018-05-14 21:33:22 +00:00
< div class = "viewcode-block" id = "delete_url_json" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.delete_url_json" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > delete_url_json< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Send a DELETE request to the url and return JSON response< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to send DELETE to< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :returns: The json response from the server< / span >
< span class = "sd" > :rtype: dict< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " DELETE" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span > < / div >
< div class = "viewcode-block" id = "post_url" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.post_url" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > post_url< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > body< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " POST raw data to the URL< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to send POST to< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :param body: The data for the body of the POST< / span >
< span class = "sd" > :type body: str< / span >
< span class = "sd" > :returns: The json response from the server< / span >
< span class = "sd" > :rtype: dict< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " POST" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span >
< span class = "n" > body< / span > < span class = "o" > =< / span > < span class = "n" > body< / span > < span class = "o" > .< / span > < span class = "n" > encode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span >
< span class = "k" > return< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span > < / div >
< div class = "viewcode-block" id = "post_url_toml" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.post_url_toml" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > post_url_toml< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > body< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " POST a TOML string to the URL< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to send POST to< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :param body: The data for the body of the POST< / span >
< span class = "sd" > :type body: str< / span >
< span class = "sd" > :returns: The json response from the server< / span >
< span class = "sd" > :rtype: dict< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " POST" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span >
< span class = "n" > body< / span > < span class = "o" > =< / span > < span class = "n" > body< / span > < span class = "o" > .< / span > < span class = "n" > encode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ),< / span >
< span class = "n" > headers< / span > < span class = "o" > =< / span > < span class = "p" > {< / span > < span class = "s2" > " Content-Type" < / span > < span class = "p" > :< / span > < span class = "s2" > " text/x-toml" < / span > < span class = "p" > })< / span >
< span class = "k" > return< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span > < / div >
< div class = "viewcode-block" id = "post_url_json" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.post_url_json" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > post_url_json< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > body< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " POST some JSON data to the URL< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to send POST to< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > :param body: The data for the body of the POST< / span >
< span class = "sd" > :type body: str< / span >
< span class = "sd" > :returns: The json response from the server< / span >
< span class = "sd" > :rtype: dict< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " POST" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span >
< span class = "n" > body< / span > < span class = "o" > =< / span > < span class = "n" > body< / span > < span class = "o" > .< / span > < span class = "n" > encode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ),< / span >
< span class = "n" > headers< / span > < span class = "o" > =< / span > < span class = "p" > {< / span > < span class = "s2" > " Content-Type" < / span > < span class = "p" > :< / span > < span class = "s2" > " application/json" < / span > < span class = "p" > })< / span >
< span class = "k" > return< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span > < / div >
< div class = "viewcode-block" id = "get_filename" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.get_filename" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_filename< / span > < span class = "p" > (< / span > < span class = "n" > headers< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Get the filename from the response header< / span >
< span class = "sd" > :param response: The urllib3 response object< / span >
< span class = "sd" > :type response: Response< / span >
< span class = "sd" > :raises: RuntimeError if it cannot find a filename in the header< / span >
< span class = "sd" > :returns: Filename from content-disposition header< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > debug< / span > < span class = "p" > (< / span > < span class = "s2" > " Headers = < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "p" > ,< / span > < span class = "n" > headers< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "s2" > " content-disposition" < / span > < span class = "ow" > not< / span > < span class = "ow" > in< / span > < span class = "n" > headers< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " No Content-Disposition header; cannot get filename" < / span > < span class = "p" > )< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > k< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > v< / span > < span class = "o" > =< / span > < span class = "n" > headers< / span > < span class = "p" > [< / span > < span class = "s2" > " content-disposition" < / span > < span class = "p" > ]< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "s2" > " ;" < / span > < span class = "p" > )[< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span > < span class = "o" > .< / span > < span class = "n" > strip< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > partition< / span > < span class = "p" > (< / span > < span class = "s2" > " =" < / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > k< / span > < span class = "o" > !=< / span > < span class = "s2" > " filename" < / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " No filename= found in content-disposition header" < / span > < span class = "p" > )< / span >
< span class = "k" > except< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span >
< span class = "k" > except< / span > < span class = "ne" > Exception< / span > < span class = "k" > as< / span > < span class = "n" > e< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " Error parsing filename from content-disposition header: < / span > < span class = "si" > %s< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "nb" > str< / span > < span class = "p" > (< / span > < span class = "n" > e< / span > < span class = "p" > ))< / span >
< span class = "k" > return< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > basename< / span > < span class = "p" > (< / span > < span class = "n" > v< / span > < span class = "p" > )< / span > < / div >
< div class = "viewcode-block" id = "download_file" > < a class = "viewcode-back" href = "../../composer.html#composer.http_client.download_file" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > download_file< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > progress< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Download a file, saving it to the CWD with the included filename< / span >
< span class = "sd" > :param socket_path: Path to the Unix socket to use for API communication< / span >
< span class = "sd" > :type socket_path: str< / span >
< span class = "sd" > :param url: URL to send POST to< / span >
< span class = "sd" > :type url: str< / span >
< span class = "sd" > " " " < / span >
< span class = "n" > http< / span > < span class = "o" > =< / span > < span class = "n" > UnixHTTPConnectionPool< / span > < span class = "p" > (< / span > < span class = "n" > socket_path< / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > =< / span > < span class = "n" > http< / span > < span class = "o" > .< / span > < span class = "n" > request< / span > < span class = "p" > (< / span > < span class = "s2" > " GET" < / span > < span class = "p" > ,< / span > < span class = "n" > url< / span > < span class = "p" > ,< / span > < span class = "n" > preload_content< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > status< / span > < span class = "o" > ==< / span > < span class = "mi" > 400< / span > < span class = "p" > :< / span >
< span class = "n" > err< / span > < span class = "o" > =< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > loads< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > data< / span > < span class = "o" > .< / span > < span class = "n" > decode< / span > < span class = "p" > (< / span > < span class = "s2" > " utf-8" < / span > < span class = "p" > ))< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > err< / span > < span class = "p" > [< / span > < span class = "s2" > " status" < / span > < span class = "p" > ]:< / span >
2018-08-13 23:44:47 +00:00
< span class = "n" > msgs< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "n" > e< / span > < span class = "p" > [< / span > < span class = "s2" > " msg" < / span > < span class = "p" > ]< / span > < span class = "k" > for< / span > < span class = "n" > e< / span > < span class = "ow" > in< / span > < span class = "n" > err< / span > < span class = "p" > [< / span > < span class = "s2" > " errors" < / span > < span class = "p" > ]]< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "s2" > " , " < / span > < span class = "o" > .< / span > < span class = "n" > join< / span > < span class = "p" > (< / span > < span class = "n" > msgs< / span > < span class = "p" > ))< / span >
2018-05-14 21:33:22 +00:00
< span class = "n" > filename< / span > < span class = "o" > =< / span > < span class = "n" > get_filename< / span > < span class = "p" > (< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > headers< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > exists< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ):< / span >
< span class = "n" > msg< / span > < span class = "o" > =< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > exists, skipping download" < / span > < span class = "o" > %< / span > < span class = "n" > filename< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > error< / span > < span class = "p" > (< / span > < span class = "n" > msg< / span > < span class = "p" > )< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "n" > msg< / span > < span class = "p" > )< / span >
< span class = "k" > with< / span > < span class = "nb" > open< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ,< / span > < span class = "s2" > " wb" < / span > < span class = "p" > )< / span > < span class = "k" > as< / span > < span class = "n" > f< / span > < span class = "p" > :< / span >
< span class = "k" > while< / span > < span class = "kc" > True< / span > < span class = "p" > :< / span >
< span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > read< / span > < span class = "p" > (< / span > < span class = "mi" > 10< / span > < span class = "o" > *< / span > < span class = "mi" > 1024< / span > < span class = "o" > **< / span > < span class = "mi" > 2< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > data< / span > < span class = "p" > :< / span >
< span class = "k" > break< / span >
< span class = "n" > f< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > progress< / span > < span class = "p" > :< / span >
< span class = "n" > data_written< / span > < span class = "o" > =< / span > < span class = "n" > f< / span > < span class = "o" > .< / span > < span class = "n" > tell< / span > < span class = "p" > ()< / span >
< span class = "k" > if< / span > < span class = "n" > data_written< / span > < span class = "o" > > < / span > < span class = "mi" > 5< / span > < span class = "o" > *< / span > < span class = "mi" > 1024< / span > < span class = "o" > **< / span > < span class = "mi" > 2< / span > < span class = "p" > :< / span >
< span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > : < / span > < span class = "si" > %0.2f< / span > < span class = "s2" > MB < / span > < span class = "se" > \r< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ,< / span > < span class = "n" > data_written< / span > < span class = "o" > /< / span > < span class = "mi" > 1024< / span > < span class = "o" > **< / span > < span class = "mi" > 2< / span > < span class = "p" > ))< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > : < / span > < span class = "si" > %0.2f< / span > < span class = "s2" > kB< / span > < span class = "se" > \r< / span > < span class = "s2" > " < / span > < span class = "o" > %< / span > < span class = "p" > (< / span > < span class = "n" > filename< / span > < span class = "p" > ,< / span > < span class = "n" > data_written< / span > < span class = "o" > /< / span > < span class = "mi" > 1024< / span > < span class = "p" > ))< / span >
< span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > flush< / span > < span class = "p" > ()< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " " < / span > < span class = "p" > )< / span >
< span class = "n" > r< / span > < span class = "o" > .< / span > < span class = "n" > release_conn< / span > < span class = "p" > ()< / span >
< span class = "k" > return< / span > < span class = "mi" > 0< / span > < / div >
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
2019-03-27 23:44:17 +00:00
© Copyright 2018, Red Hat, Inc.
2018-05-14 21:33:22 +00:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/rtfd/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
2018-06-04 23:34:57 +00:00
SphinxRtdTheme.Navigation.enable(true);
2018-05-14 21:33:22 +00:00
});
2019-03-27 23:44:17 +00:00
< / script >
2018-05-14 21:33:22 +00:00
< / body >
< / html >
