doc/build/html/_modules/src/product.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9     <title>src.product &#8212; salomeTools 5.0.0dev documentation</title>
  10     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  11     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  12     <script type="text/javascript" src="../../_static/documentation_options.js"></script>
  13     <script type="text/javascript" src="../../_static/jquery.js"></script>
  14     <script type="text/javascript" src="../../_static/underscore.js"></script>
  15     <script type="text/javascript" src="../../_static/doctools.js"></script>
  16     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  17     <link rel="index" title="Index" href="../../genindex.html" />
  18     <link rel="search" title="Search" href="../../search.html" />
  19
  20   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  21
  22
  23   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  24
  25   </head><body>
  26
  27
  28     <div class="document">
  29       <div class="documentwrapper">
  30         <div class="bodywrapper">
  31           <div class="body" role="main">
  32
  33   <h1>Source code for src.product</h1><div class="highlight"><pre>
  34 <span></span><span class="ch">#!/usr/bin/env python</span>
  35 <span class="c1">#-*- coding:utf-8 -*-</span>
  36 <span class="c1">#  Copyright (C) 2010-2012  CEA/DEN</span>
  37 <span class="c1">#</span>
  38 <span class="c1">#  This library is free software; you can redistribute it and/or</span>
  39 <span class="c1">#  modify it under the terms of the GNU Lesser General Public</span>
  40 <span class="c1">#  License as published by the Free Software Foundation; either</span>
  41 <span class="c1">#  version 2.1 of the License.</span>
  42 <span class="c1">#</span>
  43 <span class="c1">#  This library is distributed in the hope that it will be useful,</span>
  44 <span class="c1">#  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  45 <span class="c1">#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
  46 <span class="c1">#  Lesser General Public License for more details.</span>
  47 <span class="c1">#</span>
  48 <span class="c1">#  You should have received a copy of the GNU Lesser General Public</span>
  49 <span class="c1">#  License along with this library; if not, write to the Free Software</span>
  50 <span class="c1">#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA</span>
  51
  52 <span class="sd">&quot;&quot;&quot;\</span>
  53 <span class="sd">In this file are implemented the methods </span>
  54 <span class="sd">relative to the product notion of salomeTools</span>
  55 <span class="sd">&quot;&quot;&quot;</span>
  56
  57 <span class="kn">import</span> <span class="nn">os</span>
  58 <span class="kn">import</span> <span class="nn">re</span>
  59
  60 <span class="kn">import</span> <span class="nn">src</span>
  61 <span class="kn">import</span> <span class="nn">src.debug</span> <span class="k">as</span> <span class="nn">DBG</span>
  62
  63 <span class="n">AVAILABLE_VCS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;git&#39;</span><span class="p">,</span> <span class="s1">&#39;svn&#39;</span><span class="p">,</span> <span class="s1">&#39;cvs&#39;</span><span class="p">]</span>
  64 <span class="n">config_expression</span> <span class="o">=</span> <span class="s2">&quot;^config-\d+$&quot;</span>
  65 <span class="n">VERSION_DELIMITER</span> <span class="o">=</span> <span class="s2">&quot;_to_&quot;</span>
  66
  67 <div class="viewcode-block" id="get_product_config"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_config">[docs]</a><span class="k">def</span> <span class="nf">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">with_install_dir</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
  68     <span class="sd">&quot;&quot;&quot;Get the specific configuration of a product from the global configuration</span>
  69 <span class="sd">    </span>
  70 <span class="sd">    :param config Config: The global configuration</span>
  71 <span class="sd">    :param product_name str: The name of the product</span>
  72 <span class="sd">    :param with_install_dir boolean: If false, do not provide an install </span>
  73 <span class="sd">                                     directory (at false only for internal use </span>
  74 <span class="sd">                                     of the function check_config_exists)</span>
  75 <span class="sd">    :return: the specific configuration of the product</span>
  76 <span class="sd">    :rtype: Config</span>
  77 <span class="sd">    &quot;&quot;&quot;</span>
  78
  79     <span class="c1"># Get the version of the product from the application definition</span>
  80     <span class="n">version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span>
  81     <span class="c1"># if no version, then take the default one defined in the application</span>
  82     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
  83         <span class="n">version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">tag</span>
  84
  85     <span class="c1"># Define debug and dev modes</span>
  86     <span class="c1"># Get the tag if a dictionary is given in APPLICATION.products for the</span>
  87     <span class="c1"># current product </span>
  88     <span class="n">debug</span> <span class="o">=</span> <span class="s1">&#39;no&#39;</span>
  89     <span class="n">dev</span> <span class="o">=</span> <span class="s1">&#39;no&#39;</span>
  90     <span class="n">verbose</span> <span class="o">=</span> <span class="s1">&#39;no&#39;</span>
  91     <span class="n">base</span> <span class="o">=</span> <span class="s1">&#39;maybe&#39;</span>
  92     <span class="n">section</span> <span class="o">=</span> <span class="kc">None</span>
  93     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">):</span>
  94         <span class="n">dic_version</span> <span class="o">=</span> <span class="n">version</span>
  95         <span class="c1"># Get the version/tag</span>
  96         <span class="k">if</span> <span class="ow">not</span> <span class="s1">&#39;tag&#39;</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
  97             <span class="n">version</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">tag</span>
  98         <span class="k">else</span><span class="p">:</span>
  99             <span class="n">version</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">tag</span>
 100
 101         <span class="c1"># Get the debug if any</span>
 102         <span class="k">if</span> <span class="s1">&#39;debug&#39;</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
 103             <span class="n">debug</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">debug</span>
 104
 105         <span class="c1"># Get the verbose if any</span>
 106         <span class="k">if</span> <span class="s1">&#39;verbose&#39;</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
 107             <span class="n">verbose</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">verbose</span>
 108
 109         <span class="c1"># Get the dev if any</span>
 110         <span class="k">if</span> <span class="s1">&#39;dev&#39;</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
 111             <span class="n">dev</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">dev</span>
 112
 113         <span class="c1"># Get the base if any</span>
 114         <span class="k">if</span> <span class="s1">&#39;base&#39;</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
 115             <span class="n">base</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">base</span>
 116
 117         <span class="c1"># Get the section if any</span>
 118         <span class="k">if</span> <span class="s1">&#39;section&#39;</span> <span class="ow">in</span> <span class="n">dic_version</span><span class="p">:</span>
 119             <span class="n">section</span> <span class="o">=</span> <span class="n">dic_version</span><span class="o">.</span><span class="n">section</span>
 120
 121     <span class="n">vv</span> <span class="o">=</span> <span class="n">version</span>
 122     <span class="c1"># substitute some character with _ in order to get the correct definition</span>
 123     <span class="c1"># in config.PRODUCTS. This is done because the pyconf tool does not handle</span>
 124     <span class="c1"># the . and - characters </span>
 125     <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="s2">&quot;.-&quot;</span><span class="p">:</span> <span class="n">vv</span> <span class="o">=</span> <span class="n">vv</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">)</span>
 126
 127     <span class="n">prod_info</span> <span class="o">=</span> <span class="kc">None</span>
 128     <span class="k">if</span> <span class="n">product_name</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">:</span>
 129         <span class="c1"># Search for the product description in the configuration</span>
 130         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">get_product_section</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">vv</span><span class="p">,</span> <span class="n">section</span><span class="p">)</span>
 131
 132         <span class="c1"># merge opt_depend in depend</span>
 133         <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="s1">&#39;opt_depend&#39;</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
 134             <span class="k">for</span> <span class="n">depend</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">opt_depend</span><span class="p">:</span>
 135                 <span class="k">if</span> <span class="n">depend</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">products</span><span class="p">:</span>
 136                     <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">depend</span><span class="p">,</span><span class="s1">&#39;&#39;</span><span class="p">)</span>
 137
 138         <span class="c1"># In case of a product get with a vcs, </span>
 139         <span class="c1"># put the tag (equal to the version)</span>
 140         <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="ow">in</span> <span class="n">AVAILABLE_VCS</span><span class="p">:</span>
 141
 142             <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s1">&#39;git&#39;</span><span class="p">:</span>
 143                 <span class="n">prod_info</span><span class="o">.</span><span class="n">git_info</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">version</span>
 144
 145             <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s1">&#39;svn&#39;</span><span class="p">:</span>
 146                 <span class="n">prod_info</span><span class="o">.</span><span class="n">svn_info</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">version</span>
 147
 148             <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s1">&#39;cvs&#39;</span><span class="p">:</span>
 149                 <span class="n">prod_info</span><span class="o">.</span><span class="n">cvs_info</span><span class="o">.</span><span class="n">tag</span> <span class="o">=</span> <span class="n">version</span>
 150
 151         <span class="c1"># In case of a fixed product, </span>
 152         <span class="c1"># define the install_dir (equal to the version)</span>
 153         <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
 154             <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">version</span>
 155             <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">&quot;fixed&quot;</span>
 156
 157         <span class="c1"># Check if the product is defined as native in the application</span>
 158         <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 159             <span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="s2">&quot;native&quot;</span><span class="p">:</span>
 160                 <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">&quot;native&quot;</span>
 161             <span class="k">elif</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s2">&quot;native&quot;</span><span class="p">:</span>
 162                 <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;The product </span><span class="si">%(prod)s</span><span class="s2"> has version </span><span class="si">%(ver)s</span><span class="s2"> but is &quot;</span>
 163                         <span class="s2">&quot;declared as native in its definition&quot;</span> <span class="o">%</span>
 164                         <span class="p">{</span> <span class="s1">&#39;prod&#39;</span><span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;ver&#39;</span><span class="p">:</span> <span class="n">version</span><span class="p">})</span>
 165                 <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 166
 167     <span class="c1"># If there is no definition but the product is declared as native,</span>
 168     <span class="c1"># construct a new definition containing only the get_source key</span>
 169     <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">version</span> <span class="o">==</span> <span class="s2">&quot;native&quot;</span><span class="p">:</span>
 170         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
 171         <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">product_name</span>
 172         <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">&quot;native&quot;</span>
 173
 174     <span class="c1"># If there is no definition but the product is fixed,</span>
 175     <span class="c1"># construct a new definition containing only the product name</span>
 176     <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">version</span><span class="p">):</span>
 177         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">()</span>
 178         <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">product_name</span>
 179         <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">=</span> <span class="s2">&quot;fixed&quot;</span>
 180         <span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">&quot;environ&quot;</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
 181
 182
 183     <span class="c1"># If prod_info is still None, it means that there is no product definition</span>
 184     <span class="c1"># in the config. The user has to provide it.</span>
 185     <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 186         <span class="n">prod_pyconf_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">product_name</span> <span class="o">+</span> <span class="s2">&quot;.pyconf&quot;</span><span class="p">,</span>
 187                                                   <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">)</span>
 188         <span class="k">if</span> <span class="ow">not</span> <span class="n">prod_pyconf_path</span><span class="p">:</span>
 189             <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
 190 <span class="s2">No definition found for the product </span><span class="si">%(1)s</span><span class="s2">.</span>
 191 <span class="s2">Please create a </span><span class="si">%(2)s</span><span class="s2">.pyconf file somewhere in:</span>
 192 <span class="si">%(3)s</span><span class="s2">&quot;&quot;&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span>
 193   <span class="s2">&quot;1&quot;</span><span class="p">:</span> <span class="n">product_name</span><span class="p">,</span>
 194   <span class="s2">&quot;2&quot;</span><span class="p">:</span> <span class="n">product_name</span><span class="p">,</span>
 195   <span class="s2">&quot;3&quot;</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span> <span class="p">}</span>
 196         <span class="k">else</span><span class="p">:</span>
 197             <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
 198 <span class="s2">No definition corresponding to the version </span><span class="si">%(1)s</span><span class="s2"> was found in the file:</span>
 199 <span class="s2">  </span><span class="si">%(2)s</span><span class="s2">.</span>
 200 <span class="s2">Please add a section in it.&quot;&quot;&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="p">{</span><span class="s2">&quot;1&quot;</span> <span class="p">:</span> <span class="n">vv</span><span class="p">,</span> <span class="s2">&quot;2&quot;</span> <span class="p">:</span> <span class="n">prod_pyconf_path</span><span class="p">}</span>
 201         <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 202
 203     <span class="c1"># Set the debug, dev and version keys</span>
 204     <span class="n">prod_info</span><span class="o">.</span><span class="n">debug</span> <span class="o">=</span> <span class="n">debug</span>
 205     <span class="n">prod_info</span><span class="o">.</span><span class="n">verbose</span> <span class="o">=</span> <span class="n">verbose</span>
 206     <span class="n">prod_info</span><span class="o">.</span><span class="n">dev</span> <span class="o">=</span> <span class="n">dev</span>
 207     <span class="n">prod_info</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="n">version</span>
 208
 209     <span class="c1"># Set the archive_info if the product is get in archive mode</span>
 210     <span class="k">if</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">get_source</span> <span class="o">==</span> <span class="s2">&quot;archive&quot;</span><span class="p">:</span>
 211         <span class="k">if</span> <span class="ow">not</span> <span class="s2">&quot;archive_info&quot;</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
 212             <span class="n">prod_info</span><span class="o">.</span><span class="n">addMapping</span><span class="p">(</span><span class="s2">&quot;archive_info&quot;</span><span class="p">,</span>
 213                                  <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Mapping</span><span class="p">(</span><span class="n">prod_info</span><span class="p">),</span>
 214                                  <span class="s2">&quot;&quot;</span><span class="p">)</span>
 215         <span class="k">if</span> <span class="s2">&quot;archive_name&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="p">:</span>
 216             <span class="n">arch_name</span> <span class="o">=</span> <span class="n">product_name</span> <span class="o">+</span> <span class="s2">&quot;-&quot;</span> <span class="o">+</span> <span class="n">version</span> <span class="o">+</span> <span class="s2">&quot;.tar.gz&quot;</span>
 217             <span class="n">arch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">arch_name</span><span class="p">,</span>
 218                                                <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
 219             <span class="k">if</span> <span class="ow">not</span> <span class="n">arch_path</span><span class="p">:</span>
 220                 <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;Archive </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found in config.PATHS.ARCHIVEPATH&quot;</span><span class="p">)</span> <span class="o">%</span> \
 221                        <span class="p">{</span><span class="s2">&quot;1&quot;</span> <span class="p">:</span> <span class="n">arch_name</span><span class="p">,</span> <span class="s2">&quot;2&quot;</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
 222                 <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
 223                 <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_name</span> <span class="c1">#without path</span>
 224                 <span class="c1"># raise src.SatException(msg) #may be a warning, continue #8646</span>
 225             <span class="k">else</span><span class="p">:</span>
 226                 <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_path</span>
 227         <span class="k">else</span><span class="p">:</span>
 228             <span class="k">if</span> <span class="p">(</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">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">)</span> <span class="o">==</span>
 229                                         <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span><span class="p">):</span>
 230                 <span class="n">arch_name</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span>
 231                 <span class="n">arch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
 232                                             <span class="n">arch_name</span><span class="p">,</span>
 233                                             <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span>
 234                 <span class="k">if</span> <span class="ow">not</span> <span class="n">arch_path</span><span class="p">:</span>
 235                     <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;Archive </span><span class="si">%(1)s</span><span class="s2"> for </span><span class="si">%(2)s</span><span class="s2"> not found in config.PATHS.ARCHIVEPATH&quot;</span><span class="p">)</span> <span class="o">%</span> \
 236                            <span class="p">{</span><span class="s2">&quot;1&quot;</span> <span class="p">:</span> <span class="n">arch_name</span><span class="p">,</span> <span class="s2">&quot;2&quot;</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">}</span>
 237                     <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">ARCHIVEPATH</span><span class="p">)</span> <span class="c1">#avoid 2 messages in compile</span>
 238                     <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_name</span> <span class="c1">#without path</span>
 239                     <span class="c1"># raise src.SatException(msg) #may be a warning, continue #8646</span>
 240                 <span class="k">else</span><span class="p">:</span>
 241                     <span class="n">prod_info</span><span class="o">.</span><span class="n">archive_info</span><span class="o">.</span><span class="n">archive_name</span> <span class="o">=</span> <span class="n">arch_path</span>
 242
 243
 244     <span class="c1"># If the product compiles with a script, check the script existence</span>
 245     <span class="c1"># and if it is executable</span>
 246     <span class="k">if</span> <span class="n">product_has_script</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
 247         <span class="c1"># Check the compil_script key existence</span>
 248         <span class="k">if</span> <span class="s2">&quot;compil_script&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
 249             <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
 250 <span class="s2">No compilation script found for the product </span><span class="si">%s</span><span class="s2">.</span>
 251 <span class="s2">Please provide a &#39;compil_script&#39; key in its definition.&quot;&quot;&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="n">product_name</span>
 252             <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 253
 254         <span class="c1"># Get the path of the script</span>
 255         <span class="n">script</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span>
 256         <span class="n">script_name</span> <span class="o">=</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">script</span><span class="p">)</span>
 257         <span class="k">if</span> <span class="n">script</span> <span class="o">==</span> <span class="n">script_name</span><span class="p">:</span>
 258             <span class="c1"># Only a name is given. Search in the default directory</span>
 259             <span class="n">script_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">script_name</span><span class="p">,</span>
 260                                                  <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
 261                                                  <span class="s2">&quot;compil_scripts&quot;</span><span class="p">)</span>
 262             <span class="k">if</span> <span class="ow">not</span> <span class="n">script_path</span><span class="p">:</span>
 263                 <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span>
 264                     <span class="n">_</span><span class="p">(</span><span class="s2">&quot;Compilation script not found: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="n">script_name</span><span class="p">)</span>
 265             <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span> <span class="o">=</span> <span class="n">script_path</span>
 266             <span class="k">if</span> <span class="n">src</span><span class="o">.</span><span class="n">architecture</span><span class="o">.</span><span class="n">is_windows</span><span class="p">():</span>
 267                 <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="s2">&quot;.sh&quot;</span><span class="p">)]</span> <span class="o">+</span> <span class="s2">&quot;.bat&quot;</span>
 268
 269         <span class="c1"># Check that the script is executable</span>
 270         <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">X_OK</span><span class="p">):</span>
 271             <span class="c1">#raise src.SatException(</span>
 272             <span class="c1">#        _(&quot;Compilation script cannot be executed: %s&quot;) % </span>
 273             <span class="c1">#        prod_info.compil_script)</span>
 274             <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">&quot;Compilation script cannot be executed:&quot;</span><span class="p">,</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">compil_script</span><span class="p">)</span>
 275
 276     <span class="c1"># Get the full paths of all the patches</span>
 277     <span class="k">if</span> <span class="n">product_has_patches</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
 278         <span class="n">patches</span> <span class="o">=</span> <span class="p">[]</span>
 279         <span class="k">try</span><span class="p">:</span>
 280           <span class="k">for</span> <span class="n">patch</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span><span class="p">:</span>
 281               <span class="n">patch_path</span> <span class="o">=</span> <span class="n">patch</span>
 282               <span class="c1"># If only a filename, then search for the patch in the PRODUCTPATH</span>
 283               <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">basename</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">patch_path</span><span class="p">:</span>
 284                   <span class="c1"># Search in the PRODUCTPATH/patches</span>
 285                   <span class="n">patch_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span>
 286                                                       <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
 287                                                       <span class="s2">&quot;patches&quot;</span><span class="p">)</span>
 288                   <span class="k">if</span> <span class="ow">not</span> <span class="n">patch_path</span><span class="p">:</span>
 289                       <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;Patch </span><span class="si">%(patch_name)s</span><span class="s2"> for </span><span class="si">%(prod_name)s</span><span class="s2"> not found:&quot;</span>
 290                               <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">{</span><span class="s2">&quot;patch_name&quot;</span> <span class="p">:</span> <span class="n">patch</span><span class="p">,</span>
 291                                        <span class="s2">&quot;prod_name&quot;</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
 292                       <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 293               <span class="n">patches</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">patch_path</span><span class="p">)</span>
 294         <span class="k">except</span><span class="p">:</span>
 295           <span class="n">DBG</span><span class="o">.</span><span class="n">tofix</span><span class="p">(</span><span class="s2">&quot;problem in prod_info.patches&quot;</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
 296         <span class="n">prod_info</span><span class="o">.</span><span class="n">patches</span> <span class="o">=</span> <span class="n">patches</span>
 297
 298     <span class="c1"># Get the full paths of the environment scripts</span>
 299     <span class="k">if</span> <span class="n">product_has_env_script</span><span class="p">(</span><span class="n">prod_info</span><span class="p">):</span>
 300         <span class="n">env_script_path</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span>
 301         <span class="c1"># If only a filename, then search for the environment script </span>
 302         <span class="c1"># in the PRODUCTPATH/env_scripts</span>
 303         <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">basename</span><span class="p">(</span><span class="n">env_script_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">env_script_path</span><span class="p">:</span>
 304             <span class="c1"># Search in the PRODUCTPATH/env_scripts</span>
 305             <span class="n">env_script_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">find_file_in_lpath</span><span class="p">(</span>
 306                                             <span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span><span class="p">,</span>
 307                                             <span class="n">config</span><span class="o">.</span><span class="n">PATHS</span><span class="o">.</span><span class="n">PRODUCTPATH</span><span class="p">,</span>
 308                                             <span class="s2">&quot;env_scripts&quot;</span><span class="p">)</span>
 309             <span class="k">if</span> <span class="ow">not</span> <span class="n">env_script_path</span><span class="p">:</span>
 310                 <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;Environment script </span><span class="si">%(env_name)s</span><span class="s2"> for </span><span class="si">%(prod_name)s</span><span class="s2"> not &quot;</span>
 311                         <span class="s2">&quot;found.</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">{</span><span class="s2">&quot;env_name&quot;</span> <span class="p">:</span> <span class="n">env_script_path</span><span class="p">,</span>
 312                                        <span class="s2">&quot;prod_name&quot;</span> <span class="p">:</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">})</span>
 313                 <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 314
 315         <span class="n">prod_info</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">env_script</span> <span class="o">=</span> <span class="n">env_script_path</span>
 316
 317     <span class="k">if</span> <span class="n">with_install_dir</span><span class="p">:</span>
 318         <span class="c1"># The variable with_install_dir is at false only for internal use </span>
 319         <span class="c1"># of the function get_install_dir</span>
 320
 321         <span class="c1"># Save the install_dir key if there is any</span>
 322         <span class="k">if</span> <span class="s2">&quot;install_dir&quot;</span> <span class="ow">in</span> <span class="n">prod_info</span> <span class="ow">and</span> <span class="ow">not</span> <span class="s2">&quot;install_dir_save&quot;</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
 323             <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir_save</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span>
 324
 325         <span class="c1"># if it is not the first time the install_dir is computed, it means</span>
 326         <span class="c1"># that install_dir_save exists and it has to be taken into account.</span>
 327         <span class="k">if</span> <span class="s2">&quot;install_dir_save&quot;</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="p">:</span>
 328             <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir_save</span>
 329
 330         <span class="c1"># Set the install_dir key</span>
 331         <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">=</span> <span class="n">get_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
 332
 333     <span class="k">return</span> <span class="n">prod_info</span></div>
 334
 335 <div class="viewcode-block" id="get_product_section"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_section">[docs]</a><span class="k">def</span> <span class="nf">get_product_section</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_name</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">section</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 336     <span class="sd">&quot;&quot;&quot;Get the product description from the configuration</span>
 337 <span class="sd">    </span>
 338 <span class="sd">    :param config Config: The global configuration</span>
 339 <span class="sd">    :param product_name str: The product name</span>
 340 <span class="sd">    :param version str: The version of the product</span>
 341 <span class="sd">    :param section str: The searched section (if not None, the section is </span>
 342 <span class="sd">                        explicitly given</span>
 343 <span class="sd">    :return: The product description</span>
 344 <span class="sd">    :rtype: Config</span>
 345 <span class="sd">    &quot;&quot;&quot;</span>
 346
 347     <span class="c1"># if section is not None, try to get the corresponding section</span>
 348     <span class="k">if</span> <span class="n">section</span><span class="p">:</span>
 349         <span class="k">if</span> <span class="n">section</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]:</span>
 350             <span class="k">return</span> <span class="kc">None</span>
 351         <span class="c1"># returns specific information for the given version</span>
 352         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">][</span><span class="n">section</span><span class="p">]</span>
 353         <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="n">section</span>
 354         <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
 355         <span class="k">return</span> <span class="n">prod_info</span>
 356
 357     <span class="c1"># If it exists, get the information of the product_version</span>
 358     <span class="k">if</span> <span class="s2">&quot;version_&quot;</span> <span class="o">+</span> <span class="n">version</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]:</span>
 359         <span class="c1"># returns specific information for the given version</span>
 360         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">][</span><span class="s2">&quot;version_&quot;</span> <span class="o">+</span> <span class="n">version</span><span class="p">]</span>
 361         <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="s2">&quot;version_&quot;</span> <span class="o">+</span> <span class="n">version</span>
 362         <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
 363         <span class="k">return</span> <span class="n">prod_info</span>
 364
 365     <span class="c1"># Else, check if there is a description for multiple versions</span>
 366     <span class="n">l_section_name</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
 367     <span class="n">l_section_ranges</span> <span class="o">=</span> <span class="p">[</span><span class="n">section_name</span> <span class="k">for</span> <span class="n">section_name</span> <span class="ow">in</span> <span class="n">l_section_name</span>
 368                         <span class="k">if</span> <span class="n">VERSION_DELIMITER</span> <span class="ow">in</span> <span class="n">section_name</span><span class="p">]</span>
 369     <span class="k">for</span> <span class="n">section_range</span> <span class="ow">in</span> <span class="n">l_section_ranges</span><span class="p">:</span>
 370         <span class="n">minimum</span><span class="p">,</span> <span class="n">maximum</span> <span class="o">=</span> <span class="n">section_range</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">VERSION_DELIMITER</span><span class="p">)</span>
 371         <span class="k">if</span> <span class="p">(</span><span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">version</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">minimum</span><span class="p">)</span>
 372                     <span class="ow">and</span> <span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">version</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="n">src</span><span class="o">.</span><span class="n">only_numbers</span><span class="p">(</span><span class="n">maximum</span><span class="p">)):</span>
 373             <span class="c1"># returns specific information for the versions</span>
 374             <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">][</span><span class="n">section_range</span><span class="p">]</span>
 375             <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="n">section_range</span>
 376             <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
 377             <span class="k">return</span> <span class="n">prod_info</span>
 378
 379     <span class="c1"># Else, get the standard informations</span>
 380     <span class="k">if</span> <span class="s2">&quot;default&quot;</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]:</span>
 381         <span class="c1"># returns the generic information (given version not found)</span>
 382         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">default</span>
 383         <span class="n">prod_info</span><span class="o">.</span><span class="n">section</span> <span class="o">=</span> <span class="s2">&quot;default&quot;</span>
 384         <span class="n">prod_info</span><span class="o">.</span><span class="n">from_file</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">PRODUCTS</span><span class="p">[</span><span class="n">product_name</span><span class="p">]</span><span class="o">.</span><span class="n">from_file</span>
 385         <span class="k">return</span> <span class="n">prod_info</span>
 386
 387     <span class="c1"># if noting was found, return None</span>
 388     <span class="k">return</span> <span class="kc">None</span></div>
 389
 390 <div class="viewcode-block" id="get_install_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_install_dir">[docs]</a><span class="k">def</span> <span class="nf">get_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">):</span>
 391     <span class="sd">&quot;&quot;&quot;Compute the installation directory of a given product </span>
 392 <span class="sd">    </span>
 393 <span class="sd">    :param config Config: The global configuration</span>
 394 <span class="sd">    :param base str: This corresponds to the value given by user in its </span>
 395 <span class="sd">                     application.pyconf for the specific product. If &quot;yes&quot;, the</span>
 396 <span class="sd">                     user wants the product to be in base. If &quot;no&quot;, he wants the</span>
 397 <span class="sd">                     product to be in the application workdir</span>
 398 <span class="sd">    :param version str: The version of the product</span>
 399 <span class="sd">    :param product_info Config: The configuration specific to </span>
 400 <span class="sd">                               the product</span>
 401 <span class="sd">    </span>
 402 <span class="sd">    :return: The path of the product installation</span>
 403 <span class="sd">    :rtype: str</span>
 404 <span class="sd">    &quot;&quot;&quot;</span>
 405     <span class="n">install_dir</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
 406     <span class="n">in_base</span> <span class="o">=</span> <span class="kc">False</span>
 407     <span class="k">if</span> <span class="p">((</span><span class="s2">&quot;install_dir&quot;</span> <span class="ow">in</span> <span class="n">prod_info</span> <span class="ow">and</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">==</span> <span class="s2">&quot;base&quot;</span><span class="p">)</span>
 408                                                             <span class="ow">or</span> <span class="n">base</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">):</span>
 409         <span class="n">in_base</span> <span class="o">=</span> <span class="kc">True</span>
 410     <span class="k">if</span> <span class="p">(</span><span class="n">base</span> <span class="o">==</span> <span class="s2">&quot;no&quot;</span> <span class="ow">or</span> <span class="p">(</span><span class="s2">&quot;no_base&quot;</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span>
 411                          <span class="ow">and</span> <span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">no_base</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">)):</span>
 412         <span class="n">in_base</span> <span class="o">=</span> <span class="kc">False</span>
 413
 414     <span class="k">if</span> <span class="n">in_base</span><span class="p">:</span>
 415         <span class="n">install_dir</span> <span class="o">=</span> <span class="n">get_base_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">,</span> <span class="n">version</span><span class="p">)</span>
 416     <span class="k">else</span><span class="p">:</span>
 417         <span class="k">if</span> <span class="s2">&quot;install_dir&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span> <span class="ow">or</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span> <span class="o">==</span> <span class="s2">&quot;base&quot;</span><span class="p">:</span>
 418             <span class="c1"># Set it to the default value (in application directory)</span>
 419             <span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">APPLICATION</span><span class="o">.</span><span class="n">workdir</span><span class="p">,</span>
 420                                                 <span class="s2">&quot;INSTALL&quot;</span><span class="p">,</span>
 421                                                 <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
 422         <span class="k">else</span><span class="p">:</span>
 423             <span class="n">install_dir</span> <span class="o">=</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">install_dir</span>
 424
 425     <span class="k">return</span> <span class="n">install_dir</span></div>
 426
 427 <div class="viewcode-block" id="get_base_install_dir"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_base_install_dir">[docs]</a><span class="k">def</span> <span class="nf">get_base_install_dir</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
 428     <span class="sd">&quot;&quot;&quot;Compute the installation directory of a product in base </span>
 429 <span class="sd">    </span>
 430 <span class="sd">    :param config Config: The global configuration</span>
 431 <span class="sd">    :param product_info Config: The configuration specific to </span>
 432 <span class="sd">                               the product</span>
 433 <span class="sd">    :param version str: The version of the product    </span>
 434 <span class="sd">    :return: The path of the product installation</span>
 435 <span class="sd">    :rtype: str</span>
 436 <span class="sd">    &quot;&quot;&quot;</span>
 437     <span class="n">base_path</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">get_base_path</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
 438     <span class="n">prod_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">base_path</span><span class="p">,</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s2">&quot;-&quot;</span> <span class="o">+</span> <span class="n">version</span><span class="p">)</span>
 439     <span class="k">if</span> <span class="ow">not</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">prod_dir</span><span class="p">):</span>
 440         <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">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="s2">&quot;config-1&quot;</span><span class="p">)</span>
 441
 442     <span class="n">exists</span><span class="p">,</span> <span class="n">install_dir</span> <span class="o">=</span> <span class="n">check_config_exists</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dir</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
 443     <span class="k">if</span> <span class="n">exists</span><span class="p">:</span>
 444         <span class="k">return</span> <span class="n">install_dir</span>
 445
 446     <span class="c1"># Find the first config-&lt;i&gt; directory that is available in the product</span>
 447     <span class="c1"># directory</span>
 448     <span class="n">found</span> <span class="o">=</span> <span class="kc">False</span>
 449     <span class="n">label</span> <span class="o">=</span> <span class="mi">1</span>
 450     <span class="k">while</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
 451         <span class="n">install_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="s2">&quot;config-</span><span class="si">%i</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">label</span><span class="p">)</span>
 452         <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">install_dir</span><span class="p">):</span>
 453             <span class="n">label</span><span class="o">+=</span><span class="mi">1</span>
 454         <span class="k">else</span><span class="p">:</span>
 455             <span class="n">found</span> <span class="o">=</span> <span class="kc">True</span>
 456
 457     <span class="k">return</span> <span class="n">install_dir</span></div>
 458
 459 <div class="viewcode-block" id="check_config_exists"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_config_exists">[docs]</a><span class="k">def</span> <span class="nf">check_config_exists</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dir</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">):</span>
 460     <span class="sd">&quot;&quot;&quot;\</span>
 461 <span class="sd">    Verify that the installation directory of a product in a base exists</span>
 462 <span class="sd">    Check all the config-&lt;i&gt; directory and verify the sat-config.pyconf file</span>
 463 <span class="sd">    that is in it </span>
 464 <span class="sd">    </span>
 465 <span class="sd">    :param config Config: The global configuration</span>
 466 <span class="sd">    :param prod_dir str: The product installation directory path </span>
 467 <span class="sd">                         (without config-&lt;i&gt;)</span>
 468 <span class="sd">    :param product_info Config: The configuration specific to </span>
 469 <span class="sd">                               the product</span>
 470 <span class="sd">    :return: True or false is the installation is found or not </span>
 471 <span class="sd">             and if it is found, the path of the found installation</span>
 472 <span class="sd">    :rtype: (boolean, str)</span>
 473 <span class="sd">    &quot;&quot;&quot;</span>
 474     <span class="c1"># check if the directories or files of the directory corresponds to the </span>
 475     <span class="c1"># directory installation of the product</span>
 476     <span class="n">l_dir_and_files</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">)</span>
 477     <span class="k">for</span> <span class="n">dir_or_file</span> <span class="ow">in</span> <span class="n">l_dir_and_files</span><span class="p">:</span>
 478         <span class="n">oExpr</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">config_expression</span><span class="p">)</span>
 479         <span class="k">if</span> <span class="ow">not</span><span class="p">(</span><span class="n">oExpr</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">dir_or_file</span><span class="p">)):</span>
 480             <span class="c1"># not config-&lt;i&gt;, not interesting</span>
 481             <span class="k">continue</span>
 482         <span class="c1"># check if there is the file sat-config.pyconf file in the installation</span>
 483         <span class="c1"># directory    </span>
 484         <span class="n">config_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">,</span> <span class="n">src</span><span class="o">.</span><span class="n">CONFIG_FILENAME</span><span class="p">)</span>
 485         <span class="k">if</span> <span class="ow">not</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">config_file</span><span class="p">):</span>
 486             <span class="k">continue</span>
 487
 488         <span class="c1"># If there is no dependency, it is the right path</span>
 489         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">)</span><span class="o">==</span><span class="mi">0</span><span class="p">:</span>
 490             <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
 491             <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">compile_cfg</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
 492                 <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">)</span>
 493             <span class="k">continue</span>
 494
 495         <span class="c1"># check if there is the config described in the file corresponds the </span>
 496         <span class="c1"># dependencies of the product</span>
 497         <span class="n">config_corresponds</span> <span class="o">=</span> <span class="kc">True</span>
 498         <span class="n">compile_cfg</span> <span class="o">=</span> <span class="n">src</span><span class="o">.</span><span class="n">pyconf</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span>
 499         <span class="k">for</span> <span class="n">prod_dep</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
 500             <span class="c1"># if the dependency is not in the config, </span>
 501             <span class="c1"># the config does not correspond</span>
 502             <span class="k">if</span> <span class="n">prod_dep</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">compile_cfg</span><span class="p">:</span>
 503                 <span class="n">config_corresponds</span> <span class="o">=</span> <span class="kc">False</span>
 504                 <span class="k">break</span>
 505             <span class="k">else</span><span class="p">:</span>
 506                 <span class="n">prod_dep_info</span> <span class="o">=</span> <span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_dep</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
 507                 <span class="c1"># If the version of the dependency does not correspond, </span>
 508                 <span class="c1"># the config does not correspond</span>
 509                 <span class="k">if</span> <span class="n">prod_dep_info</span><span class="o">.</span><span class="n">version</span> <span class="o">!=</span> <span class="n">compile_cfg</span><span class="p">[</span><span class="n">prod_dep</span><span class="p">]:</span>
 510                     <span class="n">config_corresponds</span> <span class="o">=</span> <span class="kc">False</span>
 511                     <span class="k">break</span>
 512
 513         <span class="k">for</span> <span class="n">prod_name</span> <span class="ow">in</span> <span class="n">compile_cfg</span><span class="p">:</span>
 514             <span class="k">if</span> <span class="n">prod_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">prod_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
 515                 <span class="n">config_corresponds</span> <span class="o">=</span> <span class="kc">False</span>
 516                 <span class="k">break</span>
 517
 518         <span class="k">if</span> <span class="n">config_corresponds</span><span class="p">:</span>
 519             <span class="k">return</span> <span class="kc">True</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">prod_dir</span><span class="p">,</span> <span class="n">dir_or_file</span><span class="p">)</span>
 520
 521     <span class="k">return</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">None</span></div>
 522
 523
 524
 525 <div class="viewcode-block" id="get_products_infos"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_products_infos">[docs]</a><span class="k">def</span> <span class="nf">get_products_infos</span><span class="p">(</span><span class="n">lproducts</span><span class="p">,</span> <span class="n">config</span><span class="p">):</span>
 526     <span class="sd">&quot;&quot;&quot;Get the specific configuration of a list of products</span>
 527 <span class="sd">    </span>
 528 <span class="sd">    :param lproducts List: The list of product names</span>
 529 <span class="sd">    :param config Config: The global configuration</span>
 530 <span class="sd">    :return: the list of tuples </span>
 531 <span class="sd">             (product name, specific configuration of the product)</span>
 532 <span class="sd">    :rtype: [(str, Config)]</span>
 533 <span class="sd">    &quot;&quot;&quot;</span>
 534     <span class="n">products_infos</span> <span class="o">=</span> <span class="p">[]</span>
 535     <span class="c1"># Loop on product names</span>
 536     <span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">lproducts</span><span class="p">:</span>
 537         <span class="c1"># Get the specific configuration of the product</span>
 538         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod</span><span class="p">)</span>
 539         <span class="k">if</span> <span class="n">prod_info</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
 540             <span class="n">products_infos</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">prod</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">))</span>
 541         <span class="k">else</span><span class="p">:</span>
 542             <span class="n">msg</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;The </span><span class="si">%s</span><span class="s2"> product has no definition &quot;</span>
 543                     <span class="s2">&quot;in the configuration.&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="n">prod</span>
 544             <span class="k">raise</span> <span class="n">src</span><span class="o">.</span><span class="n">SatException</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 545     <span class="k">return</span> <span class="n">products_infos</span></div>
 546
 547 <div class="viewcode-block" id="get_product_dependencies"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_dependencies">[docs]</a><span class="k">def</span> <span class="nf">get_product_dependencies</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">product_info</span><span class="p">):</span>
 548     <span class="sd">&quot;&quot;&quot;\</span>
 549 <span class="sd">    Get recursively the list of products that are </span>
 550 <span class="sd">    in the product_info dependencies</span>
 551 <span class="sd">    </span>
 552 <span class="sd">    :param config Config: The global configuration</span>
 553 <span class="sd">    :param product_info Config: The configuration specific to </span>
 554 <span class="sd">                               the product</span>
 555 <span class="sd">    :return: the list of products in dependence</span>
 556 <span class="sd">    :rtype: list</span>
 557 <span class="sd">    &quot;&quot;&quot;</span>
 558     <span class="k">if</span> <span class="s2">&quot;depend&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">or</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span> <span class="o">==</span> <span class="p">[]:</span>
 559         <span class="k">return</span> <span class="p">[]</span>
 560     <span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
 561     <span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span><span class="p">:</span>
 562         <span class="k">if</span> <span class="n">prod</span> <span class="o">==</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
 563             <span class="k">continue</span>
 564         <span class="k">if</span> <span class="n">prod</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
 565             <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">prod</span><span class="p">)</span>
 566         <span class="n">prod_info</span> <span class="o">=</span> <span class="n">get_product_config</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod</span><span class="p">)</span>
 567         <span class="n">dep_prod</span> <span class="o">=</span> <span class="n">get_product_dependencies</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">prod_info</span><span class="p">)</span>
 568         <span class="k">for</span> <span class="n">prod_in_dep</span> <span class="ow">in</span> <span class="n">dep_prod</span><span class="p">:</span>
 569             <span class="k">if</span> <span class="n">prod_in_dep</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
 570                 <span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">prod_in_dep</span><span class="p">)</span>
 571     <span class="k">return</span> <span class="n">res</span></div>
 572
 573 <div class="viewcode-block" id="check_installation"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_installation">[docs]</a><span class="k">def</span> <span class="nf">check_installation</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 574     <span class="sd">&quot;&quot;&quot;\</span>
 575 <span class="sd">    Verify if a product is well installed. Checks install directory presence</span>
 576 <span class="sd">    and some additional files if it is defined in the config </span>
 577 <span class="sd">    </span>
 578 <span class="sd">    :param product_info Config: The configuration specific to </span>
 579 <span class="sd">                               the product</span>
 580 <span class="sd">    :return: True if it is well installed</span>
 581 <span class="sd">    :rtype: boolean</span>
 582 <span class="sd">    &quot;&quot;&quot;</span>
 583     <span class="k">if</span> <span class="ow">not</span> <span class="n">product_compiles</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 584         <span class="k">return</span> <span class="kc">True</span>
 585     <span class="n">install_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">install_dir</span>
 586     <span class="k">if</span> <span class="ow">not</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">install_dir</span><span class="p">):</span>
 587         <span class="k">return</span> <span class="kc">False</span>
 588     <span class="k">if</span> <span class="p">(</span><span class="s2">&quot;present_files&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 589         <span class="s2">&quot;install&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="p">):</span>
 590         <span class="k">for</span> <span class="n">file_relative_path</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="o">.</span><span class="n">install</span><span class="p">:</span>
 591             <span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">install_dir</span><span class="p">,</span> <span class="n">file_relative_path</span><span class="p">)</span>
 592             <span class="k">if</span> <span class="ow">not</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">file_path</span><span class="p">):</span>
 593                 <span class="k">return</span> <span class="kc">False</span>
 594     <span class="k">return</span> <span class="kc">True</span></div>
 595
 596 <div class="viewcode-block" id="check_source"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.check_source">[docs]</a><span class="k">def</span> <span class="nf">check_source</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 597     <span class="sd">&quot;&quot;&quot;Verify if a sources of product is preset. Checks source directory presence</span>
 598 <span class="sd">    </span>
 599 <span class="sd">    :param product_info Config: The configuration specific to </span>
 600 <span class="sd">                               the product</span>
 601 <span class="sd">    :return: True if it is well installed</span>
 602 <span class="sd">    :rtype: boolean</span>
 603 <span class="sd">    &quot;&quot;&quot;</span>
 604     <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;check_source product_info&quot;</span><span class="p">,</span> <span class="n">product_info</span><span class="p">)</span>
 605     <span class="n">source_dir</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">source_dir</span>
 606     <span class="k">if</span> <span class="ow">not</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">source_dir</span><span class="p">):</span>
 607         <span class="k">return</span> <span class="kc">False</span>
 608     <span class="k">if</span> <span class="p">(</span><span class="s2">&quot;present_files&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 609         <span class="s2">&quot;source&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="p">):</span>
 610         <span class="k">for</span> <span class="n">file_relative_path</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">present_files</span><span class="o">.</span><span class="n">source</span><span class="p">:</span>
 611             <span class="n">file_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">source_dir</span><span class="p">,</span> <span class="n">file_relative_path</span><span class="p">)</span>
 612             <span class="k">if</span> <span class="ow">not</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">file_path</span><span class="p">):</span>
 613                 <span class="k">return</span> <span class="kc">False</span>
 614     <span class="k">return</span> <span class="kc">True</span></div>
 615
 616 <div class="viewcode-block" id="product_is_salome"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_salome">[docs]</a><span class="k">def</span> <span class="nf">product_is_salome</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 617     <span class="sd">&quot;&quot;&quot;Know if a product is a SALOME module</span>
 618 <span class="sd">    </span>
 619 <span class="sd">    :param product_info Config: The configuration specific to </span>
 620 <span class="sd">                               the product</span>
 621 <span class="sd">    :return: True if the product is a SALOME module, else False</span>
 622 <span class="sd">    :rtype: boolean</span>
 623 <span class="sd">    &quot;&quot;&quot;</span>
 624     <span class="k">return</span> <span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 625             <span class="s2">&quot;is_SALOME_module&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
 626             <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">is_SALOME_module</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">)</span></div>
 627
 628 <div class="viewcode-block" id="product_is_fixed"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_fixed">[docs]</a><span class="k">def</span> <span class="nf">product_is_fixed</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 629     <span class="sd">&quot;&quot;&quot;Know if a product is fixed</span>
 630 <span class="sd">    </span>
 631 <span class="sd">    :param product_info Config: The configuration specific to </span>
 632 <span class="sd">                               the product</span>
 633 <span class="sd">    :return: True if the product is fixed, else False</span>
 634 <span class="sd">    :rtype: boolean</span>
 635 <span class="sd">    &quot;&quot;&quot;</span>
 636     <span class="n">get_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span>
 637     <span class="k">return</span> <span class="n">get_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;fixed&#39;</span></div>
 638
 639 <div class="viewcode-block" id="product_is_native"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_native">[docs]</a><span class="k">def</span> <span class="nf">product_is_native</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 640     <span class="sd">&quot;&quot;&quot;Know if a product is native</span>
 641 <span class="sd">    </span>
 642 <span class="sd">    :param product_info Config: The configuration specific to </span>
 643 <span class="sd">                               the product</span>
 644 <span class="sd">    :return: True if the product is native, else False</span>
 645 <span class="sd">    :rtype: boolean</span>
 646 <span class="sd">    &quot;&quot;&quot;</span>
 647     <span class="n">get_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span>
 648     <span class="k">return</span> <span class="n">get_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;native&#39;</span></div>
 649
 650 <div class="viewcode-block" id="product_is_dev"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_dev">[docs]</a><span class="k">def</span> <span class="nf">product_is_dev</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 651     <span class="sd">&quot;&quot;&quot;Know if a product is in dev mode</span>
 652 <span class="sd">    </span>
 653 <span class="sd">    :param product_info Config: The configuration specific to </span>
 654 <span class="sd">                               the product</span>
 655 <span class="sd">    :return: True if the product is in dev mode, else False</span>
 656 <span class="sd">    :rtype: boolean</span>
 657 <span class="sd">    &quot;&quot;&quot;</span>
 658     <span class="n">dev</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">dev</span>
 659     <span class="n">res</span> <span class="o">=</span> <span class="p">(</span><span class="n">dev</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;yes&#39;</span><span class="p">)</span>
 660     <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;product_is_dev </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
 661     <span class="c1"># if product_info.name == &quot;XDATA&quot;: return True #test #10569</span>
 662     <span class="k">return</span> <span class="n">res</span></div>
 663
 664 <div class="viewcode-block" id="product_is_debug"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_debug">[docs]</a><span class="k">def</span> <span class="nf">product_is_debug</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 665     <span class="sd">&quot;&quot;&quot;Know if a product is in debug mode</span>
 666 <span class="sd">    </span>
 667 <span class="sd">    :param product_info Config: The configuration specific to </span>
 668 <span class="sd">                               the product</span>
 669 <span class="sd">    :return: True if the product is in debug mode, else False</span>
 670 <span class="sd">    :rtype: boolean</span>
 671 <span class="sd">    &quot;&quot;&quot;</span>
 672     <span class="n">debug</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">debug</span>
 673     <span class="k">return</span> <span class="n">debug</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;yes&#39;</span></div>
 674
 675 <div class="viewcode-block" id="product_is_verbose"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_verbose">[docs]</a><span class="k">def</span> <span class="nf">product_is_verbose</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 676     <span class="sd">&quot;&quot;&quot;Know if a product is in verbose mode</span>
 677 <span class="sd">    </span>
 678 <span class="sd">    :param product_info Config: The configuration specific to </span>
 679 <span class="sd">                               the product</span>
 680 <span class="sd">    :return: True if the product is in verbose mode, else False</span>
 681 <span class="sd">    :rtype: boolean</span>
 682 <span class="sd">    &quot;&quot;&quot;</span>
 683     <span class="n">verbose</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">verbose</span>
 684     <span class="k">return</span> <span class="n">verbose</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;yes&#39;</span></div>
 685
 686 <div class="viewcode-block" id="product_is_autotools"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_autotools">[docs]</a><span class="k">def</span> <span class="nf">product_is_autotools</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 687     <span class="sd">&quot;&quot;&quot;Know if a product is compiled using the autotools</span>
 688 <span class="sd">    </span>
 689 <span class="sd">    :param product_info Config: The configuration specific to </span>
 690 <span class="sd">                               the product</span>
 691 <span class="sd">    :return: True if the product is autotools, else False</span>
 692 <span class="sd">    :rtype: boolean</span>
 693 <span class="sd">    &quot;&quot;&quot;</span>
 694     <span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
 695     <span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;autotools&#39;</span></div>
 696
 697 <div class="viewcode-block" id="product_is_cmake"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_cmake">[docs]</a><span class="k">def</span> <span class="nf">product_is_cmake</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 698     <span class="sd">&quot;&quot;&quot;Know if a product is compiled using the cmake</span>
 699 <span class="sd">    </span>
 700 <span class="sd">    :param product_info Config: The configuration specific to </span>
 701 <span class="sd">                               the product</span>
 702 <span class="sd">    :return: True if the product is cmake, else False</span>
 703 <span class="sd">    :rtype: boolean</span>
 704 <span class="sd">    &quot;&quot;&quot;</span>
 705     <span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
 706     <span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;cmake&#39;</span></div>
 707
 708 <div class="viewcode-block" id="product_is_vcs"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_vcs">[docs]</a><span class="k">def</span> <span class="nf">product_is_vcs</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 709     <span class="sd">&quot;&quot;&quot;Know if a product is download using git, svn or cvs (not archive)</span>
 710 <span class="sd">    </span>
 711 <span class="sd">    :param product_info Config: The configuration specific to </span>
 712 <span class="sd">                               the product</span>
 713 <span class="sd">    :return: True if the product is vcs, else False</span>
 714 <span class="sd">    :rtype: boolean</span>
 715 <span class="sd">    &quot;&quot;&quot;</span>
 716     <span class="k">return</span> <span class="n">product_info</span><span class="o">.</span><span class="n">get_source</span> <span class="ow">in</span> <span class="n">AVAILABLE_VCS</span></div>
 717
 718 <div class="viewcode-block" id="product_is_smesh_plugin"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_smesh_plugin">[docs]</a><span class="k">def</span> <span class="nf">product_is_smesh_plugin</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 719     <span class="sd">&quot;&quot;&quot;Know if a product is a SMESH plugin</span>
 720 <span class="sd">    </span>
 721 <span class="sd">    :param product_info Config: The configuration specific to </span>
 722 <span class="sd">                               the product</span>
 723 <span class="sd">    :return: True if the product is a SMESH plugin, else False</span>
 724 <span class="sd">    :rtype: boolean</span>
 725 <span class="sd">    &quot;&quot;&quot;</span>
 726     <span class="k">return</span> <span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 727             <span class="s2">&quot;smesh_plugin&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
 728             <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">smesh_plugin</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">)</span></div>
 729
 730 <div class="viewcode-block" id="product_is_cpp"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_cpp">[docs]</a><span class="k">def</span> <span class="nf">product_is_cpp</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 731     <span class="sd">&quot;&quot;&quot;Know if a product is cpp</span>
 732 <span class="sd">    </span>
 733 <span class="sd">    :param product_info Config: The configuration specific to </span>
 734 <span class="sd">                               the product</span>
 735 <span class="sd">    :return: True if the product is a cpp, else False</span>
 736 <span class="sd">    :rtype: boolean</span>
 737 <span class="sd">    &quot;&quot;&quot;</span>
 738     <span class="k">return</span> <span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 739             <span class="s2">&quot;cpp&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
 740             <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">cpp</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">)</span></div>
 741
 742 <div class="viewcode-block" id="product_compiles"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_compiles">[docs]</a><span class="k">def</span> <span class="nf">product_compiles</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 743     <span class="sd">&quot;&quot;&quot;\</span>
 744 <span class="sd">    Know if a product compiles or not </span>
 745 <span class="sd">    (some products do not have a compilation procedure)</span>
 746 <span class="sd">    </span>
 747 <span class="sd">    :param product_info Config: The configuration specific to </span>
 748 <span class="sd">                               the product</span>
 749 <span class="sd">    :return: True if the product compiles, else False</span>
 750 <span class="sd">    :rtype: boolean</span>
 751 <span class="sd">    &quot;&quot;&quot;</span>
 752     <span class="k">return</span> <span class="ow">not</span><span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 753             <span class="s2">&quot;compilation&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
 754             <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">compilation</span> <span class="o">==</span> <span class="s2">&quot;no&quot;</span><span class="p">)</span></div>
 755
 756 <div class="viewcode-block" id="product_has_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_script">[docs]</a><span class="k">def</span> <span class="nf">product_has_script</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 757     <span class="sd">&quot;&quot;&quot;Know if a product has a compilation script</span>
 758 <span class="sd">    </span>
 759 <span class="sd">    :param product_info Config: The configuration specific to </span>
 760 <span class="sd">                               the product</span>
 761 <span class="sd">    :return: True if the product it has a compilation script, else False</span>
 762 <span class="sd">    :rtype: boolean</span>
 763 <span class="sd">    &quot;&quot;&quot;</span>
 764     <span class="k">if</span> <span class="s2">&quot;build_source&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">product_info</span><span class="p">:</span>
 765         <span class="c1"># Native case</span>
 766         <span class="k">return</span> <span class="kc">False</span>
 767     <span class="n">build_src</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">build_source</span>
 768     <span class="k">return</span> <span class="n">build_src</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;script&#39;</span></div>
 769
 770 <div class="viewcode-block" id="product_has_env_script"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_env_script">[docs]</a><span class="k">def</span> <span class="nf">product_has_env_script</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 771     <span class="sd">&quot;&quot;&quot;Know if a product has an environment script</span>
 772 <span class="sd">    </span>
 773 <span class="sd">    :param product_info Config: The configuration specific to </span>
 774 <span class="sd">                               the product</span>
 775 <span class="sd">    :return: True if the product it has an environment script, else False</span>
 776 <span class="sd">    :rtype: boolean</span>
 777 <span class="sd">    &quot;&quot;&quot;</span>
 778     <span class="k">return</span> <span class="s2">&quot;environ&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="s2">&quot;env_script&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">environ</span></div>
 779
 780 <div class="viewcode-block" id="product_has_patches"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_patches">[docs]</a><span class="k">def</span> <span class="nf">product_has_patches</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 781     <span class="sd">&quot;&quot;&quot;Know if a product has one or more patches</span>
 782 <span class="sd">    </span>
 783 <span class="sd">    :param product_info Config: The configuration specific to </span>
 784 <span class="sd">                               the product</span>
 785 <span class="sd">    :return: True if the product has one or more patches</span>
 786 <span class="sd">    :rtype: boolean</span>
 787 <span class="sd">    &quot;&quot;&quot;</span>
 788     <span class="n">res</span> <span class="o">=</span> <span class="p">(</span> <span class="s2">&quot;patches&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">product_info</span><span class="o">.</span><span class="n">patches</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="p">)</span>
 789     <span class="n">DBG</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;product_has_patches </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="n">product_info</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">res</span><span class="p">)</span>
 790     <span class="c1"># if product_info.name == &quot;XDATA&quot;: return True #test #10569</span>
 791     <span class="k">return</span> <span class="n">res</span></div>
 792
 793 <div class="viewcode-block" id="product_has_logo"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_logo">[docs]</a><span class="k">def</span> <span class="nf">product_has_logo</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 794     <span class="sd">&quot;&quot;&quot;Know if a product has a logo (YACSGEN generate)</span>
 795 <span class="sd">    </span>
 796 <span class="sd">    :param product_info Config: The configuration specific to </span>
 797 <span class="sd">                               the product</span>
 798 <span class="sd">    :return: The path of the logo if the product has a logo, else False</span>
 799 <span class="sd">    :rtype: Str</span>
 800 <span class="sd">    &quot;&quot;&quot;</span>
 801     <span class="k">if</span> <span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 802             <span class="s2">&quot;logo&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="p">):</span>
 803         <span class="k">return</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">logo</span>
 804     <span class="k">else</span><span class="p">:</span>
 805         <span class="k">return</span> <span class="kc">False</span></div>
 806
 807 <div class="viewcode-block" id="product_has_salome_gui"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_has_salome_gui">[docs]</a><span class="k">def</span> <span class="nf">product_has_salome_gui</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 808     <span class="sd">&quot;&quot;&quot;Know if a product has a SALOME gui</span>
 809 <span class="sd">    </span>
 810 <span class="sd">    :param product_info Config: The configuration specific to </span>
 811 <span class="sd">                               the product</span>
 812 <span class="sd">    :return: True if the product has a SALOME gui, else False</span>
 813 <span class="sd">    :rtype: Boolean</span>
 814 <span class="sd">    &quot;&quot;&quot;</span>
 815     <span class="k">return</span> <span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 816             <span class="s2">&quot;has_salome_gui&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
 817             <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">has_salome_gui</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">)</span></div>
 818
 819 <div class="viewcode-block" id="product_is_mpi"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_mpi">[docs]</a><span class="k">def</span> <span class="nf">product_is_mpi</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 820     <span class="sd">&quot;&quot;&quot;Know if a product has openmpi in its dependencies</span>
 821 <span class="sd">    </span>
 822 <span class="sd">    :param product_info Config: The configuration specific to </span>
 823 <span class="sd">                               the product</span>
 824 <span class="sd">    :return: True if the product has openmpi inits dependencies</span>
 825 <span class="sd">    :rtype: boolean</span>
 826 <span class="sd">    &quot;&quot;&quot;</span>
 827     <span class="k">return</span> <span class="s2">&quot;openmpi&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">depend</span></div>
 828
 829 <div class="viewcode-block" id="product_is_generated"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.product_is_generated">[docs]</a><span class="k">def</span> <span class="nf">product_is_generated</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 830     <span class="sd">&quot;&quot;&quot;Know if a product is generated (YACSGEN)</span>
 831 <span class="sd">    </span>
 832 <span class="sd">    :param product_info Config: The configuration specific to </span>
 833 <span class="sd">                               the product</span>
 834 <span class="sd">    :return: True if the product is generated</span>
 835 <span class="sd">    :rtype: boolean</span>
 836 <span class="sd">    &quot;&quot;&quot;</span>
 837     <span class="k">return</span> <span class="p">(</span><span class="s2">&quot;properties&quot;</span> <span class="ow">in</span> <span class="n">product_info</span> <span class="ow">and</span>
 838             <span class="s2">&quot;generate&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span> <span class="ow">and</span>
 839             <span class="n">product_info</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">generate</span> <span class="o">==</span> <span class="s2">&quot;yes&quot;</span><span class="p">)</span></div>
 840
 841 <div class="viewcode-block" id="get_product_components"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.product.get_product_components">[docs]</a><span class="k">def</span> <span class="nf">get_product_components</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 842     <span class="sd">&quot;&quot;&quot;Get the component list to generate with the product</span>
 843 <span class="sd">    </span>
 844 <span class="sd">    :param product_info Config: The configuration specific to </span>
 845 <span class="sd">                               the product</span>
 846 <span class="sd">    :return: The list of names of the components</span>
 847 <span class="sd">    :rtype: List</span>
 848 <span class="sd">    </span>
 849 <span class="sd">    &quot;&quot;&quot;</span>
 850     <span class="k">if</span> <span class="ow">not</span> <span class="n">product_is_generated</span><span class="p">(</span><span class="n">product_info</span><span class="p">):</span>
 851         <span class="k">return</span> <span class="p">[]</span>
 852
 853     <span class="n">compo_list</span> <span class="o">=</span> <span class="p">[]</span>
 854     <span class="k">if</span> <span class="s2">&quot;component_name&quot;</span> <span class="ow">in</span> <span class="n">product_info</span><span class="p">:</span>
 855         <span class="n">compo_list</span> <span class="o">=</span> <span class="n">product_info</span><span class="o">.</span><span class="n">component_name</span>
 856
 857         <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">compo_list</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
 858             <span class="n">compo_list</span> <span class="o">=</span> <span class="p">[</span> <span class="n">compo_list</span> <span class="p">]</span>
 859
 860     <span class="k">return</span> <span class="n">compo_list</span></div>
 861 </pre></div>
 862
 863           </div>
 864         </div>
 865       </div>
 866       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 867         <div class="sphinxsidebarwrapper">
 868             <p class="logo"><a href="../../index.html">
 869               <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
 870             </a></p><div class="relations">
 871 <h3>Related Topics</h3>
 872 <ul>
 873   <li><a href="../../index.html">Documentation overview</a><ul>
 874   <li><a href="../index.html">Module code</a><ul>
 875   <li><a href="../src.html">src</a><ul>
 876   </ul></li>
 877   </ul></li>
 878   </ul></li>
 879 </ul>
 880 </div>
 881 <div id="searchbox" style="display: none" role="search">
 882   <h3>Quick search</h3>
 883     <div class="searchformwrapper">
 884     <form class="search" action="../../search.html" method="get">
 885       <input type="text" name="q" />
 886       <input type="submit" value="Go" />
 887       <input type="hidden" name="check_keywords" value="yes" />
 888       <input type="hidden" name="area" value="default" />
 889     </form>
 890     </div>
 891 </div>
 892 <script type="text/javascript">$('#searchbox').show(0);</script>
 893         </div>
 894       </div>
 895       <div class="clearer"></div>
 896     </div>
 897     <div class="footer">
 898       &copy;2018, CEA.
 899
 900       |
 901       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.3</a>
 902       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 903
 904     </div>
 905
 906
 907
 908
 909   </body>
 910 </html>