327 lines
		
	
	
		
			21 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			327 lines
		
	
	
		
			21 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
 | |
| 
 | |
| <!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">
 | |
|   
 | |
|   <title>composer.cli.projects — Lorax 30.7 documentation</title>
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
|   
 | |
|   
 | |
| 
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
|     
 | |
| 
 | |
|   
 | |
| 
 | |
|   <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
 | |
|   <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" /> 
 | |
| 
 | |
|   
 | |
|   <script src="../../../_static/js/modernizr.min.js"></script>
 | |
| 
 | |
| </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">
 | |
|         <div class="wy-side-nav-search">
 | |
|           
 | |
| 
 | |
|           
 | |
|             <a href="../../../index.html" class="icon icon-home"> Lorax
 | |
|           
 | |
| 
 | |
|           
 | |
|           </a>
 | |
| 
 | |
|           
 | |
|             
 | |
|             
 | |
|               <div class="version">
 | |
|                 30.7
 | |
|               </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>
 | |
| <li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
 | |
| <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.projects</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.projects</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>
 | |
| <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>
 | |
| 
 | |
| <span class="kn">import</span> <span class="nn">textwrap</span>
 | |
| 
 | |
| <span class="kn">from</span> <span class="nn">composer</span> <span class="k">import</span> <span class="n">http_client</span> <span class="k">as</span> <span class="n">client</span>
 | |
| <span class="kn">from</span> <span class="nn">composer.cli.help</span> <span class="k">import</span> <span class="n">projects_help</span>
 | |
| <span class="kn">from</span> <span class="nn">composer.cli.utilities</span> <span class="k">import</span> <span class="n">handle_api_result</span>
 | |
| 
 | |
| <div class="viewcode-block" id="projects_cmd"><a class="viewcode-back" href="../../../composer.cli.html#composer.cli.projects.projects_cmd">[docs]</a><span class="k">def</span> <span class="nf">projects_cmd</span><span class="p">(</span><span class="n">opts</span><span class="p">):</span>
 | |
|     <span class="sd">"""Process projects commands</span>
 | |
| 
 | |
| <span class="sd">    :param opts: Cmdline arguments</span>
 | |
| <span class="sd">    :type opts: argparse.Namespace</span>
 | |
| <span class="sd">    :returns: Value to return from sys.exit()</span>
 | |
| <span class="sd">    :rtype: int</span>
 | |
| <span class="sd">    """</span>
 | |
|     <span class="n">cmd_map</span> <span class="o">=</span> <span class="p">{</span>
 | |
|         <span class="s2">"list"</span><span class="p">:</span>      <span class="n">projects_list</span><span class="p">,</span>
 | |
|         <span class="s2">"info"</span><span class="p">:</span>      <span class="n">projects_info</span><span class="p">,</span>
 | |
|         <span class="p">}</span>
 | |
|     <span class="k">if</span> <span class="n">opts</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"help"</span> <span class="ow">or</span> <span class="n">opts</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"--help"</span><span class="p">:</span>
 | |
|         <span class="nb">print</span><span class="p">(</span><span class="n">projects_help</span><span class="p">)</span>
 | |
|         <span class="k">return</span> <span class="mi">0</span>
 | |
|     <span class="k">elif</span> <span class="n">opts</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">cmd_map</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="s2">"Unknown projects command: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">opts</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
 | |
|         <span class="k">return</span> <span class="mi">1</span>
 | |
| 
 | |
|     <span class="k">return</span> <span class="n">cmd_map</span><span class="p">[</span><span class="n">opts</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]](</span><span class="n">opts</span><span class="o">.</span><span class="n">socket</span><span class="p">,</span> <span class="n">opts</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">opts</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">:],</span> <span class="n">opts</span><span class="o">.</span><span class="n">json</span><span class="p">)</span></div>
 | |
| 
 | |
