/usr/share/doc/python-logilab-common/apidoc/logilab.common.shellutils-pysrc.html is in python-logilab-common 1.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>logilab.common.shellutils</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="logilab.common-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Logilab's common library</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package logilab ::
<a href="logilab.common-module.html">Package common</a> ::
Module shellutils
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="logilab.common.shellutils-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="logilab.common.shellutils-module.html">Module logilab.common.shellutils</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># copyright 2003-2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved.</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"># contact http://www.logilab.fr/ -- mailto:contact@logilab.fr</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># This file is part of logilab-common.</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"># logilab-common is free software: you can redistribute it and/or modify it under</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># the terms of the GNU Lesser General Public License as published by the Free</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"># Software Foundation, either version 2.1 of the License, or (at your option) any</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># later version.</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># logilab-common is distributed in the hope that it will be useful, but WITHOUT</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"># ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment"># details.</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"># You should have received a copy of the GNU Lesser General Public License along</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"># with logilab-common. If not, see <http://www.gnu.org/licenses/>.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">"""shell/term utilities, useful to write some python scripts instead of shell</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">scripts.</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">__future__</tt> <tt class="py-keyword">import</tt> <tt class="py-name">print_function</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">"restructuredtext en"</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">glob</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">shutil</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">stat</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">tempfile</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Method logilab.common.proc.ProcInfo.time()=logilab.common.proc.ProcInfo-class.html#time"><a title="logilab.common.proc.ProcInfo.time" class="py-name" href="#" onclick="return doclink('link-0', 'time', 'link-0');">time</a></tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">fnmatch</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">errno</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">string</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">random</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">subprocess</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> <tt class="py-keyword">import</tt> <tt class="py-name">exists</tt><tt class="py-op">,</tt> <tt class="py-name">isdir</tt><tt class="py-op">,</tt> <tt class="py-name">islink</tt><tt class="py-op">,</tt> <tt class="py-name">basename</tt><tt class="py-op">,</tt> <tt class="py-name">join</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">six</tt> <tt class="py-keyword">import</tt> <tt class="py-name">string_types</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">moves</tt> <tt class="py-keyword">import</tt> <tt class="py-name">range</tt><tt class="py-op">,</tt> <tt class="py-name">input</tt> <tt class="py-keyword">as</tt> <tt class="py-name">raw_input</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">logilab</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package logilab.common=logilab.common-module.html"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-1', 'common', 'link-1');">common</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Variable logilab.common.STD_BLACKLIST=logilab.common-module.html#STD_BLACKLIST"><a title="logilab.common.STD_BLACKLIST" class="py-name" href="#" onclick="return doclink('link-2', 'STD_BLACKLIST', 'link-2');">STD_BLACKLIST</a></tt><tt class="py-op">,</tt> <tt class="py-name">_handle_blacklist</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">logilab</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-3', 'common', 'link-1');">common</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module logilab.common.compat=logilab.common.compat-module.html"><a title="logilab.common.compat" class="py-name" href="#" onclick="return doclink('link-4', 'compat', 'link-4');">compat</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Function logilab.common.compat.str_to_bytes()=logilab.common.compat-module.html#str_to_bytes"><a title="logilab.common.compat.str_to_bytes" class="py-name" href="#" onclick="return doclink('link-5', 'str_to_bytes', 'link-5');">str_to_bytes</a></tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">logilab</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-6', 'common', 'link-1');">common</a></tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Module logilab.common.deprecation=logilab.common.deprecation-module.html"><a title="logilab.common.deprecation" class="py-name" href="#" onclick="return doclink('link-7', 'deprecation', 'link-7');">deprecation</a></tt> <tt class="py-keyword">import</tt> <tt id="link-8" class="py-name" targets="Method logilab.common.deprecation.DeprecationManager.deprecated()=logilab.common.deprecation.DeprecationManager-class.html#deprecated,Function logilab.common.deprecation.deprecated()=logilab.common.deprecation-module.html#deprecated"><a title="logilab.common.deprecation.DeprecationManager.deprecated
logilab.common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-8', 'deprecated', 'link-8');">deprecated</a></tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> </tt>
<a name="tempdir"></a><div id="tempdir-def"><a name="L48"></a><tt class="py-lineno"> 48</tt> <a class="py-toggle" href="#" id="tempdir-toggle" onclick="return toggle('tempdir');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.tempdir-class.html">tempdir</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="tempdir-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="tempdir-expanded"><a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> </tt>
<a name="tempdir.__enter__"></a><div id="tempdir.__enter__-def"><a name="L50"></a><tt class="py-lineno"> 50</tt> <a class="py-toggle" href="#" id="tempdir.__enter__-toggle" onclick="return toggle('tempdir.__enter__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.tempdir-class.html#__enter__">__enter__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="tempdir.__enter__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="tempdir.__enter__-expanded"><a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> <tt class="py-op">=</tt> <tt class="py-name">tempfile</tt><tt class="py-op">.</tt><tt class="py-name">mkdtemp</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> </tt>
</div><a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> </tt>
<a name="tempdir.__exit__"></a><div id="tempdir.__exit__-def"><a name="L54"></a><tt class="py-lineno"> 54</tt> <a class="py-toggle" href="#" id="tempdir.__exit__-toggle" onclick="return toggle('tempdir.__exit__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.tempdir-class.html#__exit__">__exit__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">exctype</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">traceback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="tempdir.__exit__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="tempdir.__exit__-expanded"><a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-comment"># rmtree in all cases</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-name">shutil</tt><tt class="py-op">.</tt><tt class="py-name">rmtree</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">)</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">traceback</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> </tt>
</div></div><a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> </tt>
<a name="pushd"></a><div id="pushd-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <a class="py-toggle" href="#" id="pushd-toggle" onclick="return toggle('pushd');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.pushd-class.html">pushd</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pushd-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="pushd-expanded"><a name="pushd.__init__"></a><div id="pushd.__init__-def"><a name="L61"></a><tt class="py-lineno"> 61</tt> <a class="py-toggle" href="#" id="pushd.__init__-toggle" onclick="return toggle('pushd.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.pushd-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pushd.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="pushd.__init__-expanded"><a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">directory</tt> <tt class="py-op">=</tt> <tt class="py-name">directory</tt> </tt>
</div><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> </tt>
<a name="pushd.__enter__"></a><div id="pushd.__enter__-def"><a name="L64"></a><tt class="py-lineno"> 64</tt> <a class="py-toggle" href="#" id="pushd.__enter__-toggle" onclick="return toggle('pushd.__enter__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.pushd-class.html#__enter__">__enter__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pushd.__enter__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="pushd.__enter__-expanded"><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cwd</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">getcwd</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">chdir</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">directory</tt> </tt>
</div><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> </tt>
<a name="pushd.__exit__"></a><div id="pushd.__exit__-def"><a name="L69"></a><tt class="py-lineno"> 69</tt> <a class="py-toggle" href="#" id="pushd.__exit__-toggle" onclick="return toggle('pushd.__exit__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.pushd-class.html#__exit__">__exit__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">exctype</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">,</tt> <tt class="py-param">traceback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pushd.__exit__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="pushd.__exit__-expanded"><a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">chdir</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cwd</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> </tt>
<a name="chown"></a><div id="chown-def"><a name="L73"></a><tt class="py-lineno"> 73</tt> <a class="py-toggle" href="#" id="chown-toggle" onclick="return toggle('chown');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#chown">chown</a><tt class="py-op">(</tt><tt class="py-param">path</tt><tt class="py-op">,</tt> <tt class="py-param">login</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">group</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="chown-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="chown-expanded"><a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-docstring">"""Same as `os.chown` function but accepting user login or group name as</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> argument. If login or group is omitted, it's left unchanged.</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> Note: you must own the file to chown it (or be root). Otherwise OSError is raised.</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">login</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">login</tt><tt class="py-op">)</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">pwd</tt> <tt class="py-comment"># Platforms: Unix</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-name">uid</tt> <tt class="py-op">=</tt> <tt class="py-name">pwd</tt><tt class="py-op">.</tt><tt class="py-name">getpwnam</tt><tt class="py-op">(</tt><tt class="py-name">login</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">pw_uid</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">group</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-name">gid</tt> <tt class="py-op">=</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-name">gid</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">)</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">grp</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-name">gid</tt> <tt class="py-op">=</tt> <tt class="py-name">grp</tt><tt class="py-op">.</tt><tt class="py-name">getgrnam</tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">gr_gid</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Function logilab.common.shellutils.chown()=logilab.common.shellutils-module.html#chown"><a title="logilab.common.shellutils.chown" class="py-name" href="#" onclick="return doclink('link-9', 'chown', 'link-9');">chown</a></tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-name">uid</tt><tt class="py-op">,</tt> <tt class="py-name">gid</tt><tt class="py-op">)</tt> </tt>
</div><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> </tt>
<a name="mv"></a><div id="mv-def"><a name="L97"></a><tt class="py-lineno"> 97</tt> <a class="py-toggle" href="#" id="mv-toggle" onclick="return toggle('mv');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#mv">mv</a><tt class="py-op">(</tt><tt class="py-param">source</tt><tt class="py-op">,</tt> <tt class="py-param">destination</tt><tt class="py-op">,</tt> <tt class="py-param">_action</tt><tt class="py-op">=</tt><tt class="py-name">shutil</tt><tt class="py-op">.</tt><tt class="py-name">move</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="mv-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="mv-expanded"><a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-docstring">"""A shell-like mv, supporting wildcards.</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-name">sources</tt> <tt class="py-op">=</tt> <tt class="py-name">glob</tt><tt class="py-op">.</tt><tt class="py-name">glob</tt><tt class="py-op">(</tt><tt id="link-10" class="py-name" targets="Method logilab.common.graph.DotBackend.source()=logilab.common.graph.DotBackend-class.html#source"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-10', 'source', 'link-10');">source</a></tt><tt class="py-op">)</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">sources</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">destination</tt><tt class="py-op">)</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">sources</tt><tt class="py-op">:</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-name">_action</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">destination</tt><tt class="py-op">,</tt> <tt class="py-name">basename</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt id="link-11" class="py-name"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-11', 'source', 'link-10');">source</a></tt> <tt class="py-op">=</tt> <tt class="py-name">sources</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IndexError</tt><tt class="py-op">:</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">OSError</tt><tt class="py-op">(</tt><tt class="py-string">'No file matching %s'</tt> <tt class="py-op">%</tt> <tt id="link-12" class="py-name"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-12', 'source', 'link-10');">source</a></tt><tt class="py-op">)</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">destination</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">destination</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-name">destination</tt> <tt class="py-op">=</tt> <tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">destination</tt><tt class="py-op">,</tt> <tt class="py-name">basename</tt><tt class="py-op">(</tt><tt id="link-13" class="py-name"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-13', 'source', 'link-10');">source</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-name">_action</tt><tt class="py-op">(</tt><tt id="link-14" class="py-name"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-14', 'source', 'link-10');">source</a></tt><tt class="py-op">,</tt> <tt class="py-name">destination</tt><tt class="py-op">)</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt> <tt class="py-keyword">as</tt> <tt class="py-name">ex</tt><tt class="py-op">:</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">OSError</tt><tt class="py-op">(</tt><tt class="py-string">'Unable to move %r to %r (%s)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt id="link-15" class="py-name"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-15', 'source', 'link-10');">source</a></tt><tt class="py-op">,</tt> <tt class="py-name">destination</tt><tt class="py-op">,</tt> <tt class="py-name">ex</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> </tt>
<a name="rm"></a><div id="rm-def"><a name="L118"></a><tt class="py-lineno">118</tt> <a class="py-toggle" href="#" id="rm-toggle" onclick="return toggle('rm');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#rm">rm</a><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">files</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="rm-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="rm-expanded"><a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> <tt class="py-docstring">"""A shell-like rm, supporting wildcards.</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">wfile</tt> <tt class="py-keyword">in</tt> <tt class="py-name">files</tt><tt class="py-op">:</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">glob</tt><tt class="py-op">.</tt><tt class="py-name">glob</tt><tt class="py-op">(</tt><tt class="py-name">wfile</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">islink</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method logilab.common.table.Table.remove()=logilab.common.table.Table-class.html#remove,Method logilab.common.tasksqueue.PrioritizedTasksQueue.remove()=logilab.common.tasksqueue.PrioritizedTasksQueue-class.html#remove,Method logilab.common.tree.BinaryNode.remove()=logilab.common.tree.BinaryNode-class.html#remove,Method logilab.common.tree.ListNode.remove()=logilab.common.tree.ListNode-class.html#remove,Method logilab.common.tree.Node.remove()=logilab.common.tree.Node-class.html#remove"><a title="logilab.common.table.Table.remove
logilab.common.tasksqueue.PrioritizedTasksQueue.remove
logilab.common.tree.BinaryNode.remove
logilab.common.tree.ListNode.remove
logilab.common.tree.Node.remove" class="py-name" href="#" onclick="return doclink('link-16', 'remove', 'link-16');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-name">shutil</tt><tt class="py-op">.</tt><tt class="py-name">rmtree</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="logilab.common.table.Table.remove
logilab.common.tasksqueue.PrioritizedTasksQueue.remove
logilab.common.tree.BinaryNode.remove
logilab.common.tree.ListNode.remove
logilab.common.tree.Node.remove" class="py-name" href="#" onclick="return doclink('link-17', 'remove', 'link-16');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt>
</div><a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> </tt>
<a name="cp"></a><div id="cp-def"><a name="L130"></a><tt class="py-lineno">130</tt> <a class="py-toggle" href="#" id="cp-toggle" onclick="return toggle('cp');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#cp">cp</a><tt class="py-op">(</tt><tt class="py-param">source</tt><tt class="py-op">,</tt> <tt class="py-param">destination</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="cp-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="cp-expanded"><a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-docstring">"""A shell-like cp, supporting wildcards.</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt id="link-18" class="py-name" targets="Function logilab.common.shellutils.mv()=logilab.common.shellutils-module.html#mv"><a title="logilab.common.shellutils.mv" class="py-name" href="#" onclick="return doclink('link-18', 'mv', 'link-18');">mv</a></tt><tt class="py-op">(</tt><tt id="link-19" class="py-name"><a title="logilab.common.graph.DotBackend.source" class="py-name" href="#" onclick="return doclink('link-19', 'source', 'link-10');">source</a></tt><tt class="py-op">,</tt> <tt class="py-name">destination</tt><tt class="py-op">,</tt> <tt class="py-name">_action</tt><tt class="py-op">=</tt><tt class="py-name">shutil</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">)</tt> </tt>
</div><a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> </tt>
<a name="find"></a><div id="find-def"><a name="L135"></a><tt class="py-lineno">135</tt> <a class="py-toggle" href="#" id="find-toggle" onclick="return toggle('find');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#find">find</a><tt class="py-op">(</tt><tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">exts</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-param">blacklist</tt><tt class="py-op">=</tt><tt id="link-20" class="py-name"><a title="logilab.common.STD_BLACKLIST" class="py-name" href="#" onclick="return doclink('link-20', 'STD_BLACKLIST', 'link-2');">STD_BLACKLIST</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="find-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="find-expanded"><a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-docstring">"""Recursively find files ending with the given extensions from the directory.</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"><tt class="py-docstring"> :type directory: str</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"><tt class="py-docstring"> :param directory:</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"><tt class="py-docstring"> directory where the search should start</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"><tt class="py-docstring"> :type exts: basestring or list or tuple</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"> :param exts:</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> extensions or lists or extensions to search</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> :type exclude: boolean</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> :param exts:</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> if this argument is True, returning files NOT ending with the given</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> extensions</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"> :type blacklist: list or tuple</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> :param blacklist:</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-docstring"> optional list of files or directory to ignore, default to the value of</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> `logilab.common.STD_BLACKLIST`</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: list</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"> :return:</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> the list of all matching files</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">exts</tt><tt class="py-op">,</tt> <tt class="py-name">string_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-name">exts</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">exts</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">exclude</tt><tt class="py-op">:</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">match</tt><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">exts</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ext</tt> <tt class="py-keyword">in</tt> <tt class="py-name">exts</tt><tt class="py-op">:</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-name">ext</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">match</tt><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">exts</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ext</tt> <tt class="py-keyword">in</tt> <tt class="py-name">exts</tt><tt class="py-op">:</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-name">ext</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"> <tt class="py-name">files</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">dirpath</tt><tt class="py-op">,</tt> <tt class="py-name">dirnames</tt><tt class="py-op">,</tt> <tt class="py-name">filenames</tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name" targets="Method logilab.common.umessage.UMessage.walk()=logilab.common.umessage.UMessage-class.html#walk"><a title="logilab.common.umessage.UMessage.walk" class="py-name" href="#" onclick="return doclink('link-21', 'walk', 'link-21');">walk</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-name">_handle_blacklist</tt><tt class="py-op">(</tt><tt class="py-name">blacklist</tt><tt class="py-op">,</tt> <tt class="py-name">dirnames</tt><tt class="py-op">,</tt> <tt class="py-name">filenames</tt><tt class="py-op">)</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-comment"># don't append files if the directory is blacklisted</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-name">dirname</tt> <tt class="py-op">=</tt> <tt class="py-name">basename</tt><tt class="py-op">(</tt><tt class="py-name">dirpath</tt><tt class="py-op">)</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">dirname</tt> <tt class="py-keyword">in</tt> <tt class="py-name">blacklist</tt><tt class="py-op">:</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-name">files</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name" targets="Function logilab.common.interface.extend()=logilab.common.interface-module.html#extend"><a title="logilab.common.interface.extend" class="py-name" href="#" onclick="return doclink('link-22', 'extend', 'link-22');">extend</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">dirpath</tt><tt class="py-op">,</tt> <tt class="py-name">f</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">f</tt> <tt class="py-keyword">in</tt> <tt class="py-name">filenames</tt> <tt class="py-keyword">if</tt> <tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">f</tt><tt class="py-op">,</tt> <tt class="py-name">exts</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">files</tt> </tt>
</div><a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> </tt>
<a name="globfind"></a><div id="globfind-def"><a name="L185"></a><tt class="py-lineno">185</tt> <a class="py-toggle" href="#" id="globfind-toggle" onclick="return toggle('globfind');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#globfind">globfind</a><tt class="py-op">(</tt><tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">pattern</tt><tt class="py-op">,</tt> <tt class="py-param">blacklist</tt><tt class="py-op">=</tt><tt id="link-23" class="py-name"><a title="logilab.common.STD_BLACKLIST" class="py-name" href="#" onclick="return doclink('link-23', 'STD_BLACKLIST', 'link-2');">STD_BLACKLIST</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="globfind-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="globfind-expanded"><a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-docstring">"""Recursively finds files matching glob `pattern` under `directory`.</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"><tt class="py-docstring"> This is an alternative to `logilab.common.shellutils.find`.</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"><tt class="py-docstring"> :type directory: str</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-docstring"> :param directory:</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-docstring"> directory where the search should start</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-docstring"> :type pattern: basestring</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"> :param pattern:</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> the glob pattern (e.g *.py, foo*.py, etc.)</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> :type blacklist: list or tuple</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> :param blacklist:</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"> optional list of files or directory to ignore, default to the value of</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"> `logilab.common.STD_BLACKLIST`</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: iterator</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-docstring"> :return:</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-docstring"> iterator over the list of all matching files</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">curdir</tt><tt class="py-op">,</tt> <tt class="py-name">dirnames</tt><tt class="py-op">,</tt> <tt class="py-name">filenames</tt> <tt class="py-keyword">in</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="logilab.common.umessage.UMessage.walk" class="py-name" href="#" onclick="return doclink('link-24', 'walk', 'link-21');">walk</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-name">_handle_blacklist</tt><tt class="py-op">(</tt><tt class="py-name">blacklist</tt><tt class="py-op">,</tt> <tt class="py-name">dirnames</tt><tt class="py-op">,</tt> <tt class="py-name">filenames</tt><tt class="py-op">)</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">fname</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fnmatch</tt><tt class="py-op">.</tt><tt class="py-name">filter</tt><tt class="py-op">(</tt><tt class="py-name">filenames</tt><tt class="py-op">,</tt> <tt class="py-name">pattern</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-keyword">yield</tt> <tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">curdir</tt><tt class="py-op">,</tt> <tt class="py-name">fname</tt><tt class="py-op">)</tt> </tt>
</div><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> </tt>
<a name="unzip"></a><div id="unzip-def"><a name="L212"></a><tt class="py-lineno">212</tt> <a class="py-toggle" href="#" id="unzip-toggle" onclick="return toggle('unzip');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#unzip">unzip</a><tt class="py-op">(</tt><tt class="py-param">archive</tt><tt class="py-op">,</tt> <tt class="py-param">destdir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="unzip-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="unzip-expanded"><a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">zipfile</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">destdir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">mkdir</tt><tt class="py-op">(</tt><tt class="py-name">destdir</tt><tt class="py-op">)</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-name">zfobj</tt> <tt class="py-op">=</tt> <tt class="py-name">zipfile</tt><tt class="py-op">.</tt><tt class="py-name">ZipFile</tt><tt class="py-op">(</tt><tt class="py-name">archive</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-25" class="py-name" targets="Variable logilab.common.clcommands.Command.name=logilab.common.clcommands.Command-class.html#name,Variable logilab.common.clcommands.ListCommandsCommand.name=logilab.common.clcommands.ListCommandsCommand-class.html#name,Variable logilab.common.configuration.OptionsProviderMixIn.name=logilab.common.configuration.OptionsProviderMixIn-class.html#name,Method logilab.common.proc.ProcInfo.name()=logilab.common.proc.ProcInfo-class.html#name"><a title="logilab.common.clcommands.Command.name
logilab.common.clcommands.ListCommandsCommand.name
logilab.common.configuration.OptionsProviderMixIn.name
logilab.common.proc.ProcInfo.name" class="py-name" href="#" onclick="return doclink('link-25', 'name', 'link-25');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">zfobj</tt><tt class="py-op">.</tt><tt class="py-name">namelist</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-26" class="py-name"><a title="logilab.common.clcommands.Command.name
logilab.common.clcommands.ListCommandsCommand.name
logilab.common.configuration.OptionsProviderMixIn.name
logilab.common.proc.ProcInfo.name" class="py-name" href="#" onclick="return doclink('link-26', 'name', 'link-25');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">mkdir</tt><tt class="py-op">(</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">destdir</tt><tt class="py-op">,</tt> <tt id="link-27" class="py-name"><a title="logilab.common.clcommands.Command.name
logilab.common.clcommands.ListCommandsCommand.name
logilab.common.configuration.OptionsProviderMixIn.name
logilab.common.proc.ProcInfo.name" class="py-name" href="#" onclick="return doclink('link-27', 'name', 'link-25');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> <tt class="py-name">outfile</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">destdir</tt><tt class="py-op">,</tt> <tt id="link-28" class="py-name"><a title="logilab.common.clcommands.Command.name
logilab.common.clcommands.ListCommandsCommand.name
logilab.common.configuration.OptionsProviderMixIn.name
logilab.common.proc.ProcInfo.name" class="py-name" href="#" onclick="return doclink('link-28', 'name', 'link-25');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-string">'wb'</tt><tt class="py-op">)</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-name">outfile</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name" targets="Method logilab.common.changelog.ChangeLog.write()=logilab.common.changelog.ChangeLog-class.html#write,Method logilab.common.changelog.ChangeLogEntry.write()=logilab.common.changelog.ChangeLogEntry-class.html#write,Method logilab.common.ureports.BaseWriter.write()=logilab.common.ureports.BaseWriter-class.html#write"><a title="logilab.common.changelog.ChangeLog.write
logilab.common.changelog.ChangeLogEntry.write
logilab.common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-29', 'write', 'link-29');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">zfobj</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="logilab.common.clcommands.Command.name
logilab.common.clcommands.ListCommandsCommand.name
logilab.common.configuration.OptionsProviderMixIn.name
logilab.common.proc.ProcInfo.name" class="py-name" href="#" onclick="return doclink('link-30', 'name', 'link-25');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-name">outfile</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Method logilab.common.fileutils.ProtectedFile.close()=logilab.common.fileutils.ProtectedFile-class.html#close"><a title="logilab.common.fileutils.ProtectedFile.close" class="py-name" href="#" onclick="return doclink('link-31', 'close', 'link-31');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> </tt>
<a name="Execute"></a><div id="Execute-def"><a name="L226"></a><tt class="py-lineno">226</tt> <a class="py-toggle" href="#" id="Execute-toggle" onclick="return toggle('Execute');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.Execute-class.html">Execute</a><tt class="py-op">:</tt> </tt>
</div><div id="Execute-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Execute-expanded"><a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt class="py-docstring">"""This is a deadlock safe version of popen2 (no stdin), that returns</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"><tt class="py-docstring"> an object with errorlevel, out and err.</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> </tt>
<a name="Execute.__init__"></a><div id="Execute.__init__-def"><a name="L231"></a><tt class="py-lineno">231</tt> <a class="py-toggle" href="#" id="Execute.__init__-toggle" onclick="return toggle('Execute.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.Execute-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Execute.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Execute.__init__-expanded"><a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-name">cmd</tt> <tt class="py-op">=</tt> <tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">Popen</tt><tt class="py-op">(</tt><tt class="py-name">command</tt><tt class="py-op">,</tt> <tt class="py-name">shell</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">stdout</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">,</tt> <tt class="py-name">stderr</tt><tt class="py-op">=</tt><tt class="py-name">subprocess</tt><tt class="py-op">.</tt><tt class="py-name">PIPE</tt><tt class="py-op">)</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">out</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">err</tt> <tt class="py-op">=</tt> <tt class="py-name">cmd</tt><tt class="py-op">.</tt><tt class="py-name">communicate</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method logilab.common.proc.ProcInfo.status()=logilab.common.proc.ProcInfo-class.html#status"><a title="logilab.common.proc.ProcInfo.status" class="py-name" href="#" onclick="return doclink('link-32', 'status', 'link-32');">status</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">WEXITSTATUS</tt><tt class="py-op">(</tt><tt class="py-name">cmd</tt><tt class="py-op">.</tt><tt class="py-name">returncode</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt id="link-33" class="py-name" targets="Variable logilab.common.shellutils.Execute=logilab.common.shellutils-module.html#Execute"><a title="logilab.common.shellutils.Execute" class="py-name" href="#" onclick="return doclink('link-33', 'Execute', 'link-33');">Execute</a></tt> <tt class="py-op">=</tt> <tt id="link-34" class="py-name"><a title="logilab.common.deprecation.DeprecationManager.deprecated
logilab.common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-34', 'deprecated', 'link-8');">deprecated</a></tt><tt class="py-op">(</tt><tt class="py-string">'Use subprocess.Popen instead'</tt><tt class="py-op">)</tt><tt class="py-op">(</tt><tt id="link-35" class="py-name"><a title="logilab.common.shellutils.Execute" class="py-name" href="#" onclick="return doclink('link-35', 'Execute', 'link-33');">Execute</a></tt><tt class="py-op">)</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> </tt>
<a name="ProgressBar"></a><div id="ProgressBar-def"><a name="L239"></a><tt class="py-lineno">239</tt> <a class="py-toggle" href="#" id="ProgressBar-toggle" onclick="return toggle('ProgressBar');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html">ProgressBar</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ProgressBar-expanded"><a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"> <tt class="py-docstring">"""A simple text progression bar."""</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> </tt>
<a name="ProgressBar.__init__"></a><div id="ProgressBar.__init__-def"><a name="L242"></a><tt class="py-lineno">242</tt> <a class="py-toggle" href="#" id="ProgressBar.__init__-toggle" onclick="return toggle('ProgressBar.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">nbops</tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">=</tt><tt class="py-number">20</tt><tt class="py-op">,</tt> <tt class="py-param">stream</tt><tt class="py-op">=</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar.__init__-expanded"><a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">title</tt><tt class="py-op">:</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fstr</tt> <tt class="py-op">=</tt> <tt class="py-string">'\r%s [%%-%ss]'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">title</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">size</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fstr</tt> <tt class="py-op">=</tt> <tt class="py-string">'\r[%%-%ss]'</tt> <tt class="py-op">%</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">size</tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_stream</tt> <tt class="py-op">=</tt> <tt class="py-name">stream</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_total</tt> <tt class="py-op">=</tt> <tt class="py-name">nbops</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt> <tt class="py-op">=</tt> <tt class="py-name">size</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_progress</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current_text</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_text_write_size</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
</div><a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> </tt>
<a name="ProgressBar._get_text"></a><div id="ProgressBar._get_text-def"><a name="L255"></a><tt class="py-lineno">255</tt> <a class="py-toggle" href="#" id="ProgressBar._get_text-toggle" onclick="return toggle('ProgressBar._get_text');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#_get_text">_get_text</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar._get_text-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar._get_text-expanded"><a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current_text</tt> </tt>
</div><a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> </tt>
<a name="ProgressBar._set_text"></a><div id="ProgressBar._set_text-def"><a name="L258"></a><tt class="py-lineno">258</tt> <a class="py-toggle" href="#" id="ProgressBar._set_text-toggle" onclick="return toggle('ProgressBar._set_text');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#_set_text">_set_text</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar._set_text-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar._set_text-expanded"><a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-36" class="py-name" targets="Variable logilab.common.shellutils.ProgressBar.text=logilab.common.shellutils.ProgressBar-class.html#text"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-36', 'text', 'link-36');">text</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current_text</tt><tt class="py-op">:</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current_text</tt> <tt class="py-op">=</tt> <tt id="link-37" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-37', 'text', 'link-36');">text</a></tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name" targets="Method logilab.common.shellutils.DummyProgressBar.refresh()=logilab.common.shellutils.DummyProgressBar-class.html#refresh,Method logilab.common.shellutils.ProgressBar.refresh()=logilab.common.shellutils.ProgressBar-class.html#refresh"><a title="logilab.common.shellutils.DummyProgressBar.refresh
logilab.common.shellutils.ProgressBar.refresh" class="py-name" href="#" onclick="return doclink('link-38', 'refresh', 'link-38');">refresh</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> </tt>
<a name="ProgressBar._del_text"></a><div id="ProgressBar._del_text-def"><a name="L263"></a><tt class="py-lineno">263</tt> <a class="py-toggle" href="#" id="ProgressBar._del_text-toggle" onclick="return toggle('ProgressBar._del_text');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#_del_text">_del_text</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar._del_text-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar._del_text-expanded"><a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-39', 'text', 'link-36');">text</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt id="link-40" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-40', 'text', 'link-36');">text</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt class="py-name">_get_text</tt><tt class="py-op">,</tt> <tt class="py-name">_set_text</tt><tt class="py-op">,</tt> <tt class="py-name">_del_text</tt><tt class="py-op">)</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> </tt>
<a name="ProgressBar.update"></a><div id="ProgressBar.update-def"><a name="L268"></a><tt class="py-lineno">268</tt> <a class="py-toggle" href="#" id="ProgressBar.update-toggle" onclick="return toggle('ProgressBar.update');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#update">update</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">offset</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">exact</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar.update-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar.update-expanded"><a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-docstring">"""Move FORWARD to new cursor position (cursor will never go backward).</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"> :offset: fraction of ``size``</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> :exact:</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> - False: offset relative to current cursor position if True</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> - True: offset as an asbsolute position</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">exact</tt><tt class="py-op">:</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current</tt> <tt class="py-op">=</tt> <tt class="py-name">offset</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current</tt> <tt class="py-op">+=</tt> <tt class="py-name">offset</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt id="link-41" class="py-name" targets="Class logilab.common.shellutils.progress=logilab.common.shellutils.progress-class.html"><a title="logilab.common.shellutils.progress" class="py-name" href="#" onclick="return doclink('link-41', 'progress', 'link-41');">progress</a></tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current</tt><tt class="py-op">)</tt><tt class="py-op">/</tt><tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_total</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">*</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-42" class="py-name"><a title="logilab.common.shellutils.progress" class="py-name" href="#" onclick="return doclink('link-42', 'progress', 'link-41');">progress</a></tt> <tt class="py-op">></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_progress</tt><tt class="py-op">:</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_progress</tt> <tt class="py-op">=</tt> <tt id="link-43" class="py-name"><a title="logilab.common.shellutils.progress" class="py-name" href="#" onclick="return doclink('link-43', 'progress', 'link-41');">progress</a></tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="logilab.common.shellutils.DummyProgressBar.refresh
logilab.common.shellutils.ProgressBar.refresh" class="py-name" href="#" onclick="return doclink('link-44', 'refresh', 'link-38');">refresh</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> </tt>
<a name="ProgressBar.refresh"></a><div id="ProgressBar.refresh-def"><a name="L289"></a><tt class="py-lineno">289</tt> <a class="py-toggle" href="#" id="ProgressBar.refresh-toggle" onclick="return toggle('ProgressBar.refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#refresh">refresh</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar.refresh-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar.refresh-expanded"><a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-docstring">"""Refresh the progression bar display."""</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_stream</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="logilab.common.changelog.ChangeLog.write
logilab.common.changelog.ChangeLogEntry.write
logilab.common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-45', 'write', 'link-29');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fstr</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">'='</tt> <tt class="py-op">*</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_progress</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_size</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_text_write_size</tt> <tt class="py-keyword">or</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current_text</tt><tt class="py-op">:</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-name">template</tt> <tt class="py-op">=</tt> <tt class="py-string">' %%-%is'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_text_write_size</tt><tt class="py-op">)</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt id="link-46" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-46', 'text', 'link-36');">text</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_current_text</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-47" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-47', 'text', 'link-36');">text</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt id="link-48" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-48', 'text', 'link-36');">text</a></tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_stream</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="logilab.common.changelog.ChangeLog.write
logilab.common.changelog.ChangeLogEntry.write
logilab.common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-49', 'write', 'link-29');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">template</tt> <tt class="py-op">%</tt> <tt id="link-50" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-50', 'text', 'link-36');">text</a></tt><tt class="py-op">)</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_text_write_size</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-51" class="py-name"><a title="logilab.common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-51', 'text', 'link-36');">text</a></tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_stream</tt><tt class="py-op">.</tt><tt class="py-name">flush</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> </tt>
<a name="ProgressBar.finish"></a><div id="ProgressBar.finish-def"><a name="L301"></a><tt class="py-lineno">301</tt> <a class="py-toggle" href="#" id="ProgressBar.finish-toggle" onclick="return toggle('ProgressBar.finish');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.ProgressBar-class.html#finish">finish</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProgressBar.finish-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProgressBar.finish-expanded"><a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_stream</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="logilab.common.changelog.ChangeLog.write
logilab.common.changelog.ChangeLogEntry.write
logilab.common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-52', 'write', 'link-29');">write</a></tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_stream</tt><tt class="py-op">.</tt><tt class="py-name">flush</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"> </tt>
<a name="DummyProgressBar"></a><div id="DummyProgressBar-def"><a name="L306"></a><tt class="py-lineno">306</tt> <a class="py-toggle" href="#" id="DummyProgressBar-toggle" onclick="return toggle('DummyProgressBar');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.DummyProgressBar-class.html">DummyProgressBar</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DummyProgressBar-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="DummyProgressBar-expanded"><a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt id="link-53" class="py-name" targets="Variable logilab.common.shellutils.DummyProgressBar.__slot__=logilab.common.shellutils.DummyProgressBar-class.html#__slot__"><a title="logilab.common.shellutils.DummyProgressBar.__slot__" class="py-name" href="#" onclick="return doclink('link-53', '__slot__', 'link-53');">__slot__</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'text'</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> </tt>
<a name="DummyProgressBar.refresh"></a><div id="DummyProgressBar.refresh-def"><a name="L309"></a><tt class="py-lineno">309</tt> <a class="py-toggle" href="#" id="DummyProgressBar.refresh-toggle" onclick="return toggle('DummyProgressBar.refresh');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.DummyProgressBar-class.html#refresh">refresh</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DummyProgressBar.refresh-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DummyProgressBar.refresh-expanded"><a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="DummyProgressBar.update"></a><div id="DummyProgressBar.update-def"><a name="L311"></a><tt class="py-lineno">311</tt> <a class="py-toggle" href="#" id="DummyProgressBar.update-toggle" onclick="return toggle('DummyProgressBar.update');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.DummyProgressBar-class.html#update">update</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DummyProgressBar.update-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DummyProgressBar.update-expanded"><a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="DummyProgressBar.finish"></a><div id="DummyProgressBar.finish-def"><a name="L313"></a><tt class="py-lineno">313</tt> <a class="py-toggle" href="#" id="DummyProgressBar.finish-toggle" onclick="return toggle('DummyProgressBar.finish');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.DummyProgressBar-class.html#finish">finish</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DummyProgressBar.finish-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DummyProgressBar.finish-expanded"><a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div></div><a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"><tt id="link-54" class="py-name" targets="Variable logilab.common.shellutils._MARKER=logilab.common.shellutils-module.html#_MARKER"><a title="logilab.common.shellutils._MARKER" class="py-name" href="#" onclick="return doclink('link-54', '_MARKER', 'link-54');">_MARKER</a></tt> <tt class="py-op">=</tt> <tt class="py-name">object</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="progress"></a><div id="progress-def"><a name="L318"></a><tt class="py-lineno">318</tt> <a class="py-toggle" href="#" id="progress-toggle" onclick="return toggle('progress');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.progress-class.html">progress</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="progress-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="progress-expanded"><a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"> </tt>
<a name="progress.__init__"></a><div id="progress.__init__-def"><a name="L320"></a><tt class="py-lineno">320</tt> <a class="py-toggle" href="#" id="progress.__init__-toggle" onclick="return toggle('progress.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.progress-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">nbops</tt><tt class="py-op">=</tt><tt id="link-55" class="py-name"><a title="logilab.common.shellutils._MARKER" class="py-name" href="#" onclick="return doclink('link-55', '_MARKER', 'link-54');">_MARKER</a></tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">=</tt><tt id="link-56" class="py-name"><a title="logilab.common.shellutils._MARKER" class="py-name" href="#" onclick="return doclink('link-56', '_MARKER', 'link-54');">_MARKER</a></tt><tt class="py-op">,</tt> <tt class="py-param">stream</tt><tt class="py-op">=</tt><tt id="link-57" class="py-name"><a title="logilab.common.shellutils._MARKER" class="py-name" href="#" onclick="return doclink('link-57', '_MARKER', 'link-54');">_MARKER</a></tt><tt class="py-op">,</tt> <tt class="py-param">title</tt><tt class="py-op">=</tt><tt id="link-58" class="py-name"><a title="logilab.common.shellutils._MARKER" class="py-name" href="#" onclick="return doclink('link-58', '_MARKER', 'link-54');">_MARKER</a></tt><tt class="py-op">,</tt> <tt class="py-param">enabled</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="progress.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="progress.__init__-expanded"><a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">nbops</tt> <tt class="py-op">=</tt> <tt class="py-name">nbops</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">size</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stream</tt> <tt class="py-op">=</tt> <tt class="py-name">stream</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">title</tt> <tt class="py-op">=</tt> <tt class="py-name">title</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">enabled</tt> <tt class="py-op">=</tt> <tt class="py-name">enabled</tt> </tt>
</div><a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> </tt>
<a name="progress.__enter__"></a><div id="progress.__enter__-def"><a name="L327"></a><tt class="py-lineno">327</tt> <a class="py-toggle" href="#" id="progress.__enter__-toggle" onclick="return toggle('progress.__enter__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.progress-class.html#__enter__">__enter__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="progress.__enter__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="progress.__enter__-expanded"><a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">enabled</tt><tt class="py-op">:</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">attr</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'nbops'</tt><tt class="py-op">,</tt> <tt class="py-string">'size'</tt><tt class="py-op">,</tt> <tt class="py-string">'stream'</tt><tt class="py-op">,</tt> <tt class="py-string">'title'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">attr</tt><tt class="py-op">)</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-59" class="py-name"><a title="logilab.common.shellutils._MARKER" class="py-name" href="#" onclick="return doclink('link-59', '_MARKER', 'link-54');">_MARKER</a></tt><tt class="py-op">:</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt><tt class="py-op">[</tt><tt class="py-name">attr</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pb</tt> <tt class="py-op">=</tt> <tt id="link-60" class="py-name" targets="Class logilab.common.shellutils.ProgressBar=logilab.common.shellutils.ProgressBar-class.html"><a title="logilab.common.shellutils.ProgressBar" class="py-name" href="#" onclick="return doclink('link-60', 'ProgressBar', 'link-60');">ProgressBar</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pb</tt> <tt class="py-op">=</tt> <tt id="link-61" class="py-name" targets="Class logilab.common.shellutils.DummyProgressBar=logilab.common.shellutils.DummyProgressBar-class.html"><a title="logilab.common.shellutils.DummyProgressBar" class="py-name" href="#" onclick="return doclink('link-61', 'DummyProgressBar', 'link-61');">DummyProgressBar</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pb</tt> </tt>
</div><a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> </tt>
<a name="progress.__exit__"></a><div id="progress.__exit__-def"><a name="L339"></a><tt class="py-lineno">339</tt> <a class="py-toggle" href="#" id="progress.__exit__-toggle" onclick="return toggle('progress.__exit__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.progress-class.html#__exit__">__exit__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">exc_type</tt><tt class="py-op">,</tt> <tt class="py-param">exc_val</tt><tt class="py-op">,</tt> <tt class="py-param">exc_tb</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="progress.__exit__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="progress.__exit__-expanded"><a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pb</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name" targets="Method logilab.common.shellutils.DummyProgressBar.finish()=logilab.common.shellutils.DummyProgressBar-class.html#finish,Method logilab.common.shellutils.ProgressBar.finish()=logilab.common.shellutils.ProgressBar-class.html#finish"><a title="logilab.common.shellutils.DummyProgressBar.finish
logilab.common.shellutils.ProgressBar.finish" class="py-name" href="#" onclick="return doclink('link-62', 'finish', 'link-62');">finish</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"> </tt>
<a name="RawInput"></a><div id="RawInput-def"><a name="L342"></a><tt class="py-lineno">342</tt> <a class="py-toggle" href="#" id="RawInput-toggle" onclick="return toggle('RawInput');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.shellutils.RawInput-class.html">RawInput</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RawInput-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="RawInput-expanded"><a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> </tt>
<a name="RawInput.__init__"></a><div id="RawInput.__init__-def"><a name="L344"></a><tt class="py-lineno">344</tt> <a class="py-toggle" href="#" id="RawInput.__init__-toggle" onclick="return toggle('RawInput.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.RawInput-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">input</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">printer</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RawInput.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RawInput.__init__-expanded"><a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_input</tt> <tt class="py-op">=</tt> <tt class="py-name">input</tt> <tt class="py-keyword">or</tt> <tt class="py-name">raw_input</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_print</tt> <tt class="py-op">=</tt> <tt class="py-name">printer</tt> </tt>
</div><a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> </tt>
<a name="RawInput.ask"></a><div id="RawInput.ask-def"><a name="L348"></a><tt class="py-lineno">348</tt> <a class="py-toggle" href="#" id="RawInput.ask-toggle" onclick="return toggle('RawInput.ask');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.RawInput-class.html#ask">ask</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">question</tt><tt class="py-op">,</tt> <tt class="py-param">options</tt><tt class="py-op">,</tt> <tt class="py-param">default</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RawInput.ask-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RawInput.ask-expanded"><a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">default</tt> <tt class="py-keyword">in</tt> <tt id="link-63" class="py-name" targets="Variable logilab.common.configuration.OptionsProviderMixIn.options=logilab.common.configuration.OptionsProviderMixIn-class.html#options"><a title="logilab.common.configuration.OptionsProviderMixIn.options" class="py-name" href="#" onclick="return doclink('link-63', 'options', 'link-63');">options</a></tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> <tt class="py-name">choices</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">option</tt> <tt class="py-keyword">in</tt> <tt id="link-64" class="py-name"><a title="logilab.common.configuration.OptionsProviderMixIn.options" class="py-name" href="#" onclick="return doclink('link-64', 'options', 'link-63');">options</a></tt><tt class="py-op">:</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">option</tt> <tt class="py-op">==</tt> <tt class="py-name">default</tt><tt class="py-op">:</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> <tt class="py-name">label</tt> <tt class="py-op">=</tt> <tt class="py-name">option</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> <tt class="py-name">label</tt> <tt class="py-op">=</tt> <tt class="py-name">option</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">option</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt class="py-name">label</tt> <tt class="py-op">+=</tt> <tt class="py-string">'(%s)'</tt> <tt class="py-op">%</tt> <tt class="py-name">option</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> <tt class="py-name">choices</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name" targets="Method logilab.common.tree.ListNode.append()=logilab.common.tree.ListNode-class.html#append,Method logilab.common.tree.Node.append()=logilab.common.tree.Node-class.html#append,Method logilab.common.ureports.nodes.BaseLayout.append()=logilab.common.ureports.nodes.BaseLayout-class.html#append"><a title="logilab.common.tree.ListNode.append
logilab.common.tree.Node.append
logilab.common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-65', 'append', 'link-65');">append</a></tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">option</tt><tt class="py-op">,</tt> <tt class="py-name">label</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"> <tt class="py-name">prompt</tt> <tt class="py-op">=</tt> <tt class="py-string">"%s [%s]: "</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">question</tt><tt class="py-op">,</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> <tt class="py-string">'/'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">opt</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">for</tt> <tt class="py-name">opt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">choices</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"> <tt class="py-name">tries</tt> <tt class="py-op">=</tt> <tt class="py-number">3</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">tries</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"> <tt class="py-name">answer</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_input</tt><tt class="py-op">(</tt><tt class="py-name">prompt</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">answer</tt><tt class="py-op">:</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">default</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> <tt class="py-name">possible</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">option</tt> <tt class="py-keyword">for</tt> <tt class="py-name">option</tt><tt class="py-op">,</tt> <tt class="py-name">label</tt> <tt class="py-keyword">in</tt> <tt class="py-name">choices</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">option</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-name">answer</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">possible</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">possible</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">possible</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s is not an option.'</tt> <tt class="py-op">%</tt> <tt class="py-name">answer</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'%s is an ambiguous answer, do you mean %s ?'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"> <tt class="py-name">answer</tt><tt class="py-op">,</tt> <tt class="py-string">' or '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">possible</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_print</tt><tt class="py-op">:</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_print</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"> <tt class="py-keyword">print</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"> <tt class="py-name">tries</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'unable to get a sensible answer'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"> </tt>
<a name="RawInput.confirm"></a><div id="RawInput.confirm-def"><a name="L382"></a><tt class="py-lineno">382</tt> <a class="py-toggle" href="#" id="RawInput.confirm-toggle" onclick="return toggle('RawInput.confirm');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils.RawInput-class.html#confirm">confirm</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">question</tt><tt class="py-op">,</tt> <tt class="py-param">default_is_yes</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RawInput.confirm-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RawInput.confirm-expanded"><a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"> <tt class="py-name">default</tt> <tt class="py-op">=</tt> <tt class="py-name">default_is_yes</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'y'</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'n'</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"> <tt class="py-name">answer</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name" targets="Method logilab.common.shellutils.RawInput.ask()=logilab.common.shellutils.RawInput-class.html#ask"><a title="logilab.common.shellutils.RawInput.ask" class="py-name" href="#" onclick="return doclink('link-66', 'ask', 'link-66');">ask</a></tt><tt class="py-op">(</tt><tt class="py-name">question</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-string">'y'</tt><tt class="py-op">,</tt> <tt class="py-string">'n'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">default</tt><tt class="py-op">)</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">answer</tt> <tt class="py-op">==</tt> <tt class="py-string">'y'</tt> </tt>
</div></div><a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"><tt id="link-67" class="py-name" targets="Variable logilab.common.shellutils.ASK=logilab.common.shellutils-module.html#ASK"><a title="logilab.common.shellutils.ASK" class="py-name" href="#" onclick="return doclink('link-67', 'ASK', 'link-67');">ASK</a></tt> <tt class="py-op">=</tt> <tt id="link-68" class="py-name" targets="Class logilab.common.shellutils.RawInput=logilab.common.shellutils.RawInput-class.html"><a title="logilab.common.shellutils.RawInput" class="py-name" href="#" onclick="return doclink('link-68', 'RawInput', 'link-68');">RawInput</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"> </tt>
<a name="getlogin"></a><div id="getlogin-def"><a name="L390"></a><tt class="py-lineno">390</tt> <a class="py-toggle" href="#" id="getlogin-toggle" onclick="return toggle('getlogin');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#getlogin">getlogin</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getlogin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getlogin-expanded"><a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"> <tt class="py-docstring">"""avoid using os.getlogin() because of strange tty / stdin problems</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"><tt class="py-docstring"> (man 3 getlogin)</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"><tt class="py-docstring"> Another solution would be to use $LOGNAME, $USER or $USERNAME</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">platform</tt> <tt class="py-op">!=</tt> <tt class="py-string">'win32'</tt><tt class="py-op">:</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">pwd</tt> <tt class="py-comment"># Platforms: Unix</tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">pwd</tt><tt class="py-op">.</tt><tt class="py-name">getpwuid</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">getuid</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">environ</tt><tt class="py-op">[</tt><tt class="py-string">'USERNAME'</tt><tt class="py-op">]</tt> </tt>
</div><a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"> </tt>
<a name="generate_password"></a><div id="generate_password-def"><a name="L401"></a><tt class="py-lineno">401</tt> <a class="py-toggle" href="#" id="generate_password-toggle" onclick="return toggle('generate_password');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.shellutils-module.html#generate_password">generate_password</a><tt class="py-op">(</tt><tt class="py-param">length</tt><tt class="py-op">=</tt><tt class="py-number">8</tt><tt class="py-op">,</tt> <tt class="py-param">vocab</tt><tt class="py-op">=</tt><tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">ascii_letters</tt> <tt class="py-op">+</tt> <tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">digits</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="generate_password-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="generate_password-expanded"><a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> <tt class="py-docstring">"""dumb password generation function"""</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"> <tt class="py-name">pwd</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"> <tt class="py-name">pwd</tt> <tt class="py-op">+=</tt> <tt class="py-name">random</tt><tt class="py-op">.</tt><tt class="py-name">choice</tt><tt class="py-op">(</tt><tt class="py-name">vocab</tt><tt class="py-op">)</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">pwd</tt> </tt>
</div><a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="logilab.common-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Logilab's common library</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
on Sun Jan 17 22:12:20 2016
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|