python-logilab-common 1.4.1-1 / usr / share / doc / python-logilab-common / apidoc / logilab.common.fileutils-pysrc.html

This file is indexed.

/usr/share/doc/python-logilab-common/apidoc/logilab.common.fileutils-pysrc.html is in python-logilab-common 1.4.1-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
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>logilab.common.fileutils</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>&nbsp;&nbsp;&nbsp;<a
        href="logilab.common-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >Logilab's common library</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;logilab ::
        <a href="logilab.common-module.html">Package&nbsp;common</a> ::
        Module&nbsp;fileutils
      </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
            >]&nbsp;|&nbsp;<a href="logilab.common.fileutils-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="logilab.common.fileutils-module.html">Module logilab.common.fileutils</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 &lt;http://www.gnu.org/licenses/&gt;.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">"""File and file-path manipulation utilities.</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">:group path manipulation: first_level_directory, relative_path, is_binary,\</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">get_by_ext, remove_dead_links</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">:group file manipulation: norm_read, norm_open, lines, stream_lines, lines,\</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">write_open_mode, ensure_fs_mode, export</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">:sort: path manipulation, file 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>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">__future__</tt> <tt class="py-keyword">import</tt> <tt class="py-name">print_function</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</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="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">io</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">shutil</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">mimetypes</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> <tt class="py-keyword">import</tt> <tt class="py-name">isabs</tt><tt class="py-op">,</tt> <tt class="py-name">isdir</tt><tt class="py-op">,</tt> <tt class="py-name">islink</tt><tt class="py-op">,</tt> <tt class="py-name">split</tt><tt class="py-op">,</tt> <tt class="py-name">exists</tt><tt class="py-op">,</tt> <tt class="py-name">normpath</tt><tt class="py-op">,</tt> <tt class="py-name">join</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt> <tt class="py-keyword">import</tt> <tt class="py-name">abspath</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">os</tt> <tt class="py-keyword">import</tt> <tt class="py-name">sep</tt><tt class="py-op">,</tt> <tt class="py-name">mkdir</tt><tt class="py-op">,</tt> <tt id="link-0" class="py-name" targets="Method logilab.common.table.Table.remove()=logilab.common.table.Table-class.html#remove,Method logilab.common.tasksqueue.PrioritizedTasksQueue.remove()=logilab.common.tasksqueue.PrioritizedTasksQueue-class.html#remove,Method logilab.common.tree.BinaryNode.remove()=logilab.common.tree.BinaryNode-class.html#remove,Method logilab.common.tree.ListNode.remove()=logilab.common.tree.ListNode-class.html#remove,Method logilab.common.tree.Node.remove()=logilab.common.tree.Node-class.html#remove"><a title="logilab.common.table.Table.remove
logilab.common.tasksqueue.PrioritizedTasksQueue.remove
logilab.common.tree.BinaryNode.remove
logilab.common.tree.ListNode.remove
logilab.common.tree.Node.remove" class="py-name" href="#" onclick="return doclink('link-0', 'remove', 'link-0');">remove</a></tt><tt class="py-op">,</tt> <tt class="py-name">listdir</tt><tt class="py-op">,</tt> <tt class="py-name">stat</tt><tt class="py-op">,</tt> <tt class="py-name">chmod</tt><tt class="py-op">,</tt> <tt id="link-1" class="py-name" targets="Method logilab.common.umessage.UMessage.walk()=logilab.common.umessage.UMessage-class.html#walk"><a title="logilab.common.umessage.UMessage.walk" class="py-name" href="#" onclick="return doclink('link-1', 'walk', 'link-1');">walk</a></tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">stat</tt> <tt class="py-keyword">import</tt> <tt class="py-name">ST_MODE</tt><tt class="py-op">,</tt> <tt class="py-name">S_IWRITE</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">logilab</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Package logilab.common=logilab.common-module.html"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-2', 'common', 'link-2');">common</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Variable logilab.common.STD_BLACKLIST=logilab.common-module.html#STD_BLACKLIST"><a title="logilab.common.STD_BLACKLIST" class="py-name" href="#" onclick="return doclink('link-3', 'STD_BLACKLIST', 'link-3');">STD_BLACKLIST</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">BASE_BLACKLIST</tt><tt class="py-op">,</tt> <tt id="link-4" class="py-name" targets="Variable logilab.common.IGNORED_EXTENSIONS=logilab.common-module.html#IGNORED_EXTENSIONS"><a title="logilab.common.IGNORED_EXTENSIONS" class="py-name" href="#" onclick="return doclink('link-4', 'IGNORED_EXTENSIONS', 'link-4');">IGNORED_EXTENSIONS</a></tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">logilab</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-5', 'common', 'link-2');">common</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Module logilab.common.shellutils=logilab.common.shellutils-module.html"><a title="logilab.common.shellutils" class="py-name" href="#" onclick="return doclink('link-6', 'shellutils', 'link-6');">shellutils</a></tt> <tt class="py-keyword">import</tt> <tt id="link-7" class="py-name" targets="Function logilab.common.shellutils.find()=logilab.common.shellutils-module.html#find"><a title="logilab.common.shellutils.find" class="py-name" href="#" onclick="return doclink('link-7', 'find', 'link-7');">find</a></tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</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-8" class="py-name"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-8', 'common', 'link-2');">common</a></tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Module logilab.common.deprecation=logilab.common.deprecation-module.html"><a title="logilab.common.deprecation" class="py-name" href="#" onclick="return doclink('link-9', 'deprecation', 'link-9');">deprecation</a></tt> <tt class="py-keyword">import</tt> <tt id="link-10" class="py-name" targets="Method logilab.common.deprecation.DeprecationManager.deprecated()=logilab.common.deprecation.DeprecationManager-class.html#deprecated,Function logilab.common.deprecation.deprecated()=logilab.common.deprecation-module.html#deprecated"><a title="logilab.common.deprecation.DeprecationManager.deprecated
logilab.common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-10', 'deprecated', 'link-10');">deprecated</a></tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">logilab</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="logilab.common" class="py-name" href="#" onclick="return doclink('link-11', 'common', 'link-2');">common</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Module logilab.common.compat=logilab.common.compat-module.html"><a title="logilab.common.compat" class="py-name" href="#" onclick="return doclink('link-12', 'compat', 'link-12');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">FileIO</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"> </tt>
<a name="first_level_directory"></a><div id="first_level_directory-def"><a name="L45"></a><tt class="py-lineno"> 45</tt> <a class="py-toggle" href="#" id="first_level_directory-toggle" onclick="return toggle('first_level_directory');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#first_level_directory">first_level_directory</a><tt class="py-op">(</tt><tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="first_level_directory-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="first_level_directory-expanded"><a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return the first level directory of a path.</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; first_level_directory('home/syt/work')</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">    'home'</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; first_level_directory('/home/syt/work')</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">    '/'</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; first_level_directory('work')</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">    'work'</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt;</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">    :type path: str</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">    :param path: the path for which we want the first level directory</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">    :rtype: str</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">    :return: the first level directory appearing in `path`</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line">    <tt class="py-name">head</tt><tt class="py-op">,</tt> <tt class="py-name">tail</tt> <tt class="py-op">=</tt> <tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">)</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line">    <tt class="py-keyword">while</tt> <tt class="py-name">head</tt> <tt class="py-keyword">and</tt> <tt class="py-name">tail</tt><tt class="py-op">:</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line">        <tt class="py-name">head</tt><tt class="py-op">,</tt> <tt class="py-name">tail</tt> <tt class="py-op">=</tt> <tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">head</tt><tt class="py-op">)</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">tail</tt><tt class="py-op">:</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">tail</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">    <tt class="py-comment"># path was absolute, head is the fs root</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">head</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"> </tt>
<a name="abspath_listdir"></a><div id="abspath_listdir-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="abspath_listdir-toggle" onclick="return toggle('abspath_listdir');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#abspath_listdir">abspath_listdir</a><tt class="py-op">(</tt><tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="abspath_listdir-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="abspath_listdir-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">    <tt class="py-docstring">"""Lists path's content using absolute paths."""</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">    <tt class="py-name">path</tt> <tt class="py-op">=</tt> <tt class="py-name">abspath</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">)</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">listdir</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
</div><a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"> </tt>
<a name="is_binary"></a><div id="is_binary-def"><a name="L76"></a><tt class="py-lineno"> 76</tt> <a class="py-toggle" href="#" id="is_binary-toggle" onclick="return toggle('is_binary');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#is_binary">is_binary</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_binary-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="is_binary-expanded"><a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return true if filename may be a binary file, according to it's</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring">    extension.</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">    :type filename: str</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">    :param filename: the name of the file</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">    :rtype: bool</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">    :return:</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">      true if the file is a binary file (actually if it's mime type</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring">      isn't beginning by text/)</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt class="py-name">mimetypes</tt><tt class="py-op">.</tt><tt class="py-name">guess_type</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'text'</tt><tt class="py-op">)</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"> </tt>
<a name="write_open_mode"></a><div id="write_open_mode-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <a class="py-toggle" href="#" id="write_open_mode-toggle" onclick="return toggle('write_open_mode');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#write_open_mode">write_open_mode</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="write_open_mode-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="write_open_mode-expanded"><a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return the write mode that should used to open file.</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">    :type filename: str</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">    :param filename: the name of the file</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">    :rtype: str</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">    :return: the mode that should be use to open the file ('w' or 'wb')</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt id="link-13" class="py-name" targets="Function logilab.common.fileutils.is_binary()=logilab.common.fileutils-module.html#is_binary"><a title="logilab.common.fileutils.is_binary" class="py-name" href="#" onclick="return doclink('link-13', 'is_binary', 'link-13');">is_binary</a></tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">'wb'</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-string">'w'</tt> </tt>
</div><a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"> </tt>
<a name="ensure_fs_mode"></a><div id="ensure_fs_mode-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="ensure_fs_mode-toggle" onclick="return toggle('ensure_fs_mode');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#ensure_fs_mode">ensure_fs_mode</a><tt class="py-op">(</tt><tt class="py-param">filepath</tt><tt class="py-op">,</tt> <tt class="py-param">desired_mode</tt><tt class="py-op">=</tt><tt class="py-name">S_IWRITE</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ensure_fs_mode-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ensure_fs_mode-expanded"><a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">    <tt class="py-docstring">"""Check that the given file has the given mode(s) set, else try to</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">    set it.</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">    :type filepath: str</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">    :param filepath: path of the file</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">    :type desired_mode: int</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">    :param desired_mode:</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">      ORed flags describing the desired mode. Use constants from the</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">      `stat` module for file permission's modes</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line">    <tt class="py-name">mode</tt> <tt class="py-op">=</tt> <tt class="py-name">stat</tt><tt class="py-op">(</tt><tt class="py-name">filepath</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-name">ST_MODE</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-keyword">not</tt> <tt class="py-name">mode</tt> <tt class="py-op">&amp;</tt> <tt class="py-name">desired_mode</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">chmod</tt><tt class="py-op">(</tt><tt class="py-name">filepath</tt><tt class="py-op">,</tt> <tt class="py-name">mode</tt> <tt class="py-op">|</tt> <tt class="py-name">desired_mode</tt><tt class="py-op">)</tt> </tt>
</div><a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"> </tt>
<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 class="py-comment"># XXX (syt) unused? kill?</tt> </tt>
<a name="ProtectedFile"></a><div id="ProtectedFile-def"><a name="L126"></a><tt class="py-lineno">126</tt> <a class="py-toggle" href="#" id="ProtectedFile-toggle" onclick="return toggle('ProtectedFile');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.fileutils.ProtectedFile-class.html">ProtectedFile</a><tt class="py-op">(</tt><tt class="py-base-class">FileIO</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProtectedFile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ProtectedFile-expanded"><a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line">    <tt class="py-docstring">"""A special file-object class that automatically does a 'chmod +w' when</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring">    needed.</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">    XXX: for now, the way it is done allows 'normal file-objects' to be</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">    created during the ProtectedFile object lifetime.</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-docstring">    One way to circumvent this would be to chmod / unchmod on each</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-docstring">    write operation.</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">    One other way would be to :</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">    - catch the IOError in the __init__</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">    - if IOError, then create a StringIO object</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">    - each write operation writes in this StringIO object</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">    - on close()/del(), write/append the StringIO content to the file and</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">      do the chmod only once</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="ProtectedFile.__init__"></a><div id="ProtectedFile.__init__-def"><a name="L146"></a><tt class="py-lineno">146</tt> <a class="py-toggle" href="#" id="ProtectedFile.__init__-toggle" onclick="return toggle('ProtectedFile.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils.ProtectedFile-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filepath</tt><tt class="py-op">,</tt> <tt class="py-param">mode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProtectedFile.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProtectedFile.__init__-expanded"><a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">original_mode</tt> <tt class="py-op">=</tt> <tt class="py-name">stat</tt><tt class="py-op">(</tt><tt class="py-name">filepath</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-name">ST_MODE</tt><tt class="py-op">]</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mode_changed</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">mode</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'w'</tt><tt class="py-op">,</tt> <tt class="py-string">'a'</tt><tt class="py-op">,</tt> <tt class="py-string">'wb'</tt><tt class="py-op">,</tt> <tt class="py-string">'ab'</tt><tt class="py-op">)</tt><tt class="py-op">:</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-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">original_mode</tt> <tt class="py-op">&amp;</tt> <tt class="py-name">S_IWRITE</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">chmod</tt><tt class="py-op">(</tt><tt class="py-name">filepath</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">original_mode</tt> <tt class="py-op">|</tt> <tt class="py-name">S_IWRITE</tt><tt class="py-op">)</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mode_changed</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line">        <tt class="py-name">FileIO</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method logilab.common.cache.Cache.__init__()=logilab.common.cache.Cache-class.html#__init__,Method logilab.common.changelog.ChangeLog.__init__()=logilab.common.changelog.ChangeLog-class.html#__init__,Method logilab.common.changelog.ChangeLogEntry.__init__()=logilab.common.changelog.ChangeLogEntry-class.html#__init__,Method logilab.common.clcommands.Command.__init__()=logilab.common.clcommands.Command-class.html#__init__,Method logilab.common.clcommands.CommandLine.__init__()=logilab.common.clcommands.CommandLine-class.html#__init__,Method logilab.common.configuration.Configuration.__init__()=logilab.common.configuration.Configuration-class.html#__init__,Method logilab.common.configuration.ConfigurationMixIn.__init__()=logilab.common.configuration.ConfigurationMixIn-class.html#__init__,Method logilab.common.configuration.OptionsManager2ConfigurationAdapter.__init__()=logilab.common.configuration.OptionsManager2ConfigurationAdapter-class.html#__init__,Method logilab.common.configuration.OptionsManagerMixIn.__init__()=logilab.common.configuration.OptionsManagerMixIn-class.html#__init__,Method logilab.common.configuration.OptionsProviderMixIn.__init__()=logilab.common.configuration.OptionsProviderMixIn-class.html#__init__,Method logilab.common.debugger.Debugger.__init__()=logilab.common.debugger.Debugger-class.html#__init__,Method logilab.common.decorators.cached_decorator.__init__()=logilab.common.decorators.cached_decorator-class.html#__init__,Method logilab.common.decorators.cachedproperty.__init__()=logilab.common.decorators.cachedproperty-class.html#__init__,Method logilab.common.decorators.classproperty.__init__()=logilab.common.decorators.classproperty-class.html#__init__,Method logilab.common.decorators.iclassmethod.__init__()=logilab.common.decorators.iclassmethod-class.html#__init__,Method logilab.common.decorators.wproperty.__init__()=logilab.common.decorators.wproperty-class.html#__init__,Method logilab.common.deprecation.DeprecationManager.__init__()=logilab.common.deprecation.DeprecationManager-class.html#__init__,Method logilab.common.deprecation.DeprecationWrapper.__init__()=logilab.common.deprecation.DeprecationWrapper-class.html#__init__,Method logilab.common.dictattr.__init__()=logilab.common.dictattr-class.html#__init__,Method logilab.common.fileutils.ProtectedFile.__init__()=logilab.common.fileutils.ProtectedFile-class.html#__init__,Method logilab.common.graph.DotBackend.__init__()=logilab.common.graph.DotBackend-class.html#__init__,Method logilab.common.graph.GraphGenerator.__init__()=logilab.common.graph.GraphGenerator-class.html#__init__,Method logilab.common.logging_ext.ColorFormatter.__init__()=logilab.common.logging_ext.ColorFormatter-class.html#__init__,Method logilab.common.modutils.LazyObject.__init__()=logilab.common.modutils.LazyObject-class.html#__init__,Method logilab.common.optik_ext.Option.__init__()=logilab.common.optik_ext.Option-class.html#__init__,Method logilab.common.optik_ext.OptionParser.__init__()=logilab.common.optik_ext.OptionParser-class.html#__init__,Method logilab.common.optparser.OptionParser.__init__()=logilab.common.optparser.OptionParser-class.html#__init__,Method logilab.common.proc.MemorySentinel.__init__()=logilab.common.proc.MemorySentinel-class.html#__init__,Method logilab.common.proc.ProcInfo.__init__()=logilab.common.proc.ProcInfo-class.html#__init__,Method logilab.common.proc.ProcInfoLoader.__init__()=logilab.common.proc.ProcInfoLoader-class.html#__init__,Method logilab.common.proc.ResourceController.__init__()=logilab.common.proc.ResourceController-class.html#__init__,Method logilab.common.registry.MultiPredicate.__init__()=logilab.common.registry.MultiPredicate-class.html#__init__,Method logilab.common.registry.NoSelectableObject.__init__()=logilab.common.registry.NoSelectableObject-class.html#__init__,Method logilab.common.registry.NotPredicate.__init__()=logilab.common.registry.NotPredicate-class.html#__init__,Method logilab.common.registry.RegistrableInstance.__init__()=logilab.common.registry.RegistrableInstance-class.html#__init__,Method logilab.common.registry.Registry.__init__()=logilab.common.registry.Registry-class.html#__init__,Method logilab.common.registry.RegistryStore.__init__()=logilab.common.registry.RegistryStore-class.html#__init__,Method logilab.common.registry.traced_selection.__init__()=logilab.common.registry.traced_selection-class.html#__init__,Method logilab.common.registry.yes.__init__()=logilab.common.registry.yes-class.html#__init__,Method logilab.common.shellutils.ProgressBar.__init__()=logilab.common.shellutils.ProgressBar-class.html#__init__,Method logilab.common.shellutils.RawInput.__init__()=logilab.common.shellutils.RawInput-class.html#__init__,Method logilab.common.shellutils.progress.__init__()=logilab.common.shellutils.progress-class.html#__init__,Method logilab.common.shellutils.pushd.__init__()=logilab.common.shellutils.pushd-class.html#__init__,Method logilab.common.sphinxutils.ModuleGenerator.__init__()=logilab.common.sphinxutils.ModuleGenerator-class.html#__init__,Method logilab.common.table.Table.__init__()=logilab.common.table.Table-class.html#__init__,Method logilab.common.table.TableCellRenderer.__init__()=logilab.common.table.TableCellRenderer-class.html#__init__,Method logilab.common.table.TableStyle.__init__()=logilab.common.table.TableStyle-class.html#__init__,Method logilab.common.table.TableStyleSheet.__init__()=logilab.common.table.TableStyleSheet-class.html#__init__,Method logilab.common.table.TableWriter.__init__()=logilab.common.table.TableWriter-class.html#__init__,Method logilab.common.tasksqueue.Task.__init__()=logilab.common.tasksqueue.Task-class.html#__init__,Method logilab.common.tempattr.__init__()=logilab.common.tempattr-class.html#__init__,Method logilab.common.tree.BinaryNode.__init__()=logilab.common.tree.BinaryNode-class.html#__init__,Method logilab.common.tree.ListNode.__init__()=logilab.common.tree.ListNode-class.html#__init__,Method logilab.common.tree.Node.__init__()=logilab.common.tree.Node-class.html#__init__,Method logilab.common.tree.PostfixedDepthFirstIterator.__init__()=logilab.common.tree.PostfixedDepthFirstIterator-class.html#__init__,Method logilab.common.tree.PrefixedDepthFirstIterator.__init__()=logilab.common.tree.PrefixedDepthFirstIterator-class.html#__init__,Method logilab.common.umessage.UMessage.__init__()=logilab.common.umessage.UMessage-class.html#__init__,Method logilab.common.ureports.html_writer.HTMLWriter.__init__()=logilab.common.ureports.html_writer.HTMLWriter-class.html#__init__,Method logilab.common.ureports.nodes.BaseComponent.__init__()=logilab.common.ureports.nodes.BaseComponent-class.html#__init__,Method logilab.common.ureports.nodes.BaseLayout.__init__()=logilab.common.ureports.nodes.BaseLayout-class.html#__init__,Method logilab.common.ureports.nodes.Image.__init__()=logilab.common.ureports.nodes.Image-class.html#__init__,Method logilab.common.ureports.nodes.Link.__init__()=logilab.common.ureports.nodes.Link-class.html#__init__,Method logilab.common.ureports.nodes.Section.__init__()=logilab.common.ureports.nodes.Section-class.html#__init__,Method logilab.common.ureports.nodes.Table.__init__()=logilab.common.ureports.nodes.Table-class.html#__init__,Method logilab.common.ureports.nodes.Text.__init__()=logilab.common.ureports.nodes.Text-class.html#__init__,Method logilab.common.urllib2ext.HTTPGssapiAuthHandler.__init__()=logilab.common.urllib2ext.HTTPGssapiAuthHandler-class.html#__init__,Method logilab.common.vcgutils.VCGPrinter.__init__()=logilab.common.vcgutils.VCGPrinter-class.html#__init__,Method logilab.common.visitor.FilteredIterator.__init__()=logilab.common.visitor.FilteredIterator-class.html#__init__,Method logilab.common.visitor.Visitor.__init__()=logilab.common.visitor.Visitor-class.html#__init__"><a title="logilab.common.cache.Cache.__init__
logilab.common.changelog.ChangeLog.__init__
logilab.common.changelog.ChangeLogEntry.__init__
logilab.common.clcommands.Command.__init__
logilab.common.clcommands.CommandLine.__init__
logilab.common.configuration.Configuration.__init__
logilab.common.configuration.ConfigurationMixIn.__init__
logilab.common.configuration.OptionsManager2ConfigurationAdapter.__init__
logilab.common.configuration.OptionsManagerMixIn.__init__
logilab.common.configuration.OptionsProviderMixIn.__init__
logilab.common.debugger.Debugger.__init__
logilab.common.decorators.cached_decorator.__init__
logilab.common.decorators.cachedproperty.__init__
logilab.common.decorators.classproperty.__init__
logilab.common.decorators.iclassmethod.__init__
logilab.common.decorators.wproperty.__init__
logilab.common.deprecation.DeprecationManager.__init__
logilab.common.deprecation.DeprecationWrapper.__init__
logilab.common.dictattr.__init__
logilab.common.fileutils.ProtectedFile.__init__
logilab.common.graph.DotBackend.__init__
logilab.common.graph.GraphGenerator.__init__
logilab.common.logging_ext.ColorFormatter.__init__
logilab.common.modutils.LazyObject.__init__
logilab.common.optik_ext.Option.__init__
logilab.common.optik_ext.OptionParser.__init__
logilab.common.optparser.OptionParser.__init__
logilab.common.proc.MemorySentinel.__init__
logilab.common.proc.ProcInfo.__init__
logilab.common.proc.ProcInfoLoader.__init__
logilab.common.proc.ResourceController.__init__
logilab.common.registry.MultiPredicate.__init__
logilab.common.registry.NoSelectableObject.__init__
logilab.common.registry.NotPredicate.__init__
logilab.common.registry.RegistrableInstance.__init__
logilab.common.registry.Registry.__init__
logilab.common.registry.RegistryStore.__init__
logilab.common.registry.traced_selection.__init__
logilab.common.registry.yes.__init__
logilab.common.shellutils.ProgressBar.__init__
logilab.common.shellutils.RawInput.__init__
logilab.common.shellutils.progress.__init__
logilab.common.shellutils.pushd.__init__
logilab.common.sphinxutils.ModuleGenerator.__init__
logilab.common.table.Table.__init__
logilab.common.table.TableCellRenderer.__init__
logilab.common.table.TableStyle.__init__
logilab.common.table.TableStyleSheet.__init__
logilab.common.table.TableWriter.__init__
logilab.common.tasksqueue.Task.__init__
logilab.common.tempattr.__init__
logilab.common.tree.BinaryNode.__init__
logilab.common.tree.ListNode.__init__
logilab.common.tree.Node.__init__
logilab.common.tree.PostfixedDepthFirstIterator.__init__
logilab.common.tree.PrefixedDepthFirstIterator.__init__
logilab.common.umessage.UMessage.__init__
logilab.common.ureports.html_writer.HTMLWriter.__init__
logilab.common.ureports.nodes.BaseComponent.__init__
logilab.common.ureports.nodes.BaseLayout.__init__
logilab.common.ureports.nodes.Image.__init__
logilab.common.ureports.nodes.Link.__init__
logilab.common.ureports.nodes.Section.__init__
logilab.common.ureports.nodes.Table.__init__
logilab.common.ureports.nodes.Text.__init__
logilab.common.urllib2ext.HTTPGssapiAuthHandler.__init__
logilab.common.vcgutils.VCGPrinter.__init__
logilab.common.visitor.FilteredIterator.__init__
logilab.common.visitor.Visitor.__init__" class="py-name" href="#" onclick="return doclink('link-14', '__init__', 'link-14');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">filepath</tt><tt class="py-op">,</tt> <tt class="py-name">mode</tt><tt class="py-op">)</tt> </tt>
</div><a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line"> </tt>
<a name="ProtectedFile._restore_mode"></a><div id="ProtectedFile._restore_mode-def"><a name="L155"></a><tt class="py-lineno">155</tt> <a class="py-toggle" href="#" id="ProtectedFile._restore_mode-toggle" onclick="return toggle('ProtectedFile._restore_mode');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils.ProtectedFile-class.html#_restore_mode">_restore_mode</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProtectedFile._restore_mode-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProtectedFile._restore_mode-expanded"><a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">        <tt class="py-docstring">"""restores the original mode if needed"""</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mode_changed</tt><tt class="py-op">:</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">            <tt class="py-name">chmod</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name" targets="Variable logilab.common.clcommands.Command.name=logilab.common.clcommands.Command-class.html#name,Variable logilab.common.clcommands.ListCommandsCommand.name=logilab.common.clcommands.ListCommandsCommand-class.html#name,Variable logilab.common.configuration.OptionsProviderMixIn.name=logilab.common.configuration.OptionsProviderMixIn-class.html#name,Method logilab.common.proc.ProcInfo.name()=logilab.common.proc.ProcInfo-class.html#name"><a title="logilab.common.clcommands.Command.name
logilab.common.clcommands.ListCommandsCommand.name
logilab.common.configuration.OptionsProviderMixIn.name
logilab.common.proc.ProcInfo.name" class="py-name" href="#" onclick="return doclink('link-15', 'name', 'link-15');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">original_mode</tt><tt class="py-op">)</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">            <tt class="py-comment"># Don't re-chmod in case of several restore</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mode_changed</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line"> </tt>
<a name="ProtectedFile.close"></a><div id="ProtectedFile.close-def"><a name="L162"></a><tt class="py-lineno">162</tt> <a class="py-toggle" href="#" id="ProtectedFile.close-toggle" onclick="return toggle('ProtectedFile.close');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils.ProtectedFile-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProtectedFile.close-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProtectedFile.close-expanded"><a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">        <tt class="py-docstring">"""restore mode before closing"""</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_restore_mode</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">        <tt class="py-name">FileIO</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method logilab.common.fileutils.ProtectedFile.close()=logilab.common.fileutils.ProtectedFile-class.html#close"><a title="logilab.common.fileutils.ProtectedFile.close" class="py-name" href="#" onclick="return doclink('link-16', 'close', 'link-16');">close</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line"> </tt>
<a name="ProtectedFile.__del__"></a><div id="ProtectedFile.__del__-def"><a name="L167"></a><tt class="py-lineno">167</tt> <a class="py-toggle" href="#" id="ProtectedFile.__del__-toggle" onclick="return toggle('ProtectedFile.__del__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils.ProtectedFile-class.html#__del__">__del__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ProtectedFile.__del__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ProtectedFile.__del__-expanded"><a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">closed</tt><tt class="py-op">:</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="logilab.common.fileutils.ProtectedFile.close" class="py-name" href="#" onclick="return doclink('link-17', 'close', 'link-16');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line"> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line"> </tt>
<a name="UnresolvableError"></a><div id="UnresolvableError-def"><a name="L172"></a><tt class="py-lineno">172</tt> <a class="py-toggle" href="#" id="UnresolvableError-toggle" onclick="return toggle('UnresolvableError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="logilab.common.fileutils.UnresolvableError-class.html">UnresolvableError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UnresolvableError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnresolvableError-expanded"><a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line">    <tt class="py-docstring">"""Exception raised by relative path when it's unable to compute relative</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-docstring">    path between two paths.</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
</div><a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"> </tt>
<a name="relative_path"></a><div id="relative_path-def"><a name="L177"></a><tt class="py-lineno">177</tt> <a class="py-toggle" href="#" id="relative_path-toggle" onclick="return toggle('relative_path');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#relative_path">relative_path</a><tt class="py-op">(</tt><tt class="py-param">from_file</tt><tt class="py-op">,</tt> <tt class="py-param">to_file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="relative_path-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="relative_path-expanded"><a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line">    <tt class="py-docstring">"""Try to get a relative path from `from_file` to `to_file`</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-docstring">    (path will be absolute if to_file is an absolute file). This function</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring">    is useful to create link in `from_file` to `to_file`. This typical use</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring">    case is used in this function description.</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring">    If both files are relative, they're expected to be relative to the same</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"><tt class="py-docstring">    directory.</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='toto/index.html', to_file='index.html')</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line"><tt class="py-docstring">    '../index.html'</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='index.html', to_file='toto/index.html')</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line"><tt class="py-docstring">    'toto/index.html'</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='tutu/index.html', to_file='toto/index.html')</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"><tt class="py-docstring">    '../toto/index.html'</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='toto/index.html', to_file='/index.html')</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring">    '/index.html'</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='/toto/index.html', to_file='/index.html')</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">    '../index.html'</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='/toto/index.html', to_file='/toto/summary.html')</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line"><tt class="py-docstring">    'summary.html'</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='index.html', to_file='index.html')</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line"><tt class="py-docstring">    ''</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='/index.html', to_file='toto/index.html')</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">    Traceback (most recent call last):</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring">      File "&lt;string&gt;", line 1, in ?</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">      File "&lt;stdin&gt;", line 37, in relative_path</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring">    UnresolvableError</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; relative_path( from_file='/index.html', to_file='/index.html')</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"><tt class="py-docstring">    ''</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt;</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-docstring">    :type from_file: str</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring">    :param from_file: source file (where links will be inserted)</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">    :type to_file: str</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line"><tt class="py-docstring">    :param to_file: target file (on which links point)</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line"><tt class="py-docstring">    :raise UnresolvableError: if it has been unable to guess a correct path</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"><tt class="py-docstring">    :rtype: str</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"><tt class="py-docstring">    :return: the relative path of `to_file` from `from_file`</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line">    <tt class="py-name">from_file</tt> <tt class="py-op">=</tt> <tt class="py-name">normpath</tt><tt class="py-op">(</tt><tt class="py-name">from_file</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">to_file</tt> <tt class="py-op">=</tt> <tt class="py-name">normpath</tt><tt class="py-op">(</tt><tt class="py-name">to_file</tt><tt class="py-op">)</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">from_file</tt> <tt class="py-op">==</tt> <tt class="py-name">to_file</tt><tt class="py-op">:</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">''</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">isabs</tt><tt class="py-op">(</tt><tt class="py-name">to_file</tt><tt class="py-op">)</tt><tt class="py-op">:</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-keyword">not</tt> <tt class="py-name">isabs</tt><tt class="py-op">(</tt><tt class="py-name">from_file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">to_file</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line">    <tt class="py-keyword">elif</tt> <tt class="py-name">isabs</tt><tt class="py-op">(</tt><tt class="py-name">from_file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt id="link-18" class="py-name" targets="Class logilab.common.fileutils.UnresolvableError=logilab.common.fileutils.UnresolvableError-class.html"><a title="logilab.common.fileutils.UnresolvableError" class="py-name" href="#" onclick="return doclink('link-18', 'UnresolvableError', 'link-18');">UnresolvableError</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line">    <tt class="py-name">from_parts</tt> <tt class="py-op">=</tt> <tt class="py-name">from_file</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>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line">    <tt class="py-name">to_parts</tt> <tt class="py-op">=</tt> <tt class="py-name">to_file</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>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">    <tt class="py-name">idem</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</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="L233"></a><tt class="py-lineno">233</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">from_parts</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line">        <tt class="py-name">dirname</tt> <tt class="py-op">=</tt> <tt class="py-name">from_parts</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Variable logilab.common.cache.Cache.pop=logilab.common.cache.Cache-class.html#pop,Method logilab.common.tree.ListNode.pop()=logilab.common.tree.ListNode-class.html#pop"><a title="logilab.common.cache.Cache.pop
logilab.common.tree.ListNode.pop" class="py-name" href="#" onclick="return doclink('link-19', 'pop', 'link-19');">pop</a></tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">idem</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">to_parts</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">1</tt> <tt class="py-keyword">and</tt> <tt class="py-name">dirname</tt> <tt class="py-op">==</tt> <tt class="py-name">to_parts</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line">            <tt class="py-name">to_parts</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="logilab.common.cache.Cache.pop
logilab.common.tree.ListNode.pop" class="py-name" href="#" onclick="return doclink('link-20', 'pop', 'link-19');">pop</a></tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">            <tt class="py-name">idem</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line">            <tt class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name" targets="Method logilab.common.tree.ListNode.append()=logilab.common.tree.ListNode-class.html#append,Method logilab.common.tree.Node.append()=logilab.common.tree.Node-class.html#append,Method logilab.common.ureports.nodes.BaseLayout.append()=logilab.common.ureports.nodes.BaseLayout-class.html#append"><a title="logilab.common.tree.ListNode.append
logilab.common.tree.Node.append
logilab.common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-21', 'append', 'link-21');">append</a></tt><tt class="py-op">(</tt><tt class="py-string">'..'</tt><tt class="py-op">)</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line">    <tt class="py-name">result</tt> <tt class="py-op">+=</tt> <tt class="py-name">to_parts</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">sep</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="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line"> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line"> </tt>
<a name="norm_read"></a><div id="norm_read-def"><a name="L244"></a><tt class="py-lineno">244</tt> <a class="py-toggle" href="#" id="norm_read-toggle" onclick="return toggle('norm_read');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#norm_read">norm_read</a><tt class="py-op">(</tt><tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="norm_read-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="norm_read-expanded"><a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return the content of the file with normalized line feeds.</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-docstring">    :type path: str</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-docstring">    :param path: path to the file to read</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line"><tt class="py-docstring">    :rtype: str</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line"><tt class="py-docstring">    :return: the content of the file with normalized line feeds</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-keyword">return</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-string">'U'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">read</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt id="link-22" class="py-name" targets="Variable logilab.common.fileutils.norm_read=logilab.common.fileutils-module.html#norm_read"><a title="logilab.common.fileutils.norm_read" class="py-name" href="#" onclick="return doclink('link-22', 'norm_read', 'link-22');">norm_read</a></tt> <tt class="py-op">=</tt> <tt id="link-23" class="py-name"><a title="logilab.common.deprecation.DeprecationManager.deprecated
logilab.common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-23', 'deprecated', 'link-10');">deprecated</a></tt><tt class="py-op">(</tt><tt class="py-string">"use \"open(path, 'U').read()\""</tt><tt class="py-op">)</tt><tt class="py-op">(</tt><tt id="link-24" class="py-name"><a title="logilab.common.fileutils.norm_read" class="py-name" href="#" onclick="return doclink('link-24', 'norm_read', 'link-22');">norm_read</a></tt><tt class="py-op">)</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"> </tt>
<a name="norm_open"></a><div id="norm_open-def"><a name="L256"></a><tt class="py-lineno">256</tt> <a class="py-toggle" href="#" id="norm_open-toggle" onclick="return toggle('norm_open');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#norm_open">norm_open</a><tt class="py-op">(</tt><tt class="py-param">path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="norm_open-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="norm_open-expanded"><a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return a stream for a file with content with normalized line feeds.</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 path: str</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"><tt class="py-docstring">    :param path: path to the file to open</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">    :rtype: file or StringIO</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring">    :return: the opened file with normalized line feeds</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-keyword">return</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-string">'U'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt id="link-25" class="py-name" targets="Variable logilab.common.fileutils.norm_open=logilab.common.fileutils-module.html#norm_open"><a title="logilab.common.fileutils.norm_open" class="py-name" href="#" onclick="return doclink('link-25', 'norm_open', 'link-25');">norm_open</a></tt> <tt class="py-op">=</tt> <tt id="link-26" class="py-name"><a title="logilab.common.deprecation.DeprecationManager.deprecated
logilab.common.deprecation.deprecated" class="py-name" href="#" onclick="return doclink('link-26', 'deprecated', 'link-10');">deprecated</a></tt><tt class="py-op">(</tt><tt class="py-string">"use \"open(path, 'U')\""</tt><tt class="py-op">)</tt><tt class="py-op">(</tt><tt id="link-27" class="py-name"><a title="logilab.common.fileutils.norm_open" class="py-name" href="#" onclick="return doclink('link-27', 'norm_open', 'link-25');">norm_open</a></tt><tt class="py-op">)</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"> </tt>
<a name="lines"></a><div id="lines-def"><a name="L268"></a><tt class="py-lineno">268</tt> <a class="py-toggle" href="#" id="lines-toggle" onclick="return toggle('lines');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#lines">lines</a><tt class="py-op">(</tt><tt class="py-param">path</tt><tt class="py-op">,</tt> <tt class="py-param">comments</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="lines-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="lines-expanded"><a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return a list of non empty lines in the file located at `path`.</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line"><tt class="py-docstring">    :type path: str</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"><tt class="py-docstring">    :param path: path to the file</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line"><tt class="py-docstring">    :type comments: str or None</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line"><tt class="py-docstring">    :param comments:</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line"><tt class="py-docstring">      optional string which can be used to comment a line in the file</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line"><tt class="py-docstring">      (i.e. lines starting with this string won't be returned)</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line"><tt class="py-docstring">    :rtype: list</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"><tt class="py-docstring">    :return:</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">      a list of stripped line in the file, without empty and commented</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring">      lines</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line"><tt class="py-docstring">    :warning: at some point this function will probably return an iterator</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line">    <tt class="py-keyword">with</tt> <tt class="py-name">io</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">path</tt><tt class="py-op">)</tt> <tt class="py-keyword">as</tt> <tt class="py-name">stream</tt><tt class="py-op">:</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-28" class="py-name" targets="Function logilab.common.fileutils.stream_lines()=logilab.common.fileutils-module.html#stream_lines"><a title="logilab.common.fileutils.stream_lines" class="py-name" href="#" onclick="return doclink('link-28', 'stream_lines', 'link-28');">stream_lines</a></tt><tt class="py-op">(</tt><tt class="py-name">stream</tt><tt class="py-op">,</tt> <tt class="py-name">comments</tt><tt class="py-op">)</tt> </tt>
</div><a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line"> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line"> </tt>
<a name="stream_lines"></a><div id="stream_lines-def"><a name="L290"></a><tt class="py-lineno">290</tt> <a class="py-toggle" href="#" id="stream_lines-toggle" onclick="return toggle('stream_lines');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#stream_lines">stream_lines</a><tt class="py-op">(</tt><tt class="py-param">stream</tt><tt class="py-op">,</tt> <tt class="py-param">comments</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="stream_lines-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="stream_lines-expanded"><a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">    <tt class="py-docstring">"""Return a list of non empty lines in the given `stream`.</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">    :type stream: object implementing 'xreadlines' or 'readlines'</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line"><tt class="py-docstring">    :param stream: file like object</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-docstring">    :type comments: str or None</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line"><tt class="py-docstring">    :param comments:</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line"><tt class="py-docstring">      optional string which can be used to comment a line in the file</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"><tt class="py-docstring">      (i.e. lines starting with this string won't be returned)</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"><tt class="py-docstring">    :rtype: list</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">    :return:</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring">      a list of stripped line in the file, without empty and commented</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">      lines</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">    :warning: at some point this function will probably return an iterator</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line">        <tt class="py-name">readlines</tt> <tt class="py-op">=</tt> <tt class="py-name">stream</tt><tt class="py-op">.</tt><tt class="py-name">xreadlines</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</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="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line">        <tt class="py-name">readlines</tt> <tt class="py-op">=</tt> <tt class="py-name">stream</tt><tt class="py-op">.</tt><tt class="py-name">readlines</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</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="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">readlines</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</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="L315"></a><tt class="py-lineno">315</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-op">(</tt><tt class="py-name">comments</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</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-name">comments</tt><tt class="py-op">)</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 class="py-name">result</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="logilab.common.tree.ListNode.append
logilab.common.tree.Node.append
logilab.common.ureports.nodes.BaseLayout.append" class="py-name" href="#" onclick="return doclink('link-29', 'append', 'link-21');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><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>
<a name="export"></a><div id="export-def"><a name="L320"></a><tt class="py-lineno">320</tt> <a class="py-toggle" href="#" id="export-toggle" onclick="return toggle('export');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#export">export</a><tt class="py-op">(</tt><tt class="py-param">from_dir</tt><tt class="py-op">,</tt> <tt class="py-param">to_dir</tt><tt class="py-op">,</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line">           <tt class="py-param">blacklist</tt><tt class="py-op">=</tt><tt class="py-name">BASE_BLACKLIST</tt><tt class="py-op">,</tt> <tt class="py-param">ignore_ext</tt><tt class="py-op">=</tt><tt id="link-30" class="py-name"><a title="logilab.common.IGNORED_EXTENSIONS" class="py-name" href="#" onclick="return doclink('link-30', 'IGNORED_EXTENSIONS', 'link-4');">IGNORED_EXTENSIONS</a></tt><tt class="py-op">,</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line">           <tt class="py-param">verbose</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="export-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="export-expanded"><a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line">    <tt class="py-docstring">"""Make a mirror of `from_dir` in `to_dir`, omitting directories and</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring">    files listed in the black list or ending with one of the given</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">    extensions.</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line"><tt class="py-docstring">    :type from_dir: str</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line"><tt class="py-docstring">    :param from_dir: directory to export</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line"><tt class="py-docstring">    :type to_dir: str</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line"><tt class="py-docstring">    :param to_dir: destination directory</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line"><tt class="py-docstring">    :type blacklist: list or tuple</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line"><tt class="py-docstring">    :param blacklist:</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line"><tt class="py-docstring">      list of files or directories to ignore, default to the content of</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line"><tt class="py-docstring">      `BASE_BLACKLIST`</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line"><tt class="py-docstring">    :type ignore_ext: list or tuple</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line"><tt class="py-docstring">    :param ignore_ext:</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line"><tt class="py-docstring">      list of extensions to ignore, default to  the content of</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"><tt class="py-docstring">      `IGNORED_EXTENSIONS`</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 verbose: bool</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line"><tt class="py-docstring">    :param verbose:</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line"><tt class="py-docstring">      flag indicating whether information about exported files should be</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"><tt class="py-docstring">      printed to stderr, default to False</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line">        <tt class="py-name">mkdir</tt><tt class="py-op">(</tt><tt class="py-name">to_dir</tt><tt class="py-op">)</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt><tt class="py-op">:</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> <tt class="py-comment"># FIXME we should use "exists" if the point is about existing dir</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line">             <tt class="py-comment"># else (permission problems?) shouldn't return / raise ?</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">dirnames</tt><tt class="py-op">,</tt> <tt class="py-name">filenames</tt> <tt class="py-keyword">in</tt> <tt id="link-31" class="py-name"><a title="logilab.common.umessage.UMessage.walk" class="py-name" href="#" onclick="return doclink('link-31', 'walk', 'link-1');">walk</a></tt><tt class="py-op">(</tt><tt class="py-name">from_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">norecurs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">blacklist</tt><tt class="py-op">:</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line">            <tt class="py-keyword">try</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">dirnames</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="logilab.common.table.Table.remove
logilab.common.tasksqueue.PrioritizedTasksQueue.remove
logilab.common.tree.BinaryNode.remove
logilab.common.tree.ListNode.remove
logilab.common.tree.Node.remove" class="py-name" href="#" onclick="return doclink('link-32', 'remove', 'link-0');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">norecurs</tt><tt class="py-op">)</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line">            <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">dirname</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dirnames</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">src</tt> <tt class="py-op">=</tt> <tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">dirname</tt><tt class="py-op">)</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line">            <tt class="py-name">dest</tt> <tt class="py-op">=</tt> <tt class="py-name">to_dir</tt> <tt class="py-op">+</tt> <tt class="py-name">src</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">from_dir</tt><tt class="py-op">)</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-keyword">if</tt> <tt class="py-name">isdir</tt><tt class="py-op">(</tt><tt class="py-name">src</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-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">dest</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line">                    <tt class="py-name">mkdir</tt><tt class="py-op">(</tt><tt class="py-name">dest</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">for</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">filenames</tt><tt class="py-op">:</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line">            <tt class="py-comment"># don't include binary files</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line">            <tt class="py-comment"># endswith does not accept tuple in 2.4</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt id="link-33" class="py-name" targets="Variable logilab.common.compat.any=logilab.common.compat-module.html#any"><a title="logilab.common.compat.any" class="py-name" href="#" onclick="return doclink('link-33', 'any', 'link-33');">any</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-name">ext</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">ext</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ignore_ext</tt><tt class="py-op">]</tt><tt class="py-op">)</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">continue</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line">            <tt class="py-name">src</tt> <tt class="py-op">=</tt> <tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">,</tt> <tt class="py-name">filename</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">dest</tt> <tt class="py-op">=</tt> <tt class="py-name">to_dir</tt> <tt class="py-op">+</tt> <tt class="py-name">src</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">from_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</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">if</tt> <tt class="py-name">verbose</tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line">                <tt class="py-keyword">print</tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt class="py-string">'-&gt;'</tt><tt class="py-op">,</tt> <tt class="py-name">dest</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">=</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">)</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">dest</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line">                <tt id="link-34" class="py-name"><a title="logilab.common.table.Table.remove
logilab.common.tasksqueue.PrioritizedTasksQueue.remove
logilab.common.tree.BinaryNode.remove
logilab.common.tree.ListNode.remove
logilab.common.tree.Node.remove" class="py-name" href="#" onclick="return doclink('link-34', 'remove', 'link-0');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">dest</tt><tt class="py-op">)</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line">            <tt class="py-name">shutil</tt><tt class="py-op">.</tt><tt class="py-name">copy2</tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt class="py-name">dest</tt><tt class="py-op">)</tt> </tt>
</div><a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"> </tt>
<a name="remove_dead_links"></a><div id="remove_dead_links-def"><a name="L379"></a><tt class="py-lineno">379</tt> <a class="py-toggle" href="#" id="remove_dead_links-toggle" onclick="return toggle('remove_dead_links');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="logilab.common.fileutils-module.html#remove_dead_links">remove_dead_links</a><tt class="py-op">(</tt><tt class="py-param">directory</tt><tt class="py-op">,</tt> <tt class="py-param">verbose</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="remove_dead_links-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="remove_dead_links-expanded"><a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line">    <tt class="py-docstring">"""Recursively traverse directory and remove all dead links.</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line"><tt class="py-docstring">    :type directory: str</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line"><tt class="py-docstring">    :param directory: directory to cleanup</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">    :type verbose: bool</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line"><tt class="py-docstring">    :param verbose:</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line"><tt class="py-docstring">      flag indicating whether information about deleted links should be</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line"><tt class="py-docstring">      printed to stderr, default to False</tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">dirpath</tt><tt class="py-op">,</tt> <tt class="py-name">dirname</tt><tt class="py-op">,</tt> <tt class="py-name">filenames</tt> <tt class="py-keyword">in</tt> <tt id="link-35" class="py-name"><a title="logilab.common.umessage.UMessage.walk" class="py-name" href="#" onclick="return doclink('link-35', 'walk', 'link-1');">walk</a></tt><tt class="py-op">(</tt><tt class="py-name">directory</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dirnames</tt> <tt class="py-op">+</tt> <tt class="py-name">filenames</tt><tt class="py-op">:</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line">            <tt class="py-name">src</tt> <tt class="py-op">=</tt> <tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">dirpath</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">islink</tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">exists</tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">verbose</tt><tt class="py-op">:</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line">                    <tt class="py-keyword">print</tt><tt class="py-op">(</tt><tt class="py-string">'remove dead link'</tt><tt class="py-op">,</tt> <tt class="py-name">src</tt><tt class="py-op">)</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line">                <tt id="link-36" class="py-name"><a title="logilab.common.table.Table.remove
logilab.common.tasksqueue.PrioritizedTasksQueue.remove
logilab.common.tree.BinaryNode.remove
logilab.common.tree.ListNode.remove
logilab.common.tree.Node.remove" class="py-name" href="#" onclick="return doclink('link-36', 'remove', 'link-0');">remove</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt> </tt>
</div><a name="L397"></a><tt class="py-lineno">397</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>&nbsp;&nbsp;&nbsp;<a
        href="logilab.common-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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 Fri Dec  8 00:00:57 2017
    </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>

APT Browse - Built by Thomas Orozco.