doc/build/html/_modules/src/system.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
   6 <html xmlns="http://www.w3.org/1999/xhtml">
   7   <head>
   8     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   9
  10     <title>src.system &mdash; salomeTools 5.0.0dev documentation</title>
  11
  12     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  13     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  14     <link rel="stylesheet" href="/volatile/wambeke/SAT5/SAT5_S840_MATIX24/SAT/doc/src/custom.css" type="text/css" />
  15
  16     <script type="text/javascript">
  17       var DOCUMENTATION_OPTIONS = {
  18         URL_ROOT:    '../../',
  19         VERSION:     '5.0.0dev',
  20         COLLAPSE_INDEX: false,
  21         FILE_SUFFIX: '.html',
  22         HAS_SOURCE:  true
  23       };
  24     </script>
  25     <script type="text/javascript" src="../../_static/jquery.js"></script>
  26     <script type="text/javascript" src="../../_static/underscore.js"></script>
  27     <script type="text/javascript" src="../../_static/doctools.js"></script>
  28     <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
  29     <link rel="top" title="salomeTools 5.0.0dev documentation" href="../../index.html" />
  30     <link rel="up" title="Module code" href="../index.html" />
  31
  32   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  33
  34
  35   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  36
  37   </head>
  38   <body>
  39
  40
  41     <div class="document">
  42       <div class="documentwrapper">
  43         <div class="bodywrapper">
  44           <div class="body" role="main">
  45
  46   <h1>Source code for src.system</h1><div class="highlight"><pre>
  47 <span class="c">#!/usr/bin/env python</span>
  48 <span class="c">#-*- coding:utf-8 -*-</span>
  49 <span class="c">#  Copyright (C) 2010-2013  CEA/DEN</span>
  50 <span class="c">#</span>
  51 <span class="c">#  This library is free software; you can redistribute it and/or</span>
  52 <span class="c">#  modify it under the terms of the GNU Lesser General Public</span>
  53 <span class="c">#  License as published by the Free Software Foundation; either</span>
  54 <span class="c">#  version 2.1 of the License.</span>
  55 <span class="c">#</span>
  56 <span class="c">#  This library is distributed in the hope that it will be useful,</span>
  57 <span class="c">#  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  58 <span class="c">#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
  59 <span class="c">#  Lesser General Public License for more details.</span>
  60 <span class="c">#</span>
  61 <span class="c">#  You should have received a copy of the GNU Lesser General Public</span>
  62 <span class="c">#  License along with this library; if not, write to the Free Software</span>
  63 <span class="c">#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA</span>
  64
  65 <span class="sd">&#39;&#39;&#39;</span>
  66 <span class="sd">In this file : all functions that do a system call, </span>
  67 <span class="sd">like open a browser or an editor, or call a git command</span>
  68 <span class="sd">&#39;&#39;&#39;</span>
  69
  70 <span class="kn">import</span> <span class="nn">subprocess</span>
  71 <span class="kn">import</span> <span class="nn">os</span>
  72 <span class="kn">import</span> <span class="nn">tarfile</span>
  73
  74 <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">printcolors</span>
  75
  76 <div class="viewcode-block" id="show_in_editor"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.show_in_editor">[docs]</a><span class="k">def</span> <span class="nf">show_in_editor</span><span class="p">(</span><span class="n">editor</span><span class="p">,</span> <span class="n">filePath</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
  77     <span class="sd">&#39;&#39;&#39;open filePath using editor.</span>
  78 <span class="sd">    </span>
  79 <span class="sd">    :param editor str: The editor to use.</span>
  80 <span class="sd">    :param filePath str: The path to the file to open.</span>
  81 <span class="sd">    &#39;&#39;&#39;</span>
  82     <span class="c"># default editor is vi</span>
  83     <span class="k">if</span> <span class="n">editor</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">editor</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
  84         <span class="n">editor</span> <span class="o">=</span> <span class="s">&#39;vi&#39;</span>
  85
  86     <span class="k">if</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">editor</span><span class="p">:</span>
  87         <span class="n">editor</span> <span class="o">+=</span> <span class="s">&#39; </span><span class="si">%s</span><span class="s">&#39;</span>
  88
  89     <span class="k">try</span><span class="p">:</span>
  90         <span class="c"># launch cmd using subprocess.Popen</span>
  91         <span class="n">cmd</span> <span class="o">=</span> <span class="n">editor</span> <span class="o">%</span> <span class="n">filePath</span>
  92         <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;Launched command:</span><span class="se">\n</span><span class="s">&#39;</span> <span class="o">+</span> <span class="n">cmd</span> <span class="o">+</span> <span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
  93         <span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
  94         <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
  95     <span class="k">except</span><span class="p">:</span>
  96         <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">printcolors</span><span class="o">.</span><span class="n">printcError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s">&quot;Unable to edit file </span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">)</span>
  97                                              <span class="o">%</span> <span class="n">filePath</span><span class="p">),</span> <span class="mi">1</span><span class="p">)</span>
  98
  99 </div>
 100 <div class="viewcode-block" id="git_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.git_extract">[docs]</a><span class="k">def</span> <span class="nf">git_extract</span><span class="p">(</span><span class="n">from_what</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">environment</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
 101     <span class="sd">&#39;&#39;&#39;Extracts sources from a git repository.</span>
 102 <span class="sd">    </span>
 103 <span class="sd">    :param from_what str: The remote git repository.</span>
 104 <span class="sd">    :param tag str: The tag.</span>
 105 <span class="sd">    :param where str: The path where to extract.</span>
 106 <span class="sd">    :param logger Logger: The logger instance to use.</span>
 107 <span class="sd">    :param environment src.environment.Environ: The environment to source when</span>
 108 <span class="sd">                                                extracting.</span>
 109 <span class="sd">    :return: True if the extraction is successful</span>
 110 <span class="sd">    :rtype: boolean</span>
 111 <span class="sd">    &#39;&#39;&#39;</span>
 112     <span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
 113         <span class="n">where</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
 114     <span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">&quot;master&quot;</span> <span class="ow">or</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">&quot;HEAD&quot;</span><span class="p">:</span>
 115         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;git clone </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">&quot;</span> <span class="o">%</span> \
 116                     <span class="p">{</span> <span class="s">&#39;remote&#39;</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">&#39;tag&#39;</span><span class="p">:</span> <span class="n">tag</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
 117     <span class="k">else</span><span class="p">:</span>
 118         <span class="c"># NOTICE: this command only works with recent version of git</span>
 119         <span class="c">#         because --work-tree does not work with an absolute path</span>
 120         <span class="n">where_git</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="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">),</span> <span class="s">&quot;.git&quot;</span> <span class="p">)</span>
 121         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;rmdir </span><span class="si">%(where)s</span><span class="s"> &amp;&amp; git clone </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s"> &amp;&amp; &quot;</span> <span class="o">+</span> \
 122                   <span class="s">&quot;git --git-dir=</span><span class="si">%(where_git)s</span><span class="s"> --work-tree=</span><span class="si">%(where)s</span><span class="s"> checkout </span><span class="si">%(tag)s</span><span class="s">&quot;</span>
 123         <span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">%</span> <span class="p">{</span><span class="s">&#39;remote&#39;</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span>
 124                              <span class="s">&#39;tag&#39;</span><span class="p">:</span> <span class="n">tag</span><span class="p">,</span>
 125                              <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">),</span>
 126                              <span class="s">&#39;where_git&#39;</span><span class="p">:</span> <span class="n">where_git</span> <span class="p">}</span>
 127
 128     <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
 129
 130     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">)</span>
 131     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
 132     <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
 133                           <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()),</span>
 134                           <span class="n">env</span><span class="o">=</span><span class="n">environment</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
 135                           <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
 136                           <span class="n">stdout</span><span class="o">=</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
 137                           <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
 138     <span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span>
 139 </div>
 140 <div class="viewcode-block" id="archive_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.archive_extract">[docs]</a><span class="k">def</span> <span class="nf">archive_extract</span><span class="p">(</span><span class="n">from_what</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
 141     <span class="sd">&#39;&#39;&#39;Extracts sources from an archive.</span>
 142 <span class="sd">    </span>
 143 <span class="sd">    :param from_what str: The path to the archive.</span>
 144 <span class="sd">    :param where str: The path where to extract.</span>
 145 <span class="sd">    :param logger Logger: The logger instance to use.</span>
 146 <span class="sd">    :return: True if the extraction is successful</span>
 147 <span class="sd">    :rtype: boolean</span>
 148 <span class="sd">    &#39;&#39;&#39;</span>
 149     <span class="k">try</span><span class="p">:</span>
 150         <span class="n">archive</span> <span class="o">=</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">from_what</span><span class="p">)</span>
 151         <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">archive</span><span class="o">.</span><span class="n">getmembers</span><span class="p">():</span>
 152             <span class="n">archive</span><span class="o">.</span><span class="n">extract</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">))</span>
 153         <span class="k">return</span> <span class="bp">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">commonprefix</span><span class="p">(</span><span class="n">archive</span><span class="o">.</span><span class="n">getnames</span><span class="p">())</span>
 154     <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
 155         <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;archive_extract: </span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">exc</span><span class="p">)</span>
 156         <span class="k">return</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">None</span>
 157 </div>
 158 <div class="viewcode-block" id="cvs_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.cvs_extract">[docs]</a><span class="k">def</span> <span class="nf">cvs_extract</span><span class="p">(</span><span class="n">protocol</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">tag</span><span class="p">,</span> <span class="n">product</span><span class="p">,</span> <span class="n">where</span><span class="p">,</span>
 159                 <span class="n">logger</span><span class="p">,</span> <span class="n">checkout</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">environment</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
 160     <span class="sd">&#39;&#39;&#39;Extracts sources from a cvs repository.</span>
 161 <span class="sd">    </span>
 162 <span class="sd">    :param protocol str: The cvs protocol.</span>
 163 <span class="sd">    :param user str: The user to be used.</span>
 164 <span class="sd">    :param server str: The remote cvs server.</span>
 165 <span class="sd">    :param base str: .</span>
 166 <span class="sd">    :param tag str: The tag.</span>
 167 <span class="sd">    :param product str: The product.</span>
 168 <span class="sd">    :param where str: The path where to extract.</span>
 169 <span class="sd">    :param logger Logger: The logger instance to use.</span>
 170 <span class="sd">    :param checkout boolean: If true use checkout cvs.</span>
 171 <span class="sd">    :param environment src.environment.Environ: The environment to source when</span>
 172 <span class="sd">                                                extracting.</span>
 173 <span class="sd">    :return: True if the extraction is successful</span>
 174 <span class="sd">    :rtype: boolean</span>
 175 <span class="sd">    &#39;&#39;&#39;</span>
 176
 177     <span class="n">opttag</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
 178     <span class="k">if</span> <span class="n">tag</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 179         <span class="n">opttag</span> <span class="o">=</span> <span class="s">&#39;-r &#39;</span> <span class="o">+</span> <span class="n">tag</span>
 180
 181     <span class="n">cmd</span> <span class="o">=</span> <span class="s">&#39;export&#39;</span>
 182     <span class="k">if</span> <span class="n">checkout</span><span class="p">:</span>
 183         <span class="n">cmd</span> <span class="o">=</span> <span class="s">&#39;checkout&#39;</span>
 184     <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">opttag</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
 185         <span class="n">opttag</span> <span class="o">=</span> <span class="s">&#39;-DNOW&#39;</span>
 186
 187     <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">protocol</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
 188         <span class="n">root</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">@</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">user</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">base</span><span class="p">)</span>
 189         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;cvs -d :</span><span class="si">%(protocol)s</span><span class="s">:</span><span class="si">%(root)s</span><span class="s"> </span><span class="si">%(command)s</span><span class="s"> -d </span><span class="si">%(where)s</span><span class="s"> </span><span class="si">%(tag)s</span><span class="s"> </span><span class="si">%(product)s</span><span class="s">&quot;</span> <span class="o">%</span> \
 190             <span class="p">{</span> <span class="s">&#39;protocol&#39;</span><span class="p">:</span> <span class="n">protocol</span><span class="p">,</span> <span class="s">&#39;root&#39;</span><span class="p">:</span> <span class="n">root</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">base</span><span class="p">()),</span>
 191               <span class="s">&#39;tag&#39;</span><span class="p">:</span> <span class="n">opttag</span><span class="p">,</span> <span class="s">&#39;product&#39;</span><span class="p">:</span> <span class="n">product</span><span class="p">,</span> <span class="s">&#39;command&#39;</span><span class="p">:</span> <span class="n">cmd</span> <span class="p">}</span>
 192     <span class="k">else</span><span class="p">:</span>
 193         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;cvs -d </span><span class="si">%(root)s</span><span class="s"> </span><span class="si">%(command)s</span><span class="s"> -d </span><span class="si">%(where)s</span><span class="s"> </span><span class="si">%(tag)s</span><span class="s"> </span><span class="si">%(base)s</span><span class="s">/</span><span class="si">%(product)s</span><span class="s">&quot;</span> <span class="o">%</span> \
 194             <span class="p">{</span> <span class="s">&#39;root&#39;</span><span class="p">:</span> <span class="n">server</span><span class="p">,</span> <span class="s">&#39;base&#39;</span><span class="p">:</span> <span class="n">base</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">base</span><span class="p">()),</span>
 195               <span class="s">&#39;tag&#39;</span><span class="p">:</span> <span class="n">opttag</span><span class="p">,</span> <span class="s">&#39;product&#39;</span><span class="p">:</span> <span class="n">product</span><span class="p">,</span> <span class="s">&#39;command&#39;</span><span class="p">:</span> <span class="n">cmd</span> <span class="p">}</span>
 196
 197     <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
 198
 199     <span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
 200         <span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
 201
 202     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">)</span>
 203     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
 204     <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
 205                           <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()),</span>
 206                           <span class="n">env</span><span class="o">=</span><span class="n">environment</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
 207                           <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
 208                           <span class="n">stdout</span><span class="o">=</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
 209                           <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
 210     <span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span>
 211 </div>
 212 <div class="viewcode-block" id="svn_extract"><a class="viewcode-back" href="../../commands/apidoc/src.html#src.system.svn_extract">[docs]</a><span class="k">def</span> <span class="nf">svn_extract</span><span class="p">(</span><span class="n">user</span><span class="p">,</span>
 213                 <span class="n">from_what</span><span class="p">,</span>
 214                 <span class="n">tag</span><span class="p">,</span>
 215                 <span class="n">where</span><span class="p">,</span>
 216                 <span class="n">logger</span><span class="p">,</span>
 217                 <span class="n">checkout</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
 218                 <span class="n">environment</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
 219     <span class="sd">&#39;&#39;&#39;Extracts sources from a svn repository.</span>
 220 <span class="sd">    </span>
 221 <span class="sd">    :param user str: The user to be used.</span>
 222 <span class="sd">    :param from_what str: The remote git repository.</span>
 223 <span class="sd">    :param tag str: The tag.</span>
 224 <span class="sd">    :param where str: The path where to extract.</span>
 225 <span class="sd">    :param logger Logger: The logger instance to use.</span>
 226 <span class="sd">    :param checkout boolean: If true use checkout svn.</span>
 227 <span class="sd">    :param environment src.environment.Environ: The environment to source when</span>
 228 <span class="sd">                                                extracting.</span>
 229 <span class="sd">    :return: True if the extraction is successful</span>
 230 <span class="sd">    :rtype: boolean</span>
 231 <span class="sd">    &#39;&#39;&#39;</span>
 232     <span class="k">if</span> <span class="ow">not</span> <span class="n">where</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
 233         <span class="n">where</span><span class="o">.</span><span class="n">make</span><span class="p">()</span>
 234
 235     <span class="k">if</span> <span class="n">checkout</span><span class="p">:</span>
 236         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;svn checkout --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">&quot;</span> <span class="o">%</span> \
 237             <span class="p">{</span> <span class="s">&#39;remote&#39;</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">&#39;user&#39;</span> <span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
 238     <span class="k">else</span><span class="p">:</span>
 239         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
 240         <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="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)):</span>
 241             <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;/bin/rm -rf </span><span class="si">%(where)s</span><span class="s"> &amp;&amp; &quot;</span> <span class="o">%</span> \
 242                 <span class="p">{</span> <span class="s">&#39;remote&#39;</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
 243
 244         <span class="k">if</span> <span class="n">tag</span> <span class="o">==</span> <span class="s">&quot;master&quot;</span><span class="p">:</span>
 245             <span class="n">command</span> <span class="o">+=</span> <span class="s">&quot;svn export --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">&quot;</span> <span class="o">%</span> \
 246                 <span class="p">{</span> <span class="s">&#39;remote&#39;</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">&#39;user&#39;</span> <span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
 247         <span class="k">else</span><span class="p">:</span>
 248             <span class="n">command</span> <span class="o">+=</span> <span class="s">&quot;svn export -r </span><span class="si">%(tag)s</span><span class="s"> --username </span><span class="si">%(user)s</span><span class="s"> </span><span class="si">%(remote)s</span><span class="s"> </span><span class="si">%(where)s</span><span class="s">&quot;</span> <span class="o">%</span> \
 249                 <span class="p">{</span> <span class="s">&#39;tag&#39;</span> <span class="p">:</span> <span class="n">tag</span><span class="p">,</span> <span class="s">&#39;remote&#39;</span><span class="p">:</span> <span class="n">from_what</span><span class="p">,</span> <span class="s">&#39;user&#39;</span> <span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">&#39;where&#39;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="p">)</span> <span class="p">}</span>
 250
 251     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">)</span>
 252
 253     <span class="n">logger</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
 254     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">+</span> <span class="n">command</span> <span class="o">+</span> <span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">)</span>
 255     <span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
 256     <span class="n">res</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
 257                           <span class="n">cwd</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">where</span><span class="o">.</span><span class="n">dir</span><span class="p">()),</span>
 258                           <span class="n">env</span><span class="o">=</span><span class="n">environment</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span>
 259                           <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
 260                           <span class="n">stdout</span><span class="o">=</span><span class="n">logger</span><span class="o">.</span><span class="n">logTxtFile</span><span class="p">,</span>
 261                           <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span>
 262     <span class="k">return</span> <span class="p">(</span><span class="n">res</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span></div>
 263 </pre></div>
 264
 265           </div>
 266         </div>
 267       </div>
 268       <div class="sphinxsidebar">
 269         <div class="sphinxsidebarwrapper">
 270             <p class="logo"><a href="../../index.html">
 271               <img class="logo" src="../../_static/sat_v5.0.png" alt="Logo"/>
 272             </a></p><div class="relations">
 273 <h3>Related Topics</h3>
 274 <ul>
 275   <li><a href="../../index.html">Documentation overview</a><ul>
 276   <li><a href="../index.html">Module code</a><ul>
 277   </ul></li>
 278   </ul></li>
 279 </ul>
 280 </div>
 281 <div id="searchbox" style="display: none">
 282   <h3>Quick search</h3>
 283     <form class="search" action="../../search.html" method="get">
 284       <input type="text" name="q" />
 285       <input type="submit" value="Go" />
 286       <input type="hidden" name="check_keywords" value="yes" />
 287       <input type="hidden" name="area" value="default" />
 288     </form>
 289     <p class="searchtip" style="font-size: 90%">
 290     Enter search terms or a module, class or function name.
 291     </p>
 292 </div>
 293 <script type="text/javascript">$('#searchbox').show(0);</script>
 294         </div>
 295       </div>
 296       <div class="clearer"></div>
 297     </div>
 298     <div class="footer">
 299       &copy;2018, CEA.
 300
 301       |
 302       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.1.3</a>
 303       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster </a>
 304
 305     </div>
 306
 307
 308
 309
 310   </body>
 311 </html>