| <div class="viewcode-block" id="projects_list"><a class="viewcode-back" href="../../../composer.cli.html#composer.cli.projects.projects_list">[docs]</a><span class="k">def</span> <span class="nf">projects_list</span><span class="p">(</span><span class="n">socket_path</span><span class="p">,</span> <span class="n">api_version</span><span class="p">,</span> <span class="n">args</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">"""Output the list of available projects</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 api_version: Version of the API to talk to. eg. "0"</span>
 | |
| <span class="sd">    :type api_version: str</span>
 | |
| <span class="sd">    :param args: List of remaining arguments from the cmdline</span>
 | |
| <span class="sd">    :type args: list of str</span>
 | |
| <span class="sd">    :param show_json: Set to True to show the JSON output instead of the human readable output</span>
 | |
| <span class="sd">    :type show_json: bool</span>
 | |
| 
 | |
| <span class="sd">    projects list</span>
 | |
| <span class="sd">    """</span>
 | |
|     <span class="n">api_route</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">api_url</span><span class="p">(</span><span class="n">api_version</span><span class="p">,</span> <span class="s2">"/projects/list"</span><span class="p">)</span>
 | |
|     <span class="n">result</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_url_json_unlimited</span><span class="p">(</span><span class="n">socket_path</span><span class="p">,</span> <span class="n">api_route</span><span class="p">)</span>
 | |
|     <span class="p">(</span><span class="n">rc</span><span class="p">,</span> <span class="n">exit_now</span><span class="p">)</span> <span class="o">=</span> <span class="n">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="p">)</span>
 | |
|     <span class="k">if</span> <span class="n">exit_now</span><span class="p">:</span>
 | |
|         <span class="k">return</span> <span class="n">rc</span>
 | |
| 
 | |
|     <span class="k">for</span> <span class="n">proj</span> <span class="ow">in</span> <span class="n">result</span><span class="p">[</span><span class="s2">"projects"</span><span class="p">]:</span>
 | |
|         <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="p">[</span><span class="n">field</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"name"</span><span class="p">,</span> <span class="s2">"summary"</span><span class="p">,</span> <span class="s2">"homepage"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span> <span class="k">if</span> <span class="n">proj</span><span class="p">[</span><span class="n">field</span><span class="p">]]:</span>
 | |
|             <span class="nb">print</span><span class="p">(</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">k</span><span class="o">.</span><span class="n">title</span><span class="p">(),</span> <span class="n">textwrap</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">proj</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">subsequent_indent</span><span class="o">=</span><span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span><span class="o">+</span><span class="mi">2</span><span class="p">))))</span>
 | |
|         <span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span><span class="p">)</span>
 | |
| 
 | |
|     <span class="k">return</span> <span class="n">rc</span></div>
 | |
| 
 | |
| <div class="viewcode-block" id="projects_info"><a class="viewcode-back" href="../../../composer.cli.html#composer.cli.projects.projects_info">[docs]</a><span class="k">def</span> <span class="nf">projects_info</span><span class="p">(</span><span class="n">socket_path</span><span class="p">,</span> <span class="n">api_version</span><span class="p">,</span> <span class="n">args</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">"""Output info on a list of projects</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 api_version: Version of the API to talk to. eg. "0"</span>
 | |
| <span class="sd">    :type api_version: str</span>
 | |
| <span class="sd">    :param args: List of remaining arguments from the cmdline</span>
 | |
| <span class="sd">    :type args: list of str</span>
 | |
| <span class="sd">    :param show_json: Set to True to show the JSON output instead of the human readable output</span>
 | |
| <span class="sd">    :type show_json: bool</span>
 | |
| 
 | |
| <span class="sd">    projects info <project,...></span>
 | |
| <span class="sd">    """</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="mi">0</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="s2">"projects info is missing the packages"</span><span class="p">)</span>
 | |
|         <span class="k">return</span> <span class="mi">1</span>
 | |
| 
 | |
|     <span class="n">api_route</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">api_url</span><span class="p">(</span><span class="n">api_version</span><span class="p">,</span> <span class="s2">"/projects/info/</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
 | |
|     <span class="n">result</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_url_json</span><span class="p">(</span><span class="n">socket_path</span><span class="p">,</span> <span class="n">api_route</span><span class="p">)</span>
 | |
|     <span class="p">(</span><span class="n">rc</span><span class="p">,</span> <span class="n">exit_now</span><span class="p">)</span> <span class="o">=</span> <span class="n">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="p">)</span>
 | |
|     <span class="k">if</span> <span class="n">exit_now</span><span class="p">:</span>
 | |
|         <span class="k">return</span> <span class="n">rc</span>
 | |
| 
 | |
|     <span class="k">for</span> <span class="n">proj</span> <span class="ow">in</span> <span class="n">result</span><span class="p">[</span><span class="s2">"projects"</span><span class="p">]:</span>
 | |
|         <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="p">[</span><span class="n">field</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"name"</span><span class="p">,</span> <span class="s2">"summary"</span><span class="p">,</span> <span class="s2">"homepage"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span> <span class="k">if</span> <span class="n">proj</span><span class="p">[</span><span class="n">field</span><span class="p">]]:</span>
 | |
|             <span class="nb">print</span><span class="p">(</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">k</span><span class="o">.</span><span class="n">title</span><span class="p">(),</span> <span class="n">textwrap</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">proj</span><span class="p">[</span><span class="n">k</span><span class="p">],</span> <span class="n">subsequent_indent</span><span class="o">=</span><span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span><span class="o">+</span><span class="mi">2</span><span class="p">))))</span>
 | |
|         <span class="nb">print</span><span class="p">(</span><span class="s2">"Builds: "</span><span class="p">)</span>
 | |
|         <span class="k">for</span> <span class="n">build</span> <span class="ow">in</span> <span class="n">proj</span><span class="p">[</span><span class="s2">"builds"</span><span class="p">]:</span>
 | |
|             <span class="nb">print</span><span class="p">(</span><span class="s2">"    </span><span class="si">%s%s</span><span class="s2">-</span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2"> at </span><span class="si">%s</span><span class="s2"> for </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="s2">""</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">build</span><span class="p">[</span><span class="s2">"epoch"</span><span class="p">]</span> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="n">build</span><span class="p">[</span><span class="s2">"epoch"</span><span class="p">])</span> <span class="o">+</span> <span class="s2">":"</span><span class="p">,</span>
 | |
|                                                        <span class="n">build</span><span class="p">[</span><span class="s2">"source"</span><span class="p">][</span><span class="s2">"version"</span><span class="p">],</span>
 | |
|                                                        <span class="n">build</span><span class="p">[</span><span class="s2">"release"</span><span class="p">],</span>
 | |
|                                                        <span class="n">build</span><span class="p">[</span><span class="s2">"arch"</span><span class="p">],</span>
 | |
|                                                        <span class="n">build</span><span class="p">[</span><span class="s2">"build_time"</span><span class="p">],</span>
 | |
|                                                        <span class="n">build</span><span class="p">[</span><span class="s2">"changelog"</span><span class="p">]))</span>
 | |
|         <span class="nb">print</span><span class="p">(</span><span class="s2">""</span><span class="p">)</span>
 | |
|     <span class="k">return</span> <span class="n">rc</span></div>
 | |
| </pre></div>
 | |
| 
 | |
|            </div>
 | |
|            
 | |
|           </div>
 | |
|           <footer>
 | |
|   
 | |
| 
 | |
|   <hr/>
 | |
| 
 | |
|   <div role="contentinfo">
 | |
|     <p>
 | |
|         © Copyright 2018, Red Hat, Inc.
 | |
| 
 | |
|     </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">
 | |
|           var DOCUMENTATION_OPTIONS = {
 | |
|               URL_ROOT:'../../../',
 | |
|               VERSION:'30.7',
 | |
|               LANGUAGE:'None',
 | |
|               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>
 | |
|     
 | |
| 
 | |
|   
 | |
| 
 | |
|   <script type="text/javascript" src="../../../_static/js/theme.js"></script>
 | |
| 
 | |
|   <script type="text/javascript">
 | |
|       jQuery(function () {
 | |
|           SphinxRtdTheme.Navigation.enable(true);
 | |
|       });
 | |
|   </script> 
 | |
| 
 | |
| </body>
 | |
| </html> |