2018-05-12 00:18:21 +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" >
2020-10-01 22:05:33 +00:00
< title > composer.cli.utilities — Lorax 34.3 documentation< / title >
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" src = "../../../_static/js/modernizr.min.js" > < / script >
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../../" src = "../../../_static/documentation_options.js" > < / script >
2020-09-08 18:59:15 +00:00
< script src = "../../../_static/jquery.js" > < / script >
< script src = "../../../_static/underscore.js" > < / script >
< script src = "../../../_static/doctools.js" > < / script >
< script src = "../../../_static/language_data.js" > < / script >
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" src = "../../../_static/js/theme.js" > < / script >
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
2018-11-13 17:53:31 +00:00
< link rel = "stylesheet" href = "../../../_static/css/theme.css" type = "text/css" / >
2018-05-12 00:18:21 +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:14 +00:00
< div class = "wy-side-nav-search" >
2018-05-12 00:18:21 +00:00
< a href = "../../../index.html" class = "icon icon-home" > Lorax
< / a >
< div class = "version" >
2020-10-01 22:05:33 +00:00
34.3
2018-05-12 00:18:21 +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 >
2018-10-24 17:07:32 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../composer-cli.html" > composer-cli< / a > < / li >
2019-11-05 22:36:46 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../mkksiso.html" > mkksiso< / a > < / li >
2018-05-12 00:18:21 +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 > < a href = "../cli.html" > composer.cli< / a > » < / li >
< li > composer.cli.utilities< / 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.cli.utilities< / 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-24 17:07:32 +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-12 00:18:21 +00:00
< span class = "kn" > import< / span > < span class = "nn" > json< / span >
< div class = "viewcode-block" id = "argify" > < a class = "viewcode-back" href = "../../../composer.cli.html#composer.cli.utilities.argify" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > argify< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Take a list of human args and return a list with each item< / span >
< span class = "sd" > :param args: list of strings with possible commas and spaces< / span >
< span class = "sd" > :type args: list of str< / span >
< span class = "sd" > :returns: List of all the items< / span >
< span class = "sd" > :rtype: list of str< / span >
< span class = "sd" > Examples:< / span >
< span class = "sd" > [" one,two" , " three" , " ,four" , " ,five," ] returns [" one" , " two" , " three" , " four" , " five" ]< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > i< / span > < span class = "k" > for< / span > < span class = "n" > i< / span > < span class = "ow" > in< / span > < span class = "p" > [< / span > < span class = "n" > arg< / span > < span class = "k" > for< / span > < span class = "n" > entry< / span > < span class = "ow" > in< / span > < span class = "n" > args< / span > < span class = "k" > for< / span > < span class = "n" > arg< / span > < span class = "ow" > in< / span > < span class = "n" > entry< / span > < span class = "o" > .< / span > < span class = "n" > split< / span > < span class = "p" > (< / span > < span class = "s2" > " ," < / span > < span class = "p" > )]< / span > < span class = "k" > if< / span > < span class = "n" > i< / span > < span class = "p" > ]< / span > < / div >
< div class = "viewcode-block" id = "toml_filename" > < a class = "viewcode-back" href = "../../../composer.cli.html#composer.cli.utilities.toml_filename" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > toml_filename< / span > < span class = "p" > (< / span > < span class = "n" > blueprint_name< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Convert a blueprint name into a filename.toml< / span >
< span class = "sd" > :param blueprint_name: The blueprint' s name< / span >
< span class = "sd" > :type blueprint_name: str< / span >
< span class = "sd" > :returns: The blueprint name with ' ' converted to - and .toml appended< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > blueprint_name< / span > < span class = "o" > .< / span > < span class = "n" > replace< / span > < span class = "p" > (< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span > < span class = "s2" > " -" < / span > < span class = "p" > )< / span > < span class = "o" > +< / span > < span class = "s2" > " .toml" < / span > < / div >
< div class = "viewcode-block" id = "frozen_toml_filename" > < a class = "viewcode-back" href = "../../../composer.cli.html#composer.cli.utilities.frozen_toml_filename" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > frozen_toml_filename< / span > < span class = "p" > (< / span > < span class = "n" > blueprint_name< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Convert a blueprint name into a filename.toml< / span >
< span class = "sd" > :param blueprint_name: The blueprint' s name< / span >
< span class = "sd" > :type blueprint_name: str< / span >
< span class = "sd" > :returns: The blueprint name with ' ' converted to - and .toml appended< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > blueprint_name< / span > < span class = "o" > .< / span > < span class = "n" > replace< / span > < span class = "p" > (< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span > < span class = "s2" > " -" < / span > < span class = "p" > )< / span > < span class = "o" > +< / span > < span class = "s2" > " .frozen.toml" < / span > < / div >
< div class = "viewcode-block" id = "handle_api_result" > < a class = "viewcode-back" href = "../../../composer.cli.html#composer.cli.utilities.handle_api_result" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > handle_api_result< / span > < span class = "p" > (< / span > < span class = "n" > result< / span > < span class = "p" > ,< / span > < span class = "n" > show_json< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Log any errors, return the correct value< / span >
< span class = "sd" > :param result: JSON result from the http query< / span >
< span class = "sd" > :type result: dict< / span >
2018-08-13 23:43:20 +00:00
< span class = "sd" > :rtype: tuple< / span >
< span class = "sd" > :returns: (rc, should_exit_now)< / span >
< span class = "sd" > Return the correct rc for the program (0 or 1), and whether or< / span >
< span class = "sd" > not to continue processing the results.< / span >
2018-05-12 00:18:21 +00:00
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "n" > show_json< / span > < span class = "p" > :< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dumps< / span > < span class = "p" > (< / span > < span class = "n" > result< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 4< / span > < span class = "p" > ))< / span >
2018-08-13 23:43:20 +00:00
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "k" > for< / span > < span class = "n" > err< / span > < span class = "ow" > in< / span > < span class = "n" > result< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "s2" > " errors" < / span > < span class = "p" > ,< / span > < span class = "p" > []):< / span >
< span class = "n" > log< / span > < span class = "o" > .< / span > < span class = "n" > error< / span > < span class = "p" > (< / span > < span class = "n" > err< / span > < span class = "p" > [< / span > < span class = "s2" > " msg" < / span > < span class = "p" > ])< / span >
2018-05-12 00:18:21 +00:00
2018-08-13 23:43:20 +00:00
< span class = "c1" > # What' s the rc? If status is present, use that< / span >
< span class = "c1" > # If not, use length of errors< / span >
< span class = "k" > if< / span > < span class = "s2" > " status" < / span > < span class = "ow" > in< / span > < span class = "n" > result< / span > < span class = "p" > :< / span >
2019-12-19 21:44:12 +00:00
< span class = "n" > rc< / span > < span class = "o" > =< / span > < span class = "nb" > int< / span > < span class = "p" > (< / span > < span class = "ow" > not< / span > < span class = "n" > result< / span > < span class = "p" > [< / span > < span class = "s2" > " status" < / span > < span class = "p" > ])< / span >
2018-05-12 00:18:21 +00:00
< span class = "k" > else< / span > < span class = "p" > :< / span >
2019-12-19 21:44:12 +00:00
< span class = "n" > rc< / span > < span class = "o" > =< / span > < span class = "nb" > int< / span > < span class = "p" > (< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > result< / span > < span class = "o" > .< / span > < span class = "n" > get< / span > < span class = "p" > (< / span > < span class = "s2" > " errors" < / span > < span class = "p" > ,< / span > < span class = "p" > []))< / span > < span class = "o" > > < / span > < span class = "mi" > 0< / span > < span class = "p" > )< / span >
2018-08-13 23:43:20 +00:00
< span class = "c1" > # Caller should return if showing json, or status was present and False< / span >
< span class = "n" > exit_now< / span > < span class = "o" > =< / span > < span class = "n" > show_json< / span > < span class = "ow" > or< / span > < span class = "p" > (< / span > < span class = "s2" > " status" < / span > < span class = "ow" > in< / span > < span class = "n" > result< / span > < span class = "ow" > and< / span > < span class = "n" > rc< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "p" > (< / span > < span class = "n" > rc< / span > < span class = "p" > ,< / span > < span class = "n" > exit_now< / span > < span class = "p" > )< / span > < / div >
2018-05-12 00:18:21 +00:00
< div class = "viewcode-block" id = "packageNEVRA" > < a class = "viewcode-back" href = "../../../composer.cli.html#composer.cli.utilities.packageNEVRA" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > packageNEVRA< / span > < span class = "p" > (< / span > < span class = "n" > pkg< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return the package info as a NEVRA< / span >
< span class = "sd" > :param pkg: The package details< / span >
< span class = "sd" > :type pkg: dict< / span >
< span class = "sd" > :returns: name-[epoch:]version-release-arch< / span >
< span class = "sd" > :rtype: str< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > if< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " epoch" < / span > < span class = "p" > ]:< / span >
< span class = "k" > return< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > -< / span > < span class = "si" > %s< / span > < span class = "s2" > :< / span > < span class = "si" > %s< / span > < span class = "s2" > -< / 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" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " name" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " epoch" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " version" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " release" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " arch" < / span > < span class = "p" > ])< / span >
< span class = "k" > else< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span > < span class = "s2" > " < / span > < span class = "si" > %s< / span > < span class = "s2" > -< / span > < span class = "si" > %s< / span > < span class = "s2" > -< / 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" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " name" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " version" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " release" < / span > < span class = "p" > ],< / span > < span class = "n" > pkg< / span > < span class = "p" > [< / span > < span class = "s2" > " arch" < / span > < span class = "p" > ])< / span > < / div >
2020-09-08 18:59:15 +00:00
< div class = "viewcode-block" id = "get_arg" > < a class = "viewcode-back" href = "../../../composer.cli.html#composer.cli.utilities.get_arg" > [docs]< / a > < span class = "k" > def< / span > < span class = "nf" > get_arg< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "n" > name< / span > < span class = "p" > ,< / span > < span class = "n" > argtype< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " Return optional value from args, and remaining args< / span >
< span class = "sd" > :param args: list of arguments< / span >
< span class = "sd" > :type args: list of strings< / span >
< span class = "sd" > :param name: The argument to remove from the args list< / span >
< span class = "sd" > :type name: string< / span >
< span class = "sd" > :param argtype: Type to use for checking the argument value< / span >
< span class = "sd" > :type argtype: type< / span >
2020-10-01 22:05:33 +00:00
< span class = "sd" > :returns: (args, value)< / span >
2020-09-08 18:59:15 +00:00
< span class = "sd" > :rtype: tuple< / span >
< span class = "sd" > This removes the optional argument and value from the argument list, returns the new list,< / span >
< span class = "sd" > and the value of the argument.< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "n" > idx< / span > < span class = "o" > =< / span > < span class = "n" > args< / span > < span class = "o" > .< / span > < span class = "n" > index< / span > < span class = "p" > (< / span > < span class = "n" > name< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "nb" > len< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > )< / span > < span class = "o" > < < / span > < span class = "n" > idx< / span > < span class = "o" > +< / span > < span class = "mi" > 2< / span > < span class = "p" > :< / span >
< span class = "k" > raise< / span > < span class = "ne" > RuntimeError< / span > < span class = "p" > (< / span > < span class = "sa" > f< / span > < span class = "s2" > " < / span > < span class = "si" > {< / span > < span class = "n" > name< / span > < span class = "si" > }< / span > < span class = "s2" > is missing the value" < / span > < span class = "p" > )< / span >
< span class = "n" > value< / span > < span class = "o" > =< / span > < span class = "n" > args< / span > < span class = "p" > [< / span > < span class = "n" > idx< / span > < span class = "o" > +< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span >
< span class = "k" > except< / span > < span class = "ne" > ValueError< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "kc" > None< / span > < span class = "p" > )< / span >
< span class = "k" > if< / span > < span class = "n" > argtype< / span > < span class = "p" > :< / span >
< span class = "n" > value< / span > < span class = "o" > =< / span > < span class = "n" > argtype< / span > < span class = "p" > (< / span > < span class = "n" > value< / span > < span class = "p" > )< / span >
< span class = "k" > return< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > [:< / span > < span class = "n" > idx< / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "n" > args< / span > < span class = "p" > [< / span > < span class = "n" > idx< / span > < span class = "o" > +< / span > < span class = "mi" > 2< / span > < span class = "p" > :],< / span > < span class = "n" > value< / span > < span class = "p" > )< / span > < / div >
2018-05-12 00:18:21 +00:00
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
2018-11-13 17:53:31 +00:00
© Copyright 2018, Red Hat, Inc.
2018-05-12 00:18:21 +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:27:56 +00:00
SphinxRtdTheme.Navigation.enable(true);
2018-05-12 00:18:21 +00:00
});
2019-03-27 23:44:14 +00:00
< / script >
2018-05-12 00:18:21 +00:00
< / body >
< / html >
