doc/sphinx/_build/html/_modules/nepi/util/execfuncs.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.util.execfuncs &mdash; NEPI 3.0 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../',
  17         VERSION:     '3.0',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
  27     <link rel="up" title="Module code" href="../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
  40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.util.execfuncs</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85 <span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span><span class="p">,</span> <span class="n">STDOUT</span><span class="p">,</span> <span class="n">log</span><span class="p">,</span> <span class="n">shell_escape</span>
  86
  87 <span class="kn">import</span> <span class="nn">logging</span>
  88 <span class="kn">import</span> <span class="nn">shlex</span>
  89 <span class="kn">import</span> <span class="nn">subprocess</span>
  90
  91 <div class="viewcode-block" id="lexec"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.execfuncs.lexec">[docs]</a><span class="k">def</span> <span class="nf">lexec</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
  92         <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
  93         <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
  94         <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
  95     <span class="sd">&quot;&quot;&quot;</span>
  96 <span class="sd">    Executes a local command, returns ((stdout,stderr),process)</span>
  97 <span class="sd">    &quot;&quot;&quot;</span>
  98     <span class="k">if</span> <span class="n">env</span><span class="p">:</span>
  99         <span class="n">export</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
 100         <span class="k">for</span> <span class="n">envkey</span><span class="p">,</span> <span class="n">envval</span> <span class="ow">in</span> <span class="n">env</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
 101             <span class="n">export</span> <span class="o">+=</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">=</span><span class="si">%s</span><span class="s"> &#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">envkey</span><span class="p">,</span> <span class="n">envval</span><span class="p">)</span>
 102         <span class="n">command</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">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">export</span><span class="p">,</span> <span class="n">command</span><span class="p">)</span>
 103
 104     <span class="k">if</span> <span class="n">sudo</span><span class="p">:</span>
 105         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sudo </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">command</span>
 106
 107     <span class="c"># XXX: Doing &#39;su user&#39; blocks waiting for a password on stdin</span>
 108     <span class="c">#elif user:</span>
 109     <span class="c">#    command = &quot;su %s ; %s &quot; % (user, command)</span>
 110
 111     <span class="n">proc</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">command</span><span class="p">,</span>
 112                 <span class="n">shell</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 113                 <span class="n">stdout</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
 114                 <span class="n">stderr</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
 115
 116     <span class="n">out</span> <span class="o">=</span> <span class="n">err</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
 117     <span class="n">log_msg</span> <span class="o">=</span> <span class="s">&quot;lexec - command </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">command</span>
 118
 119     <span class="k">try</span><span class="p">:</span>
 120         <span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
 121         <span class="n">log</span><span class="p">(</span><span class="n">log_msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 122     <span class="k">except</span><span class="p">:</span>
 123         <span class="n">log</span><span class="p">(</span><span class="n">log_msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">ERROR</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 124         <span class="k">raise</span>
 125
 126     <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
 127 </div>
 128 <div class="viewcode-block" id="lcopy"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.execfuncs.lcopy">[docs]</a><span class="k">def</span> <span class="nf">lcopy</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">dest</span><span class="p">,</span> <span class="n">recursive</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
 129     <span class="sd">&quot;&quot;&quot;</span>
 130 <span class="sd">    Copies from/to localy.</span>
 131 <span class="sd">    &quot;&quot;&quot;</span>
 132
 133     <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;cp&quot;</span><span class="p">]</span>
 134     <span class="k">if</span> <span class="n">recursive</span><span class="p">:</span>
 135         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-r&quot;</span><span class="p">)</span>
 136
 137     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 138         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
 139     <span class="k">else</span><span class="p">:</span>
 140         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
 141
 142     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dest</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
 143         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span>
 144     <span class="k">else</span><span class="p">:</span>
 145         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span>
 146
 147     <span class="n">proc</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">args</span><span class="p">,</span>
 148         <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
 149         <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
 150
 151     <span class="n">out</span> <span class="o">=</span> <span class="n">err</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
 152     <span class="n">command</span> <span class="o">=</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 153     <span class="n">log_msg</span> <span class="o">=</span> <span class="s">&quot; lcopy - command </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">command</span>
 154
 155     <span class="k">try</span><span class="p">:</span>
 156         <span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
 157         <span class="n">log</span><span class="p">(</span><span class="n">log_msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 158     <span class="k">except</span><span class="p">:</span>
 159         <span class="n">log</span><span class="p">(</span><span class="n">log_msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">ERROR</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 160         <span class="k">raise</span>
 161
 162     <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
 163    </div>
 164 <div class="viewcode-block" id="lspawn"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.execfuncs.lspawn">[docs]</a><span class="k">def</span> <span class="nf">lspawn</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">pidfile</span><span class="p">,</span>
 165         <span class="n">stdout</span> <span class="o">=</span> <span class="s">&#39;/dev/null&#39;</span><span class="p">,</span>
 166         <span class="n">stderr</span> <span class="o">=</span> <span class="n">STDOUT</span><span class="p">,</span>
 167         <span class="n">stdin</span> <span class="o">=</span> <span class="s">&#39;/dev/null&#39;</span><span class="p">,</span>
 168         <span class="n">home</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 169         <span class="n">create_home</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 170         <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 171         <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
 172     <span class="sd">&quot;&quot;&quot;</span>
 173 <span class="sd">    Spawn a local command such that it will continue working asynchronously.</span>
 174 <span class="sd">    </span>
 175 <span class="sd">    Parameters:</span>
 176 <span class="sd">        command: the command to run - it should be a single line.</span>
 177 <span class="sd">        </span>
 178 <span class="sd">        pidfile: path of a (ideally unique to this task) pidfile for tracking the process.</span>
 179 <span class="sd">        </span>
 180 <span class="sd">        stdout: path of a file to redirect standard output to - must be a string.</span>
 181 <span class="sd">            Defaults to /dev/null</span>
 182 <span class="sd">        stderr: path of a file to redirect standard error to - string or the special STDOUT value</span>
 183 <span class="sd">            to redirect to the same file stdout was redirected to. Defaults to STDOUT.</span>
 184 <span class="sd">        stdin: path of a file with input to be piped into the command&#39;s standard input</span>
 185 <span class="sd">        </span>
 186 <span class="sd">        home: path of a folder to use as working directory - should exist, unless you specify create_home</span>
 187 <span class="sd">        </span>
 188 <span class="sd">        create_home: if True, the home folder will be created first with mkdir -p</span>
 189 <span class="sd">        </span>
 190 <span class="sd">        sudo: whether the command needs to be executed as root</span>
 191 <span class="sd">        </span>
 192 <span class="sd">    Returns:</span>
 193 <span class="sd">        (stdout, stderr), process</span>
 194 <span class="sd">        </span>
 195 <span class="sd">        Of the spawning process, which only captures errors at spawning time.</span>
 196 <span class="sd">        Usually only useful for diagnostics.</span>
 197 <span class="sd">    &quot;&quot;&quot;</span>
 198     <span class="c"># Start process in a &quot;daemonized&quot; way, using nohup and heavy</span>
 199     <span class="c"># stdin/out redirection to avoid connection issues</span>
 200     <span class="k">if</span> <span class="n">stderr</span> <span class="ow">is</span> <span class="n">STDOUT</span><span class="p">:</span>
 201         <span class="n">stderr</span> <span class="o">=</span> <span class="s">&#39;&amp;1&#39;</span>
 202     <span class="k">else</span><span class="p">:</span>
 203         <span class="n">stderr</span> <span class="o">=</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">stderr</span>
 204
 205     <span class="n">daemon_command</span> <span class="o">=</span> <span class="s">&#39;{ { </span><span class="si">%(command)s</span><span class="s">  &gt; </span><span class="si">%(stdout)s</span><span class="s"> 2&gt;</span><span class="si">%(stderr)s</span><span class="s"> &lt; </span><span class="si">%(stdin)s</span><span class="s"> &amp; } ; echo $! 1 &gt; </span><span class="si">%(pidfile)s</span><span class="s"> ; }&#39;</span> <span class="o">%</span> <span class="p">{</span>
 206         <span class="s">&#39;command&#39;</span> <span class="p">:</span> <span class="n">command</span><span class="p">,</span>
 207         <span class="s">&#39;pidfile&#39;</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">pidfile</span><span class="p">),</span>
 208         <span class="s">&#39;stdout&#39;</span> <span class="p">:</span> <span class="n">stdout</span><span class="p">,</span>
 209         <span class="s">&#39;stderr&#39;</span> <span class="p">:</span> <span class="n">stderr</span><span class="p">,</span>
 210         <span class="s">&#39;stdin&#39;</span> <span class="p">:</span> <span class="n">stdin</span><span class="p">,</span>
 211     <span class="p">}</span>
 212
 213     <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%(create)s%(gohome)s</span><span class="s"> rm -f </span><span class="si">%(pidfile)s</span><span class="s"> ; </span><span class="si">%(sudo)s</span><span class="s"> bash -c </span><span class="si">%(command)s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="p">{</span>
 214             <span class="s">&#39;command&#39;</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">daemon_command</span><span class="p">),</span>
 215             <span class="s">&#39;sudo&#39;</span> <span class="p">:</span> <span class="s">&#39;sudo -S&#39;</span> <span class="k">if</span> <span class="n">sudo</span> <span class="k">else</span> <span class="s">&#39;&#39;</span><span class="p">,</span>
 216             <span class="s">&#39;pidfile&#39;</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">pidfile</span><span class="p">),</span>
 217             <span class="s">&#39;gohome&#39;</span> <span class="p">:</span> <span class="s">&#39;cd </span><span class="si">%s</span><span class="s"> ; &#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">shell_escape</span><span class="p">(</span><span class="n">home</span><span class="p">),)</span> <span class="k">if</span> <span class="n">home</span> <span class="k">else</span> <span class="s">&#39;&#39;</span><span class="p">,</span>
 218             <span class="s">&#39;create&#39;</span> <span class="p">:</span> <span class="s">&#39;mkdir -p </span><span class="si">%s</span><span class="s"> ; &#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">shell_escape</span><span class="p">(</span><span class="n">home</span><span class="p">),)</span> <span class="k">if</span> <span class="n">create_home</span> <span class="k">else</span> <span class="s">&#39;&#39;</span><span class="p">,</span>
 219         <span class="p">}</span>
 220
 221     <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">lexec</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
 222
 223     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
 224         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Failed to set up application on host </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">host</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">,)</span>
 225
 226     <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
 227 </div>
 228 <div class="viewcode-block" id="lgetpid"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.execfuncs.lgetpid">[docs]</a><span class="k">def</span> <span class="nf">lgetpid</span><span class="p">(</span><span class="n">pidfile</span><span class="p">):</span>
 229     <span class="sd">&quot;&quot;&quot;</span>
 230 <span class="sd">    Check the pidfile of a process spawned with remote_spawn.</span>
 231 <span class="sd">    </span>
 232 <span class="sd">    Parameters:</span>
 233 <span class="sd">        pidfile: the pidfile passed to remote_span</span>
 234 <span class="sd">        </span>
 235 <span class="sd">    Returns:</span>
 236 <span class="sd">        </span>
 237 <span class="sd">        A (pid, ppid) tuple useful for calling remote_status and remote_kill,</span>
 238 <span class="sd">        or None if the pidfile isn&#39;t valid yet (maybe the process is still starting).</span>
 239 <span class="sd">    &quot;&quot;&quot;</span>
 240
 241     <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">lexec</span><span class="p">(</span><span class="s">&quot;cat </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">pidfile</span> <span class="p">)</span>
 242
 243     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
 244         <span class="k">return</span> <span class="bp">None</span>
 245
 246     <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
 247         <span class="k">try</span><span class="p">:</span>
 248             <span class="k">return</span> <span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span><span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39; &#39;</span><span class="p">,</span><span class="mi">1</span><span class="p">))</span>
 249         <span class="k">except</span><span class="p">:</span>
 250             <span class="c"># Ignore, many ways to fail that don&#39;t matter that much</span>
 251             <span class="k">return</span> <span class="bp">None</span>
 252 </div>
 253 <div class="viewcode-block" id="lstatus"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.execfuncs.lstatus">[docs]</a><span class="k">def</span> <span class="nf">lstatus</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">):</span>
 254     <span class="sd">&quot;&quot;&quot;</span>
 255 <span class="sd">    Check the status of a process spawned with remote_spawn.</span>
 256 <span class="sd">    </span>
 257 <span class="sd">    Parameters:</span>
 258 <span class="sd">        pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid</span>
 259 <span class="sd">        </span>
 260 <span class="sd">    Returns:</span>
 261 <span class="sd">        </span>
 262 <span class="sd">        One of NOT_STARTED, RUNNING, FINISHED</span>
 263 <span class="sd">    &quot;&quot;&quot;</span>
 264
 265     <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="n">lexec</span><span class="p">(</span>
 266         <span class="c"># Check only by pid. pid+ppid does not always work (especially with sudo) </span>
 267         <span class="s">&quot; (( ps --pid </span><span class="si">%(pid)d</span><span class="s"> -o pid | grep -c </span><span class="si">%(pid)d</span><span class="s"> &amp;&amp; echo &#39;wait&#39;)  || echo &#39;done&#39; ) | tail -n 1&quot;</span> <span class="o">%</span> <span class="p">{</span>
 268             <span class="s">&#39;ppid&#39;</span> <span class="p">:</span> <span class="n">ppid</span><span class="p">,</span>
 269             <span class="s">&#39;pid&#39;</span> <span class="p">:</span> <span class="n">pid</span><span class="p">,</span>
 270         <span class="p">})</span>
 271
 272     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
 273         <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">NOT_STARTED</span>
 274
 275     <span class="n">status</span> <span class="o">=</span> <span class="bp">False</span>
 276     <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
 277         <span class="n">status</span> <span class="o">=</span> <span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s">&#39;wait&#39;</span><span class="p">)</span>
 278     <span class="k">else</span><span class="p">:</span>
 279         <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">NOT_STARTED</span>
 280
 281     <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">RUNNING</span> <span class="k">if</span> <span class="n">status</span> <span class="k">else</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">FINISHED</span>
 282 </div>
 283 <div class="viewcode-block" id="lkill"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.execfuncs.lkill">[docs]</a><span class="k">def</span> <span class="nf">lkill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
 284     <span class="sd">&quot;&quot;&quot;</span>
 285 <span class="sd">    Kill a process spawned with lspawn.</span>
 286 <span class="sd">    </span>
 287 <span class="sd">    First tries a SIGTERM, and if the process does not end in 10 seconds,</span>
 288 <span class="sd">    it sends a SIGKILL.</span>
 289 <span class="sd">    </span>
 290 <span class="sd">    Parameters:</span>
 291 <span class="sd">        pid/ppid: pid and parent-pid of the spawned process. See remote_check_pid</span>
 292 <span class="sd">        </span>
 293 <span class="sd">        sudo: whether the command was run with sudo - careful killing like this.</span>
 294 <span class="sd">    </span>
 295 <span class="sd">    Returns:</span>
 296 <span class="sd">        </span>
 297 <span class="sd">        Nothing, should have killed the process</span>
 298 <span class="sd">    &quot;&quot;&quot;</span>
 299
 300     <span class="n">subkill</span> <span class="o">=</span> <span class="s">&quot;$(ps --ppid </span><span class="si">%(pid)d</span><span class="s"> -o pid h)&quot;</span> <span class="o">%</span> <span class="p">{</span> <span class="s">&#39;pid&#39;</span> <span class="p">:</span> <span class="n">pid</span> <span class="p">}</span>
 301     <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;</span>
 302 <span class="s">SUBKILL=&quot;</span><span class="si">%(subkill)s</span><span class="s">&quot; ;</span>
 303 <span class="si">%(sudo)s</span><span class="s"> kill -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 304 <span class="si">%(sudo)s</span><span class="s"> kill </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 305 <span class="s">for x in 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 ; do </span>
 306 <span class="s">    sleep 0.2 </span>
 307 <span class="s">    if [ `ps --pid </span><span class="si">%(pid)d</span><span class="s"> -o pid | grep -c </span><span class="si">%(pid)d</span><span class="s">` == &#39;0&#39; ]; then</span>
 308 <span class="s">        break</span>
 309 <span class="s">    else</span>
 310 <span class="s">        </span><span class="si">%(sudo)s</span><span class="s"> kill -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 311 <span class="s">        </span><span class="si">%(sudo)s</span><span class="s"> kill </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 312 <span class="s">    fi</span>
 313 <span class="s">    sleep 1.8</span>
 314 <span class="s">done</span>
 315 <span class="s">if [ `ps --pid </span><span class="si">%(pid)d</span><span class="s"> -o pid | grep -c </span><span class="si">%(pid)d</span><span class="s">` != &#39;0&#39; ]; then</span>
 316 <span class="s">    </span><span class="si">%(sudo)s</span><span class="s"> kill -9 -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 317 <span class="s">    </span><span class="si">%(sudo)s</span><span class="s"> kill -9 </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 318 <span class="s">fi</span>
 319 <span class="s">&quot;&quot;&quot;</span>
 320     <span class="k">if</span> <span class="n">nowait</span><span class="p">:</span>
 321         <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;( </span><span class="si">%s</span><span class="s"> ) &gt;/dev/null 2&gt;/dev/null &lt;/dev/null &amp;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">,)</span>
 322
 323     <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span><span class="n">proc</span> <span class="o">=</span> <span class="n">lexec</span><span class="p">(</span>
 324         <span class="n">cmd</span> <span class="o">%</span> <span class="p">{</span>
 325             <span class="s">&#39;ppid&#39;</span> <span class="p">:</span> <span class="n">ppid</span><span class="p">,</span>
 326             <span class="s">&#39;pid&#39;</span> <span class="p">:</span> <span class="n">pid</span><span class="p">,</span>
 327             <span class="s">&#39;sudo&#39;</span> <span class="p">:</span> <span class="s">&#39;sudo -S&#39;</span> <span class="k">if</span> <span class="n">sudo</span> <span class="k">else</span> <span class="s">&#39;&#39;</span><span class="p">,</span>
 328             <span class="s">&#39;subkill&#39;</span> <span class="p">:</span> <span class="n">subkill</span><span class="p">,</span>
 329         <span class="p">})</span>
 330
 331 </pre></div></div>
 332
 333           </div>
 334         </div>
 335       </div>
 336       <div class="clearer"></div>
 337     </div>
 338     <div class="related">
 339       <h3>Navigation</h3>
 340       <ul>
 341         <li class="right" style="margin-right: 10px">
 342           <a href="../../../genindex.html" title="General Index"
 343              >index</a></li>
 344         <li class="right" >
 345           <a href="../../../py-modindex.html" title="Python Module Index"
 346              >modules</a> |</li>
 347         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 348           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 349       </ul>
 350     </div>
 351     <div class="footer">
 352         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 353       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 354     </div>
 355   </body>
 356 </html>