/usr/share/doc/python-logilab-common/apidoc/common.textutils-pysrc.html is in python-logilab-common 0.61.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 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 | <?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>common.textutils</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="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">
<a href="common-module.html">Package common</a> ::
Module textutils
</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="common.textutils-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="common.textutils-module.html">Module common.textutils</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-2011 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">"""Some text manipulation utility functions.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring"></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 class="py-docstring">:group text formatting: normalize_text, normalize_paragraph, pretty_match,\</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">unquote, colorize_ansi</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring">:group text manipulation: searchall, splitstrip</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">:sort: text formatting, text manipulation</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring">:type ANSI_STYLES: dict(str)</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring">:var ANSI_STYLES: dictionary mapping style identifier to ANSI terminal code</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring">:type ANSI_COLORS: dict(str)</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring">:var ANSI_COLORS: dictionary mapping color identifier to ANSI terminal code</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring">:type ANSI_PREFIX: str</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring">:var ANSI_PREFIX:</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> ANSI terminal code notifying the start of an ANSI escape sequence</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring">:type ANSI_END: str</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring">:var ANSI_END:</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> ANSI terminal code notifying the end of an ANSI escape sequence</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring">:type ANSI_RESET: str</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring">:var ANSI_RESET:</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> ANSI terminal code resetting format defined by a previous ANSI escape sequence</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</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="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> <tt class="py-keyword">as</tt> <tt class="py-name">osp</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">warnings</tt> <tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Method common.deprecation.DeprecationManager.warn()=common.deprecation.DeprecationManager-class.html#warn"><a title="common.deprecation.DeprecationManager.warn" class="py-name" href="#" onclick="return doclink('link-0', 'warn', 'link-0');">warn</a></tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">unicodedata</tt> <tt class="py-keyword">import</tt> <tt class="py-name">normalize</tt> <tt class="py-keyword">as</tt> <tt class="py-name">_uninormalize</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-keyword">try</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">from</tt> <tt class="py-name">os</tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Variable common.textutils.linesep=common.textutils-module.html#linesep"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-1', 'linesep', 'link-1');">linesep</a></tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt id="link-2" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-2', 'linesep', 'link-1');">linesep</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt> <tt class="py-comment"># gae</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</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" targets="Package common=common-module.html"><a title="common" class="py-name" href="#" onclick="return doclink('link-3', 'common', 'link-3');">common</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module common.deprecation=common.deprecation-module.html"><a title="common.deprecation" class="py-name" href="#" onclick="return doclink('link-4', 'deprecation', 'link-4');">deprecation</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Method common.deprecation.DeprecationManager.deprecated()=common.deprecation.DeprecationManager-class.html#deprecated,Function common.deprecation.deprecated()=common.deprecation-module.html#deprecated"><a title="common.deprecation.DeprecationManager.deprecated
common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-5', 'deprecated', 'link-5');">deprecated</a></tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt id="link-6" class="py-name" targets="Variable common.textutils.MANUAL_UNICODE_MAP=common.textutils-module.html#MANUAL_UNICODE_MAP"><a title="common.textutils.MANUAL_UNICODE_MAP" class="py-name" href="#" onclick="return doclink('link-6', 'MANUAL_UNICODE_MAP', 'link-6');">MANUAL_UNICODE_MAP</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-string">'\xa1'</tt><tt class="py-op">:</tt> <tt class="py-string">'!'</tt><tt class="py-op">,</tt> <tt class="py-comment"># INVERTED EXCLAMATION MARK</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-string">'\u0142'</tt><tt class="py-op">:</tt> <tt class="py-string">'l'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN SMALL LETTER L WITH STROKE</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-string">'\u2044'</tt><tt class="py-op">:</tt> <tt class="py-string">'/'</tt><tt class="py-op">,</tt> <tt class="py-comment"># FRACTION SLASH</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> <tt class="py-string">'\xc6'</tt><tt class="py-op">:</tt> <tt class="py-string">'AE'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN CAPITAL LETTER AE</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-string">'\xa9'</tt><tt class="py-op">:</tt> <tt class="py-string">'(c)'</tt><tt class="py-op">,</tt> <tt class="py-comment"># COPYRIGHT SIGN</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-string">'\xab'</tt><tt class="py-op">:</tt> <tt class="py-string">'"'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LEFT-POINTING DOUBLE ANGLE QUOTATION MARK</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-string">'\xe6'</tt><tt class="py-op">:</tt> <tt class="py-string">'ae'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN SMALL LETTER AE</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-string">'\xae'</tt><tt class="py-op">:</tt> <tt class="py-string">'(r)'</tt><tt class="py-op">,</tt> <tt class="py-comment"># REGISTERED SIGN</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-string">'\u0153'</tt><tt class="py-op">:</tt> <tt class="py-string">'oe'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN SMALL LIGATURE OE</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-string">'\u0152'</tt><tt class="py-op">:</tt> <tt class="py-string">'OE'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN CAPITAL LIGATURE OE</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-string">'\xd8'</tt><tt class="py-op">:</tt> <tt class="py-string">'O'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN CAPITAL LETTER O WITH STROKE</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-string">'\xf8'</tt><tt class="py-op">:</tt> <tt class="py-string">'o'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN SMALL LETTER O WITH STROKE</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-string">'\xbb'</tt><tt class="py-op">:</tt> <tt class="py-string">'"'</tt><tt class="py-op">,</tt> <tt class="py-comment"># RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-string">'\xdf'</tt><tt class="py-op">:</tt> <tt class="py-string">'ss'</tt><tt class="py-op">,</tt> <tt class="py-comment"># LATIN SMALL LETTER SHARP S</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> </tt>
<a name="unormalize"></a><div id="unormalize-def"><a name="L75"></a><tt class="py-lineno"> 75</tt> <a class="py-toggle" href="#" id="unormalize-toggle" onclick="return toggle('unormalize');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#unormalize">unormalize</a><tt class="py-op">(</tt><tt class="py-param">ustring</tt><tt class="py-op">,</tt> <tt class="py-param">ignorenonascii</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">substitute</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="unormalize-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="unormalize-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-docstring">"""replace diacritical characters with their corresponding ascii characters</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> Convert the unicode string to its long normalized form (unicode character</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> will be transform into several characters) and keep the first one only.</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> The normal form KD (NFKD) will apply the compatibility decomposition, i.e.</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> replace all compatibility characters with their equivalents.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> :type substitute: str</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> :param substitute: replacement character to use if decomposition fails</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> :see: Another project about ASCII transliterations of Unicode text</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> http://pypi.python.org/pypi/Unidecode</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-comment"># backward compatibility, ignorenonascii was a boolean</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ignorenonascii</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt id="link-7" class="py-name"><a title="common.deprecation.DeprecationManager.warn" class="py-name" href="#" onclick="return doclink('link-7', 'warn', 'link-0');">warn</a></tt><tt class="py-op">(</tt><tt class="py-string">"ignorenonascii is deprecated, use substitute named parameter instead"</tt><tt class="py-op">,</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-name">DeprecationWarning</tt><tt class="py-op">,</tt> <tt class="py-name">stacklevel</tt><tt class="py-op">=</tt><tt class="py-number">2</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">if</tt> <tt class="py-name">ignorenonascii</tt><tt class="py-op">:</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-name">substitute</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">letter</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ustring</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">replacement</tt> <tt class="py-op">=</tt> <tt id="link-8" class="py-name"><a title="common.textutils.MANUAL_UNICODE_MAP" class="py-name" href="#" onclick="return doclink('link-8', 'MANUAL_UNICODE_MAP', 'link-6');">MANUAL_UNICODE_MAP</a></tt><tt class="py-op">[</tt><tt class="py-name">letter</tt><tt class="py-op">]</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-name">replacement</tt> <tt class="py-op">=</tt> <tt class="py-name">_uninormalize</tt><tt class="py-op">(</tt><tt class="py-string">'NFKD'</tt><tt class="py-op">,</tt> <tt class="py-name">letter</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="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ord</tt><tt class="py-op">(</tt><tt class="py-name">replacement</tt><tt class="py-op">)</tt> <tt class="py-op">>=</tt> <tt class="py-number">2</tt> <tt class="py-op">**</tt> <tt class="py-number">7</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">if</tt> <tt class="py-name">substitute</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</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">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"can't deal with non-ascii based characters"</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">replacement</tt> <tt class="py-op">=</tt> <tt class="py-name">substitute</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method common.tree.ListNode.append()=common.tree.ListNode-class.html#append,Method common.tree.Node.append()=common.tree.Node-class.html#append,Method common.ureports.nodes.BaseLayout.append()=common.ureports.nodes.BaseLayout-class.html#append"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-9', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">replacement</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">return</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">res</tt><tt class="py-op">)</tt> </tt>
</div><a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> </tt>
<a name="unquote"></a><div id="unquote-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="unquote-toggle" onclick="return toggle('unquote');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#unquote">unquote</a><tt class="py-op">(</tt><tt class="py-param">string</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="unquote-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="unquote-expanded"><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-docstring">"""remove optional quotes (simple or double) from the string</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> :type string: str or unicode</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> :param string: an optionally quoted string</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> :return: the unquoted string (or the input string if it wasn't quoted)</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">string</tt><tt class="py-op">:</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">string</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-string">'"\''</tt><tt class="py-op">:</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-string">'"\''</tt><tt class="py-op">:</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">[</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="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">string</tt> </tt>
</div><a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt id="link-10" class="py-name" targets="Variable common.textutils._BLANKLINES_RGX=common.textutils-module.html#_BLANKLINES_RGX"><a title="common.textutils._BLANKLINES_RGX" class="py-name" href="#" onclick="return doclink('link-10', '_BLANKLINES_RGX', 'link-10');">_BLANKLINES_RGX</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'\r?\n\r?\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable common.textutils._NORM_SPACES_RGX=common.textutils-module.html#_NORM_SPACES_RGX"><a title="common.textutils._NORM_SPACES_RGX" class="py-name" href="#" onclick="return doclink('link-11', '_NORM_SPACES_RGX', 'link-11');">_NORM_SPACES_RGX</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'\s+'</tt><tt class="py-op">)</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> </tt>
<a name="normalize_text"></a><div id="normalize_text-def"><a name="L129"></a><tt class="py-lineno">129</tt> <a class="py-toggle" href="#" id="normalize_text-toggle" onclick="return toggle('normalize_text');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#normalize_text">normalize_text</a><tt class="py-op">(</tt><tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">line_len</tt><tt class="py-op">=</tt><tt class="py-number">80</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-param">rest</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="normalize_text-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="normalize_text-expanded"><a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-docstring">"""normalize a text to display it with a maximum line size and</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> optionally arbitrary indentation. Line jumps are normalized but blank</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> lines are kept. The indentation string may be used to insert a</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> comment (#) or a quoting (>) mark for instance.</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> :type text: str or unicode</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> :param text: the input text to normalize</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 line_len: int</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"><tt class="py-docstring"> :param line_len: expected maximum line's length, default to 80</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"><tt class="py-docstring"> :type indent: str or unicode</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"><tt class="py-docstring"> :param indent: optional string to use as indentation</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"> :return:</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> the input text normalized to fit on lines with a maximized size</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> inferior to `line_len`, and optionally prefixed by an</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> indentation string</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rest</tt><tt class="py-op">:</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> <tt class="py-name">normp</tt> <tt class="py-op">=</tt> <tt id="link-12" class="py-name" targets="Function common.textutils.normalize_rest_paragraph()=common.textutils-module.html#normalize_rest_paragraph"><a title="common.textutils.normalize_rest_paragraph" class="py-name" href="#" onclick="return doclink('link-12', 'normalize_rest_paragraph', 'link-12');">normalize_rest_paragraph</a></tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-name">normp</tt> <tt class="py-op">=</tt> <tt id="link-13" class="py-name" targets="Function common.textutils.normalize_paragraph()=common.textutils-module.html#normalize_paragraph"><a title="common.textutils.normalize_paragraph" class="py-name" href="#" onclick="return doclink('link-13', 'normalize_paragraph', 'link-13');">normalize_paragraph</a></tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-14" class="py-name" targets="Variable common.shellutils.ProgressBar.text=common.shellutils.ProgressBar-class.html#text"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-14', 'text', 'link-14');">text</a></tt> <tt class="py-keyword">in</tt> <tt id="link-15" class="py-name"><a title="common.textutils._BLANKLINES_RGX" class="py-name" href="#" onclick="return doclink('link-15', '_BLANKLINES_RGX', 'link-10');">_BLANKLINES_RGX</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-16" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-16', 'text', 'link-14');">text</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-17', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">normp</tt><tt class="py-op">(</tt><tt id="link-18" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-18', 'text', 'link-14');">text</a></tt><tt class="py-op">,</tt> <tt class="py-name">line_len</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-string">'%s%s%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-19" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-19', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> <tt id="link-20" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-20', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">)</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">result</tt><tt class="py-op">)</tt> </tt>
</div><a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> </tt>
<a name="normalize_paragraph"></a><div id="normalize_paragraph-def"><a name="L160"></a><tt class="py-lineno">160</tt> <a class="py-toggle" href="#" id="normalize_paragraph-toggle" onclick="return toggle('normalize_paragraph');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#normalize_paragraph">normalize_paragraph</a><tt class="py-op">(</tt><tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">line_len</tt><tt class="py-op">=</tt><tt class="py-number">80</tt><tt class="py-op">,</tt> <tt class="py-param">indent</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="normalize_paragraph-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="normalize_paragraph-expanded"><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-docstring">"""normalize a text to display it with a maximum line size and</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-docstring"> optionally arbitrary indentation. Line jumps are normalized. The</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"><tt class="py-docstring"> indentation string may be used top insert a comment mark for</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"><tt class="py-docstring"> instance.</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> :type text: str or unicode</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> :param text: the input text to normalize</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> :type line_len: int</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> :param line_len: expected maximum line's length, default to 80</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> :type indent: str or unicode</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> :param indent: optional string to use as indentation</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-docstring"> :return:</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> the input text normalized to fit on lines with a maximized size</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"> inferior to `line_len`, and optionally prefixed by an</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> indentation string</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt id="link-21" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-21', 'text', 'link-14');">text</a></tt> <tt class="py-op">=</tt> <tt id="link-22" class="py-name"><a title="common.textutils._NORM_SPACES_RGX" class="py-name" href="#" onclick="return doclink('link-22', '_NORM_SPACES_RGX', 'link-11');">_NORM_SPACES_RGX</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt id="link-23" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-23', 'text', 'link-14');">text</a></tt><tt class="py-op">)</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-name">line_len</tt> <tt class="py-op">=</tt> <tt class="py-name">line_len</tt> <tt class="py-op">-</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt id="link-24" class="py-name" targets="Function common.fileutils.lines()=common.fileutils-module.html#lines"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-24', 'lines', 'link-24');">lines</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt id="link-25" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-25', 'text', 'link-14');">text</a></tt><tt class="py-op">:</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-name">aline</tt><tt class="py-op">,</tt> <tt id="link-26" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-26', 'text', 'link-14');">text</a></tt> <tt class="py-op">=</tt> <tt id="link-27" class="py-name" targets="Function common.textutils.splittext()=common.textutils-module.html#splittext"><a title="common.textutils.splittext" class="py-name" href="#" onclick="return doclink('link-27', 'splittext', 'link-27');">splittext</a></tt><tt class="py-op">(</tt><tt id="link-28" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-28', 'text', 'link-14');">text</a></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">line_len</tt><tt class="py-op">)</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt id="link-29" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-29', 'lines', 'link-24');">lines</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-30', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-name">aline</tt><tt class="py-op">)</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-31" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-31', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-32" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-32', 'lines', 'link-24');">lines</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> </tt>
<a name="normalize_rest_paragraph"></a><div id="normalize_rest_paragraph-def"><a name="L189"></a><tt class="py-lineno">189</tt> <a class="py-toggle" href="#" id="normalize_rest_paragraph-toggle" onclick="return toggle('normalize_rest_paragraph');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#normalize_rest_paragraph">normalize_rest_paragraph</a><tt class="py-op">(</tt><tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">line_len</tt><tt class="py-op">=</tt><tt class="py-number">80</tt><tt class="py-op">,</tt> <tt class="py-param">indent</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="normalize_rest_paragraph-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="normalize_rest_paragraph-expanded"><a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-docstring">"""normalize a ReST text to display it with a maximum line size and</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-docstring"> optionally arbitrary indentation. Line jumps are normalized. The</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-docstring"> indentation string may be used top insert a comment mark for</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"> instance.</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"> :type text: str or unicode</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> :param text: the input text to normalize</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 line_len: int</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> :param line_len: expected maximum line's length, default to 80</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"> :type indent: str or unicode</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-docstring"> :param indent: optional string to use as indentation</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-docstring"> :return:</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"><tt class="py-docstring"> the input text normalized to fit on lines with a maximized size</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"><tt class="py-docstring"> inferior to `line_len`, and optionally prefixed by an</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"><tt class="py-docstring"> indentation string</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-name">toreport</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> <tt id="link-33" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-33', 'lines', 'link-24');">lines</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> <tt class="py-name">line_len</tt> <tt class="py-op">=</tt> <tt class="py-name">line_len</tt> <tt class="py-op">-</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt id="link-34" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-34', 'text', 'link-14');">text</a></tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-name">toreport</tt> <tt class="py-op">+</tt> <tt id="link-35" class="py-name"><a title="common.textutils._NORM_SPACES_RGX" class="py-name" href="#" onclick="return doclink('link-35', '_NORM_SPACES_RGX', 'link-11');">_NORM_SPACES_RGX</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">,</tt> <tt class="py-name">line</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>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-name">toreport</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">line_len</tt><tt class="py-op">:</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-comment"># too long line, need split</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">toreport</tt> <tt class="py-op">=</tt> <tt id="link-36" class="py-name"><a title="common.textutils.splittext" class="py-name" href="#" onclick="return doclink('link-36', 'splittext', 'link-27');">splittext</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">line_len</tt><tt class="py-op">)</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt id="link-37" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-37', 'lines', 'link-24');">lines</a></tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-38', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-name">line</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">if</tt> <tt class="py-name">toreport</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">line</tt> <tt class="py-op">=</tt> <tt class="py-name">toreport</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-name">toreport</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <tt class="py-name">line</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">:</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"> <tt id="link-39" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-39', 'lines', 'link-24');">lines</a></tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-40', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">indent</tt> <tt class="py-op">+</tt> <tt class="py-name">line</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>
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-41" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-41', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-42" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-42', 'lines', 'link-24');">lines</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> </tt>
<a name="splittext"></a><div id="splittext-def"><a name="L230"></a><tt class="py-lineno">230</tt> <a class="py-toggle" href="#" id="splittext-toggle" onclick="return toggle('splittext');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#splittext">splittext</a><tt class="py-op">(</tt><tt class="py-param">text</tt><tt class="py-op">,</tt> <tt class="py-param">line_len</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="splittext-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="splittext-expanded"><a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"> <tt class="py-docstring">"""split the given text on space according to the given max line size</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"> return a 2-uple:</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> * a line <= line_len if possible</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-docstring"> * the rest of the text which has to be reported on another line</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-43" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-43', 'text', 'link-14');">text</a></tt><tt class="py-op">)</tt> <tt class="py-op"><=</tt> <tt class="py-name">line_len</tt><tt class="py-op">:</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-44" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-44', 'text', 'link-14');">text</a></tt><tt class="py-op">,</tt> <tt class="py-string">''</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> <tt class="py-name">pos</tt> <tt class="py-op">=</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-45" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-45', 'text', 'link-14');">text</a></tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">line_len</tt><tt class="py-op">)</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">pos</tt> <tt class="py-op">></tt> <tt class="py-number">0</tt> <tt class="py-keyword">and</tt> <tt id="link-46" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-46', 'text', 'link-14');">text</a></tt><tt class="py-op">[</tt><tt class="py-name">pos</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">' '</tt><tt class="py-op">:</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt class="py-name">pos</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pos</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-name">pos</tt> <tt class="py-op">=</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-47" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-47', 'text', 'link-14');">text</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">line_len</tt><tt class="py-op">)</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-48" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-48', 'text', 'link-14');">text</a></tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">pos</tt> <tt class="py-keyword">and</tt> <tt id="link-49" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-49', 'text', 'link-14');">text</a></tt><tt class="py-op">[</tt><tt class="py-name">pos</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">' '</tt><tt class="py-op">:</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-name">pos</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-50" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-50', 'text', 'link-14');">text</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">pos</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-51" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-51', 'text', 'link-14');">text</a></tt><tt class="py-op">[</tt><tt class="py-name">pos</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">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> </tt>
<a name="splitstrip"></a><div id="splitstrip-def"><a name="L249"></a><tt class="py-lineno">249</tt> <a class="py-toggle" href="#" id="splitstrip-toggle" onclick="return toggle('splitstrip');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#splitstrip">splitstrip</a><tt class="py-op">(</tt><tt class="py-param">string</tt><tt class="py-op">,</tt> <tt class="py-param">sep</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="splitstrip-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="splitstrip-expanded"><a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-docstring">"""return a list of stripped string by splitting the string given as</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"><tt class="py-docstring"> argument on `sep` (',' by default). Empty string are discarded.</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"><tt class="py-docstring"> >>> splitstrip('a, b, c , 4,,')</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"><tt class="py-docstring"> ['a', 'b', 'c', '4']</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"><tt class="py-docstring"> >>> splitstrip('a')</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"><tt class="py-docstring"> ['a']</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-docstring"> :type string: str or unicode</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"> :param string: a csv line</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-docstring"> :type sep: str or unicode</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"><tt class="py-docstring"> :param sep: field separator, default to the comma (',')</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"><tt class="py-docstring"> :return: the unquoted string (or the input string if it wasn't quoted)</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">word</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-keyword">for</tt> <tt class="py-name">word</tt> <tt class="py-keyword">in</tt> <tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">sep</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> <tt class="py-name">word</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>
</div><a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt id="link-52" class="py-name" targets="Variable common.textutils.get_csv=common.textutils-module.html#get_csv"><a title="common.textutils.get_csv" class="py-name" href="#" onclick="return doclink('link-52', 'get_csv', 'link-52');">get_csv</a></tt> <tt class="py-op">=</tt> <tt id="link-53" class="py-name"><a title="common.deprecation.DeprecationManager.deprecated
common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-53', 'deprecated', 'link-5');">deprecated</a></tt><tt class="py-op">(</tt><tt class="py-string">'get_csv is deprecated, use splitstrip'</tt><tt class="py-op">)</tt><tt class="py-op">(</tt><tt id="link-54" class="py-name" targets="Function common.textutils.splitstrip()=common.textutils-module.html#splitstrip"><a title="common.textutils.splitstrip" class="py-name" href="#" onclick="return doclink('link-54', 'splitstrip', 'link-54');">splitstrip</a></tt><tt class="py-op">)</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> </tt>
<a name="split_url_or_path"></a><div id="split_url_or_path-def"><a name="L273"></a><tt class="py-lineno">273</tt> <a class="py-toggle" href="#" id="split_url_or_path-toggle" onclick="return toggle('split_url_or_path');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#split_url_or_path">split_url_or_path</a><tt class="py-op">(</tt><tt class="py-param">url_or_path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="split_url_or_path-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="split_url_or_path-expanded"><a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-docstring">"""return the latest component of a string containing either an url of the</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> form <scheme>://<path> or a local file system path</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'://'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">url_or_path</tt><tt class="py-op">:</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">url_or_path</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">rsplit</tt><tt class="py-op">(</tt><tt class="py-string">'/'</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">osp</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">url_or_path</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-name">osp</tt><tt class="py-op">.</tt><tt class="py-name">sep</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> </tt>
<a name="text_to_dict"></a><div id="text_to_dict-def"><a name="L282"></a><tt class="py-lineno">282</tt> <a class="py-toggle" href="#" id="text_to_dict-toggle" onclick="return toggle('text_to_dict');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#text_to_dict">text_to_dict</a><tt class="py-op">(</tt><tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="text_to_dict-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="text_to_dict-expanded"><a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-docstring">"""parse multilines text containing simple 'key=value' lines and return a</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"><tt class="py-docstring"> dict of {'key': 'value'}. When the same key is encountered multiple time,</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-docstring"> value is turned into a list containing all values.</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"><tt class="py-docstring"> >>> text_to_dict('''multiple=1</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"><tt class="py-docstring"> ... multiple= 2</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"><tt class="py-docstring"> ... single =3</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"><tt class="py-docstring"> ... ''')</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"><tt class="py-docstring"> {'single': '3', 'multiple': ['1', '2']}</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-55" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-55', 'text', 'link-14');">text</a></tt><tt class="py-op">:</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt id="link-56" class="py-name"><a title="common.shellutils.ProgressBar.text" class="py-name" href="#" onclick="return doclink('link-56', 'text', 'link-14');">text</a></tt><tt class="py-op">.</tt><tt class="py-name">splitlines</tt><tt class="py-op">(</tt><tt class="py-op">)</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">line</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">strip</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-keyword">if</tt> <tt class="py-name">line</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'#'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">w</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-keyword">for</tt> <tt class="py-name">w</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'='</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">key</tt> <tt class="py-keyword">in</tt> <tt class="py-name">res</tt><tt class="py-op">:</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-keyword">try</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">res</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-57', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">res</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">]</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">[</tt><tt class="py-name">key</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
</div><a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt id="link-58" class="py-name" targets="Variable common.textutils._BLANK_URE=common.textutils-module.html#_BLANK_URE"><a title="common.textutils._BLANK_URE" class="py-name" href="#" onclick="return doclink('link-58', '_BLANK_URE', 'link-58');">_BLANK_URE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">r'(\s|,)+'</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt id="link-59" class="py-name" targets="Variable common.textutils._BLANK_RE=common.textutils-module.html#_BLANK_RE"><a title="common.textutils._BLANK_RE" class="py-name" href="#" onclick="return doclink('link-59', '_BLANK_RE', 'link-59');">_BLANK_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt id="link-60" class="py-name"><a title="common.textutils._BLANK_URE" class="py-name" href="#" onclick="return doclink('link-60', '_BLANK_URE', 'link-58');">_BLANK_URE</a></tt><tt class="py-op">)</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"><tt id="link-61" class="py-name" targets="Variable common.textutils.__VALUE_URE=common.textutils-module.html#__VALUE_URE"><a title="common.textutils.__VALUE_URE" class="py-name" href="#" onclick="return doclink('link-61', '__VALUE_URE', 'link-61');">__VALUE_URE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">r'-?(([0-9]+\.[0-9]*)|((0x?)?[0-9]+))'</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"><tt id="link-62" class="py-name" targets="Variable common.textutils.__UNITS_URE=common.textutils-module.html#__UNITS_URE"><a title="common.textutils.__UNITS_URE" class="py-name" href="#" onclick="return doclink('link-62', '__UNITS_URE', 'link-62');">__UNITS_URE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">r'[a-zA-Z]+'</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"><tt id="link-63" class="py-name" targets="Variable common.textutils._VALUE_RE=common.textutils-module.html#_VALUE_RE"><a title="common.textutils._VALUE_RE" class="py-name" href="#" onclick="return doclink('link-63', '_VALUE_RE', 'link-63');">_VALUE_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'(?P<value>%s)(?P<unit>%s)?'</tt><tt class="py-op">%</tt><tt class="py-op">(</tt><tt id="link-64" class="py-name"><a title="common.textutils.__VALUE_URE" class="py-name" href="#" onclick="return doclink('link-64', '__VALUE_URE', 'link-61');">__VALUE_URE</a></tt><tt class="py-op">,</tt> <tt id="link-65" class="py-name"><a title="common.textutils.__UNITS_URE" class="py-name" href="#" onclick="return doclink('link-65', '__UNITS_URE', 'link-62');">__UNITS_URE</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"><tt id="link-66" class="py-name" targets="Variable common.textutils._VALIDATION_RE=common.textutils-module.html#_VALIDATION_RE"><a title="common.textutils._VALIDATION_RE" class="py-name" href="#" onclick="return doclink('link-66', '_VALIDATION_RE', 'link-66');">_VALIDATION_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r'^((%s)(%s))*(%s)?$'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-67" class="py-name"><a title="common.textutils.__VALUE_URE" class="py-name" href="#" onclick="return doclink('link-67', '__VALUE_URE', 'link-61');">__VALUE_URE</a></tt><tt class="py-op">,</tt> <tt id="link-68" class="py-name"><a title="common.textutils.__UNITS_URE" class="py-name" href="#" onclick="return doclink('link-68', '__UNITS_URE', 'link-62');">__UNITS_URE</a></tt><tt class="py-op">,</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> <tt id="link-69" class="py-name"><a title="common.textutils.__VALUE_URE" class="py-name" href="#" onclick="return doclink('link-69', '__VALUE_URE', 'link-61');">__VALUE_URE</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"><tt id="link-70" class="py-name" targets="Variable common.textutils.BYTE_UNITS=common.textutils-module.html#BYTE_UNITS"><a title="common.textutils.BYTE_UNITS" class="py-name" href="#" onclick="return doclink('link-70', 'BYTE_UNITS', 'link-70');">BYTE_UNITS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"> <tt class="py-string">"b"</tt><tt class="py-op">:</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"> <tt class="py-string">"kb"</tt><tt class="py-op">:</tt> <tt class="py-number">1024</tt><tt class="py-op">,</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> <tt class="py-string">"mb"</tt><tt class="py-op">:</tt> <tt class="py-number">1024</tt> <tt class="py-op">**</tt> <tt class="py-number">2</tt><tt class="py-op">,</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"> <tt class="py-string">"gb"</tt><tt class="py-op">:</tt> <tt class="py-number">1024</tt> <tt class="py-op">**</tt> <tt class="py-number">3</tt><tt class="py-op">,</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> <tt class="py-string">"tb"</tt><tt class="py-op">:</tt> <tt class="py-number">1024</tt> <tt class="py-op">**</tt> <tt class="py-number">4</tt><tt class="py-op">,</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"><tt id="link-71" class="py-name" targets="Variable common.textutils.TIME_UNITS=common.textutils-module.html#TIME_UNITS"><a title="common.textutils.TIME_UNITS" class="py-name" href="#" onclick="return doclink('link-71', 'TIME_UNITS', 'link-71');">TIME_UNITS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> <tt class="py-string">"ms"</tt><tt class="py-op">:</tt> <tt class="py-number">0.0001</tt><tt class="py-op">,</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-string">"s"</tt><tt class="py-op">:</tt> <tt class="py-number">1</tt><tt class="py-op">,</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"> <tt class="py-string">"min"</tt><tt class="py-op">:</tt> <tt class="py-number">60</tt><tt class="py-op">,</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"> <tt class="py-string">"h"</tt><tt class="py-op">:</tt> <tt class="py-number">60</tt> <tt class="py-op">*</tt> <tt class="py-number">60</tt><tt class="py-op">,</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"> <tt class="py-string">"d"</tt><tt class="py-op">:</tt> <tt class="py-number">60</tt> <tt class="py-op">*</tt> <tt class="py-number">60</tt> <tt class="py-op">*</tt><tt class="py-number">24</tt><tt class="py-op">,</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"> </tt>
<a name="apply_units"></a><div id="apply_units-def"><a name="L335"></a><tt class="py-lineno">335</tt> <a class="py-toggle" href="#" id="apply_units-toggle" onclick="return toggle('apply_units');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#apply_units">apply_units</a><tt class="py-op">(</tt><tt class="py-param">string</tt><tt class="py-op">,</tt> <tt class="py-param">units</tt><tt class="py-op">,</tt> <tt class="py-param">inter</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">final</tt><tt class="py-op">=</tt><tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-param">blank_reg</tt><tt class="py-op">=</tt><tt id="link-72" class="py-name"><a title="common.textutils._BLANK_RE" class="py-name" href="#" onclick="return doclink('link-72', '_BLANK_RE', 'link-59');">_BLANK_RE</a></tt><tt class="py-op">,</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> <tt class="py-param">value_reg</tt><tt class="py-op">=</tt><tt id="link-73" class="py-name"><a title="common.textutils._VALUE_RE" class="py-name" href="#" onclick="return doclink('link-73', '_VALUE_RE', 'link-63');">_VALUE_RE</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="apply_units-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="apply_units-expanded"><a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> <tt class="py-docstring">"""Parse the string applying the units defined in units</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"><tt class="py-docstring"> (e.g.: "1.5m",{'m',60} -> 80).</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"><tt class="py-docstring"> :type string: str or unicode</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"><tt class="py-docstring"> :param string: the string to parse</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"><tt class="py-docstring"> :type units: dict (or any object with __getitem__ using basestring key)</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"><tt class="py-docstring"> :param units: a dict mapping a unit string repr to its value</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"><tt class="py-docstring"> :type inter: type</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"><tt class="py-docstring"> :param inter: used to parse every intermediate value (need __sum__)</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"><tt class="py-docstring"> :type blank_reg: regexp</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"><tt class="py-docstring"> :param blank_reg: should match every blank char to ignore.</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"><tt class="py-docstring"> :type value_reg: regexp with "value" and optional "unit" group</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"><tt class="py-docstring"> :param value_reg: match a value and it's unit into the</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">inter</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"> <tt class="py-name">inter</tt> <tt class="py-op">=</tt> <tt class="py-name">final</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt class="py-name">fstring</tt> <tt class="py-op">=</tt> <tt id="link-74" class="py-name"><a title="common.textutils._BLANK_RE" class="py-name" href="#" onclick="return doclink('link-74', '_BLANK_RE', 'link-59');">_BLANK_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">fstring</tt> <tt class="py-keyword">and</tt> <tt id="link-75" class="py-name"><a title="common.textutils._VALIDATION_RE" class="py-name" href="#" onclick="return doclink('link-75', '_VALIDATION_RE', 'link-66');">_VALIDATION_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">fstring</tt><tt class="py-op">)</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-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"Invalid unit string: %r."</tt> <tt class="py-op">%</tt> <tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> <tt class="py-name">values</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-keyword">for</tt> <tt class="py-name">match</tt> <tt class="py-keyword">in</tt> <tt class="py-name">value_reg</tt><tt class="py-op">.</tt><tt class="py-name">finditer</tt><tt class="py-op">(</tt><tt class="py-name">fstring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-name">dic</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">groupdict</tt><tt class="py-op">(</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">lit</tt><tt class="py-op">,</tt> <tt class="py-name">unit</tt> <tt class="py-op">=</tt> <tt class="py-name">dic</tt><tt class="py-op">[</tt><tt class="py-string">"value"</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">dic</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name" targets="Method common.configuration.ConfigurationMixIn.get()=common.configuration.ConfigurationMixIn-class.html#get,Method common.configuration.OptionsManager2ConfigurationAdapter.get()=common.configuration.OptionsManager2ConfigurationAdapter-class.html#get,Method common.umessage.UMessage.get()=common.umessage.UMessage-class.html#get"><a title="common.configuration.ConfigurationMixIn.get
common.configuration.OptionsManager2ConfigurationAdapter.get
common.umessage.UMessage.get" class="py-name" href="#" onclick="return doclink('link-76', 'get', 'link-76');">get</a></tt><tt class="py-op">(</tt><tt class="py-string">"unit"</tt><tt class="py-op">)</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">inter</tt><tt class="py-op">(</tt><tt class="py-name">lit</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">if</tt> <tt class="py-name">unit</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">*=</tt> <tt class="py-name">units</tt><tt class="py-op">[</tt><tt class="py-name">unit</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>
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</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">raise</tt> <tt class="py-name">KeyError</tt><tt class="py-op">(</tt><tt class="py-string">'invalid unit %s. valid units are %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">unit</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">units</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</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">values</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-77', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">final</tt><tt class="py-op">(</tt><tt id="link-78" class="py-name" targets="Variable common.compat.sum=common.compat-module.html#sum"><a title="common.compat.sum" class="py-name" href="#" onclick="return doclink('link-78', 'sum', 'link-78');">sum</a></tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"><tt id="link-79" class="py-name" targets="Variable common.textutils._LINE_RGX=common.textutils-module.html#_LINE_RGX"><a title="common.textutils._LINE_RGX" class="py-name" href="#" onclick="return doclink('link-79', '_LINE_RGX', 'link-79');">_LINE_RGX</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'\r\n|\r+|\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"> </tt>
<a name="pretty_match"></a><div id="pretty_match-def"><a name="L377"></a><tt class="py-lineno">377</tt> <a class="py-toggle" href="#" id="pretty_match-toggle" onclick="return toggle('pretty_match');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#pretty_match">pretty_match</a><tt class="py-op">(</tt><tt class="py-param">match</tt><tt class="py-op">,</tt> <tt class="py-param">string</tt><tt class="py-op">,</tt> <tt class="py-param">underline_char</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="pretty_match-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="pretty_match-expanded"><a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"> <tt class="py-docstring">"""return a string with the match location underlined:</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-docstring"> >>> import re</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> >>> print(pretty_match(re.search('mange', 'il mange du bacon'), 'il mange du bacon'))</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"><tt class="py-docstring"> il mange du bacon</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"><tt class="py-docstring"> ^^^^^</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"><tt class="py-docstring"> >>></tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"><tt class="py-docstring"> :type match: _sre.SRE_match</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"><tt class="py-docstring"> :param match: object returned by re.match, re.search or re.finditer</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"><tt class="py-docstring"> :type string: str or unicode</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"><tt class="py-docstring"> :param string:</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"><tt class="py-docstring"> the string on which the regular expression has been applied to</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"><tt class="py-docstring"> obtain the `match` object</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"><tt class="py-docstring"> :type underline_char: str or unicode</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"><tt class="py-docstring"> :param underline_char:</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"><tt class="py-docstring"> character to use to underline the matched section, default to the</tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"><tt class="py-docstring"> carret '^'</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"><tt class="py-docstring"> :return:</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"><tt class="py-docstring"> the original string with an inserted line to underline the match</tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"><tt class="py-docstring"> location</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt id="link-80" class="py-name" targets="Method common.debugger.Debugger.start()=common.debugger.Debugger-class.html#start"><a title="common.debugger.Debugger.start" class="py-name" href="#" onclick="return doclink('link-80', 'start', 'link-80');">start</a></tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="common.debugger.Debugger.start" class="py-name" href="#" onclick="return doclink('link-81', 'start', 'link-80');">start</a></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">end</tt> <tt class="py-op">=</tt> <tt class="py-name">match</tt><tt class="py-op">.</tt><tt class="py-name">end</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt id="link-82" class="py-name"><a title="common.textutils._LINE_RGX" class="py-name" href="#" onclick="return doclink('link-82', '_LINE_RGX', 'link-79');">_LINE_RGX</a></tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt id="link-83" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-83', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">,</tt> <tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"> <tt class="py-name">start_line_pos</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">rfind</tt><tt class="py-op">(</tt><tt id="link-84" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-84', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt id="link-85" class="py-name"><a title="common.debugger.Debugger.start" class="py-name" href="#" onclick="return doclink('link-85', 'start', 'link-80');">start</a></tt><tt class="py-op">)</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">start_line_pos</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="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"> <tt class="py-name">start_line_pos</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">start_line_pos</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt> <tt class="py-line"> <tt class="py-name">start_line_pos</tt> <tt class="py-op">+=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-86" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-86', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">)</tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt id="link-87" class="py-name"><a title="common.debugger.Debugger.start" class="py-name" href="#" onclick="return doclink('link-87', 'start', 'link-80');">start</a></tt> <tt class="py-op">-</tt> <tt class="py-name">start_line_pos</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"> <tt class="py-name">underline</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt> <tt class="py-op">*</tt> <tt class="py-name">offset</tt> <tt class="py-op">+</tt> <tt class="py-name">underline_char</tt> <tt class="py-op">*</tt> <tt class="py-op">(</tt><tt class="py-name">end</tt> <tt class="py-op">-</tt> <tt id="link-88" class="py-name"><a title="common.debugger.Debugger.start" class="py-name" href="#" onclick="return doclink('link-88', 'start', 'link-80');">start</a></tt><tt class="py-op">)</tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"> <tt class="py-name">end_line_pos</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">.</tt><tt id="link-89" class="py-name" targets="Function common.shellutils.find()=common.shellutils-module.html#find"><a title="common.shellutils.find" class="py-name" href="#" onclick="return doclink('link-89', 'find', 'link-89');">find</a></tt><tt class="py-op">(</tt><tt id="link-90" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-90', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">,</tt> <tt class="py-name">end</tt><tt class="py-op">)</tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">end_line_pos</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="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"> <tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-name">start_line_pos</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-91', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-92', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">underline</tt><tt class="py-op">)</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"> <tt class="py-name">end</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-name">end_line_pos</tt> <tt class="py-op">+</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-93" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-93', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"> <tt class="py-name">string</tt> <tt class="py-op">=</tt> <tt class="py-name">string</tt><tt class="py-op">[</tt><tt class="py-name">start_line_pos</tt><tt class="py-op">:</tt><tt class="py-name">end_line_pos</tt><tt class="py-op">]</tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-94', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">)</tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-95', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">underline</tt><tt class="py-op">)</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-96', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">end</tt><tt class="py-op">)</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-97" class="py-name"><a title="common.textutils.linesep" class="py-name" href="#" onclick="return doclink('link-97', 'linesep', 'link-1');">linesep</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"><tt class="py-comment"># Ansi colorization ###########################################################</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"><tt id="link-98" class="py-name" targets="Variable common.textutils.ANSI_PREFIX=common.textutils-module.html#ANSI_PREFIX"><a title="common.textutils.ANSI_PREFIX" class="py-name" href="#" onclick="return doclink('link-98', 'ANSI_PREFIX', 'link-98');">ANSI_PREFIX</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\033['</tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"><tt id="link-99" class="py-name" targets="Variable common.textutils.ANSI_END=common.textutils-module.html#ANSI_END"><a title="common.textutils.ANSI_END" class="py-name" href="#" onclick="return doclink('link-99', 'ANSI_END', 'link-99');">ANSI_END</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'m'</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"><tt id="link-100" class="py-name" targets="Variable common.textutils.ANSI_RESET=common.textutils-module.html#ANSI_RESET"><a title="common.textutils.ANSI_RESET" class="py-name" href="#" onclick="return doclink('link-100', 'ANSI_RESET', 'link-100');">ANSI_RESET</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\033[0m'</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"><tt id="link-101" class="py-name" targets="Variable common.textutils.ANSI_STYLES=common.textutils-module.html#ANSI_STYLES"><a title="common.textutils.ANSI_STYLES" class="py-name" href="#" onclick="return doclink('link-101', 'ANSI_STYLES', 'link-101');">ANSI_STYLES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"> <tt class="py-string">'reset'</tt><tt class="py-op">:</tt> <tt class="py-string">"0"</tt><tt class="py-op">,</tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> <tt class="py-string">'bold'</tt><tt class="py-op">:</tt> <tt class="py-string">"1"</tt><tt class="py-op">,</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"> <tt class="py-string">'italic'</tt><tt class="py-op">:</tt> <tt class="py-string">"3"</tt><tt class="py-op">,</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"> <tt class="py-string">'underline'</tt><tt class="py-op">:</tt> <tt class="py-string">"4"</tt><tt class="py-op">,</tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"> <tt class="py-string">'blink'</tt><tt class="py-op">:</tt> <tt class="py-string">"5"</tt><tt class="py-op">,</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"> <tt class="py-string">'inverse'</tt><tt class="py-op">:</tt> <tt class="py-string">"7"</tt><tt class="py-op">,</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"> <tt class="py-string">'strike'</tt><tt class="py-op">:</tt> <tt class="py-string">"9"</tt><tt class="py-op">,</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"><tt id="link-102" class="py-name" targets="Variable common.textutils.ANSI_COLORS=common.textutils-module.html#ANSI_COLORS"><a title="common.textutils.ANSI_COLORS" class="py-name" href="#" onclick="return doclink('link-102', 'ANSI_COLORS', 'link-102');">ANSI_COLORS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"> <tt class="py-string">'reset'</tt><tt class="py-op">:</tt> <tt class="py-string">"0"</tt><tt class="py-op">,</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> <tt class="py-string">'black'</tt><tt class="py-op">:</tt> <tt class="py-string">"30"</tt><tt class="py-op">,</tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> <tt class="py-string">'red'</tt><tt class="py-op">:</tt> <tt class="py-string">"31"</tt><tt class="py-op">,</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"> <tt class="py-string">'green'</tt><tt class="py-op">:</tt> <tt class="py-string">"32"</tt><tt class="py-op">,</tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-string">'yellow'</tt><tt class="py-op">:</tt> <tt class="py-string">"33"</tt><tt class="py-op">,</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"> <tt class="py-string">'blue'</tt><tt class="py-op">:</tt> <tt class="py-string">"34"</tt><tt class="py-op">,</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"> <tt class="py-string">'magenta'</tt><tt class="py-op">:</tt> <tt class="py-string">"35"</tt><tt class="py-op">,</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"> <tt class="py-string">'cyan'</tt><tt class="py-op">:</tt> <tt class="py-string">"36"</tt><tt class="py-op">,</tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"> <tt class="py-string">'white'</tt><tt class="py-op">:</tt> <tt class="py-string">"37"</tt><tt class="py-op">,</tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"><tt class="py-op">}</tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"> </tt>
<a name="_get_ansi_code"></a><div id="_get_ansi_code-def"><a name="L456"></a><tt class="py-lineno">456</tt> <a class="py-toggle" href="#" id="_get_ansi_code-toggle" onclick="return toggle('_get_ansi_code');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#_get_ansi_code">_get_ansi_code</a><tt class="py-op">(</tt><tt class="py-param">color</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">style</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="_get_ansi_code-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_get_ansi_code-expanded"><a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"> <tt class="py-docstring">"""return ansi escape code corresponding to color and style</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"><tt class="py-docstring"> :type color: str or None</tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"><tt class="py-docstring"> :param color:</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"><tt class="py-docstring"> the color name (see `ANSI_COLORS` for available values)</tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"><tt class="py-docstring"> or the color number when 256 colors are available</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"><tt class="py-docstring"> :type style: str or None</tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"><tt class="py-docstring"> :param style:</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt> <tt class="py-line"><tt class="py-docstring"> style string (see `ANSI_COLORS` for available values). To get</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt> <tt class="py-line"><tt class="py-docstring"> several style effects at the same time, use a coma as separator.</tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"><tt class="py-docstring"> :raise KeyError: if an unexistent color or style identifier is given</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str</tt> </tt>
<a name="L472"></a><tt class="py-lineno">472</tt> <tt class="py-line"><tt class="py-docstring"> :return: the built escape code</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"> <tt class="py-name">ansi_code</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">style</tt><tt class="py-op">:</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"> <tt class="py-name">style_attrs</tt> <tt class="py-op">=</tt> <tt id="link-103" class="py-name"><a title="common.textutils.splitstrip" class="py-name" href="#" onclick="return doclink('link-103', 'splitstrip', 'link-54');">splitstrip</a></tt><tt class="py-op">(</tt><tt class="py-name">style</tt><tt class="py-op">)</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">effect</tt> <tt class="py-keyword">in</tt> <tt class="py-name">style_attrs</tt><tt class="py-op">:</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"> <tt class="py-name">ansi_code</tt><tt class="py-op">.</tt><tt id="link-104" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-104', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt id="link-105" class="py-name"><a title="common.textutils.ANSI_STYLES" class="py-name" href="#" onclick="return doclink('link-105', 'ANSI_STYLES', 'link-101');">ANSI_STYLES</a></tt><tt class="py-op">[</tt><tt class="py-name">effect</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">color</tt><tt class="py-op">:</tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">color</tt><tt class="py-op">.</tt><tt class="py-name">isdigit</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt> <tt class="py-line"> <tt class="py-name">ansi_code</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name" targets="Function common.interface.extend()=common.interface-module.html#extend"><a title="common.interface.extend" class="py-name" href="#" onclick="return doclink('link-106', 'extend', 'link-106');">extend</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">'38'</tt><tt class="py-op">,</tt> <tt class="py-string">'5'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"> <tt class="py-name">ansi_code</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-107', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">color</tt><tt class="py-op">)</tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"> <tt class="py-name">ansi_code</tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="common.tree.ListNode.append
common.tree.Node.append
common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-108', 'append', 'link-9');">append</a></tt><tt class="py-op">(</tt><tt id="link-109" class="py-name"><a title="common.textutils.ANSI_COLORS" class="py-name" href="#" onclick="return doclink('link-109', 'ANSI_COLORS', 'link-102');">ANSI_COLORS</a></tt><tt class="py-op">[</tt><tt class="py-name">color</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ansi_code</tt><tt class="py-op">:</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-110" class="py-name"><a title="common.textutils.ANSI_PREFIX" class="py-name" href="#" onclick="return doclink('link-110', 'ANSI_PREFIX', 'link-98');">ANSI_PREFIX</a></tt> <tt class="py-op">+</tt> <tt class="py-string">';'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">ansi_code</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt id="link-111" class="py-name"><a title="common.textutils.ANSI_END" class="py-name" href="#" onclick="return doclink('link-111', 'ANSI_END', 'link-99');">ANSI_END</a></tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
</div><a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"> </tt>
<a name="colorize_ansi"></a><div id="colorize_ansi-def"><a name="L489"></a><tt class="py-lineno">489</tt> <a class="py-toggle" href="#" id="colorize_ansi-toggle" onclick="return toggle('colorize_ansi');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#colorize_ansi">colorize_ansi</a><tt class="py-op">(</tt><tt class="py-param">msg</tt><tt class="py-op">,</tt> <tt class="py-param">color</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">style</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="colorize_ansi-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="colorize_ansi-expanded"><a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"> <tt class="py-docstring">"""colorize message by wrapping it with ansi escape codes</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"><tt class="py-docstring"> :type msg: str or unicode</tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"><tt class="py-docstring"> :param msg: the message string to colorize</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt> <tt class="py-line"><tt class="py-docstring"> :type color: str or None</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"><tt class="py-docstring"> :param color:</tt> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"><tt class="py-docstring"> the color identifier (see `ANSI_COLORS` for available values)</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"><tt class="py-docstring"> :type style: str or None</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt> <tt class="py-line"><tt class="py-docstring"> :param style:</tt> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"><tt class="py-docstring"> style string (see `ANSI_COLORS` for available values). To get</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"><tt class="py-docstring"> several style effects at the same time, use a coma as separator.</tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"><tt class="py-docstring"> :raise KeyError: if an unexistent color or style identifier is given</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"><tt class="py-docstring"> :rtype: str or unicode</tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt> <tt class="py-line"><tt class="py-docstring"> :return: the ansi escaped string</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"> <tt class="py-comment"># If both color and style are not defined, then leave the text as is</tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">color</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">style</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">msg</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"> <tt class="py-name">escape_code</tt> <tt class="py-op">=</tt> <tt class="py-name">_get_ansi_code</tt><tt class="py-op">(</tt><tt class="py-name">color</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">)</tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"> <tt class="py-comment"># If invalid (or unknown) color, don't wrap msg with ansi codes</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">escape_code</tt><tt class="py-op">:</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s%s%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">escape_code</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt id="link-112" class="py-name"><a title="common.textutils.ANSI_RESET" class="py-name" href="#" onclick="return doclink('link-112', 'ANSI_RESET', 'link-100');">ANSI_RESET</a></tt><tt class="py-op">)</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">msg</tt> </tt>
</div><a name="L517"></a><tt class="py-lineno">517</tt> <tt class="py-line"> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"><tt id="link-113" class="py-name" targets="Variable common.textutils.DIFF_STYLE=common.textutils-module.html#DIFF_STYLE"><a title="common.textutils.DIFF_STYLE" class="py-name" href="#" onclick="return doclink('link-113', 'DIFF_STYLE', 'link-113');">DIFF_STYLE</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">'separator'</tt><tt class="py-op">:</tt> <tt class="py-string">'cyan'</tt><tt class="py-op">,</tt> <tt class="py-string">'remove'</tt><tt class="py-op">:</tt> <tt class="py-string">'red'</tt><tt class="py-op">,</tt> <tt class="py-string">'add'</tt><tt class="py-op">:</tt> <tt class="py-string">'green'</tt><tt class="py-op">}</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt> <tt class="py-line"> </tt>
<a name="diff_colorize_ansi"></a><div id="diff_colorize_ansi-def"><a name="L520"></a><tt class="py-lineno">520</tt> <a class="py-toggle" href="#" id="diff_colorize_ansi-toggle" onclick="return toggle('diff_colorize_ansi');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="common.textutils-module.html#diff_colorize_ansi">diff_colorize_ansi</a><tt class="py-op">(</tt><tt class="py-param">lines</tt><tt class="py-op">,</tt> <tt class="py-param">out</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">style</tt><tt class="py-op">=</tt><tt id="link-114" class="py-name"><a title="common.textutils.DIFF_STYLE" class="py-name" href="#" onclick="return doclink('link-114', 'DIFF_STYLE', 'link-113');">DIFF_STYLE</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="diff_colorize_ansi-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="diff_colorize_ansi-expanded"><a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt id="link-115" class="py-name"><a title="common.fileutils.lines" class="py-name" href="#" onclick="return doclink('link-115', 'lines', 'link-24');">lines</a></tt><tt class="py-op">:</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'--- '</tt><tt class="py-op">,</tt> <tt class="py-string">'+++ '</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name" targets="Method common.changelog.ChangeLog.write()=common.changelog.ChangeLog-class.html#write,Method common.changelog.ChangeLogEntry.write()=common.changelog.ChangeLogEntry-class.html#write,Method common.ureports.BaseWriter.write()=common.ureports.BaseWriter-class.html#write"><a title="common.changelog.ChangeLog.write
common.changelog.ChangeLogEntry.write
common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-116', 'write', 'link-116');">write</a></tt><tt class="py-op">(</tt><tt id="link-117" class="py-name" targets="Function common.textutils.colorize_ansi()=common.textutils-module.html#colorize_ansi"><a title="common.textutils.colorize_ansi" class="py-name" href="#" onclick="return doclink('link-117', 'colorize_ansi', 'link-117');">colorize_ansi</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">[</tt><tt class="py-string">'separator'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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-string">'-'</tt><tt class="py-op">:</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="common.changelog.ChangeLog.write
common.changelog.ChangeLogEntry.write
common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-118', 'write', 'link-116');">write</a></tt><tt class="py-op">(</tt><tt id="link-119" class="py-name"><a title="common.textutils.colorize_ansi" class="py-name" href="#" onclick="return doclink('link-119', 'colorize_ansi', 'link-117');">colorize_ansi</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">[</tt><tt class="py-string">'remove'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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-string">'+'</tt><tt class="py-op">:</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="common.changelog.ChangeLog.write
common.changelog.ChangeLogEntry.write
common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-120', 'write', 'link-116');">write</a></tt><tt class="py-op">(</tt><tt id="link-121" class="py-name"><a title="common.textutils.colorize_ansi" class="py-name" href="#" onclick="return doclink('link-121', 'colorize_ansi', 'link-117');">colorize_ansi</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">[</tt><tt class="py-string">'add'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'--- '</tt><tt class="py-op">:</tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="common.changelog.ChangeLog.write
common.changelog.ChangeLogEntry.write
common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-122', 'write', 'link-116');">write</a></tt><tt class="py-op">(</tt><tt id="link-123" class="py-name"><a title="common.textutils.colorize_ansi" class="py-name" href="#" onclick="return doclink('link-123', 'colorize_ansi', 'link-117');">colorize_ansi</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">[</tt><tt class="py-string">'separator'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">4</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'+++ '</tt><tt class="py-op">:</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="common.changelog.ChangeLog.write
common.changelog.ChangeLogEntry.write
common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-124', 'write', 'link-116');">write</a></tt><tt class="py-op">(</tt><tt id="link-125" class="py-name"><a title="common.textutils.colorize_ansi" class="py-name" href="#" onclick="return doclink('link-125', 'colorize_ansi', 'link-117');">colorize_ansi</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">style</tt><tt class="py-op">[</tt><tt class="py-string">'separator'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L533"></a><tt class="py-lineno">533</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="common.changelog.ChangeLog.write
common.changelog.ChangeLogEntry.write
common.ureports.BaseWriter.write" class="py-name" href="#" onclick="return doclink('link-126', 'write', 'link-116');">write</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
</div><a name="L534"></a><tt class="py-lineno">534</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="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 Wed Feb 19 13:32:28 2014
</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>
|