source: flex_extract.git/Documentation/html/_modules/UioFiles.html @ eca358d

ctbtodev
Last change on this file since eca358d was eca358d, checked in by Anne Philipp <anne.philipp@…>, 4 years ago

updated online documentation with links on index page
  • Property mode set to 100644
File size: 16.2 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>UioFiles &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21 
22   
23      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24        <script type="text/javascript" src="../_static/jquery.js"></script>
25        <script type="text/javascript" src="../_static/underscore.js"></script>
26        <script type="text/javascript" src="../_static/doctools.js"></script>
27        <script type="text/javascript" src="../_static/language_data.js"></script>
28        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
29   
30    <script type="text/javascript" src="../_static/js/theme.js"></script>
31
32   
33
34 
35  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
36  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
37  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
38  <link rel="stylesheet" href="../_static/css/theme_overrides.css" type="text/css" />
39    <link rel="index" title="Index" href="../genindex.html" />
40    <link rel="search" title="Search" href="../search.html" /> 
41</head>
42
43<body class="wy-body-for-nav">
44
45   
46  <div class="wy-grid-for-nav">
47   
48    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49      <div class="wy-side-scroll">
50        <div class="wy-side-nav-search" >
51         
52
53         
54            <a href="../index.html" class="icon icon-home"> flex_extract
55         
56
57         
58          </a>
59
60         
61           
62           
63              <div class="version">
64                7.1
65              </div>
66           
67         
68
69         
70<div role="search">
71  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72    <input type="text" name="q" placeholder="Search docs" />
73    <input type="hidden" name="check_keywords" value="yes" />
74    <input type="hidden" name="area" value="default" />
75  </form>
76</div>
77
78         
79        </div>
80
81        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82         
83           
84           
85             
86           
87           
88              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
89<ul>
90<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
91<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick Start</a></li>
92<li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li>
93<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a></li>
94<li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li>
95<li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li>
96<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
97<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
98<li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li>
99<li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li>
100</ul>
101
102           
103         
104        </div>
105      </div>
106    </nav>
107
108    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
109
110     
111      <nav class="wy-nav-top" aria-label="top navigation">
112       
113          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
114          <a href="../index.html">flex_extract</a>
115       
116      </nav>
117
118
119      <div class="wy-nav-content">
120       
121        <div class="rst-content">
122       
123         
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139<div role="navigation" aria-label="breadcrumbs navigation">
140
141  <ul class="wy-breadcrumbs">
142   
143      <li><a href="../index.html">Docs</a> &raquo;</li>
144       
145          <li><a href="index.html">Module code</a> &raquo;</li>
146       
147      <li>UioFiles</li>
148   
149   
150      <li class="wy-breadcrumbs-aside">
151       
152      </li>
153   
154  </ul>
155
156 
157  <hr/>
158</div>
159          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
160           <div itemprop="articleBody">
161           
162  <h1>Source code for UioFiles</h1><div class="highlight"><pre>
163<span></span><span class="ch">#!/usr/bin/env python3</span>
164<span class="c1"># -*- coding: utf-8 -*-</span>
165<span class="c1">#*******************************************************************************</span>
166<span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span>
167<span class="c1">#</span>
168<span class="c1"># @Date: October 2014</span>
169<span class="c1">#</span>
170<span class="c1"># @Change History:</span>
171<span class="c1">#</span>
172<span class="c1">#    November 2015 - Leopold Haimberger (University of Vienna):</span>
173<span class="c1">#        - modified method list_files to work with glob instead of listdir</span>
174<span class="c1">#        - added pattern search in method list_files</span>
175<span class="c1">#</span>
176<span class="c1">#    February - December 2018 - Anne Philipp (University of Vienna):</span>
177<span class="c1">#        - applied PEP8 style guide</span>
178<span class="c1">#        - added documentation</span>
179<span class="c1">#        - optimisation of method list_files since it didn&#39;t work correctly</span>
180<span class="c1">#          for sub directories</span>
181<span class="c1">#        - additional speed up of method list_files</span>
182<span class="c1">#        - modified the class so that it is initiated with a pattern instead</span>
183<span class="c1">#          of suffixes. Gives more precision in selection of files.</span>
184<span class="c1">#        - added delete method</span>
185<span class="c1">#</span>
186<span class="c1"># @License:</span>
187<span class="c1">#    (C) Copyright 2014-2019.</span>
188<span class="c1">#    Anne Philipp, Leopold Haimberger</span>
189<span class="c1">#</span>
190<span class="c1">#    SPDX-License-Identifier: CC-BY-4.0</span>
191<span class="c1">#</span>
192<span class="c1">#    This work is licensed under the Creative Commons Attribution 4.0</span>
193<span class="c1">#    International License. To view a copy of this license, visit</span>
194<span class="c1">#    http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
195<span class="c1">#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
196<span class="c1">#*******************************************************************************</span>
197
198<span class="c1"># ------------------------------------------------------------------------------</span>
199<span class="c1"># MODULES</span>
200<span class="c1"># ------------------------------------------------------------------------------</span>
201<span class="kn">import</span> <span class="nn">os</span>
202<span class="kn">import</span> <span class="nn">sys</span>
203<span class="kn">import</span> <span class="nn">fnmatch</span>
204
205<span class="c1"># software specific modules from flex_extract</span>
206<span class="c1">#pylint: disable=wrong-import-position</span>
207<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../&#39;</span><span class="p">)</span>
208<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="k">import</span> <span class="n">silent_remove</span><span class="p">,</span> <span class="n">get_list_as_string</span>
209<span class="c1">#pylint: enable=wrong-import-position</span>
210
211<span class="c1"># ------------------------------------------------------------------------------</span>
212<span class="c1"># CLASS</span>
213<span class="c1"># ------------------------------------------------------------------------------</span>
214
215<div class="viewcode-block" id="UioFiles"><a class="viewcode-back" href="../Documentation/Api/api_python.html#UioFiles.UioFiles">[docs]</a><span class="k">class</span> <span class="nc">UioFiles</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
216    <span class="sd">&quot;&quot;&quot;Collection of files matching a specific pattern.</span>
217
218<span class="sd">    The pattern can contain regular expressions for the files.</span>
219<span class="sd">    The files are listed and can be transformed to a single string or</span>
220<span class="sd">    they can be deleted.</span>
221
222<span class="sd">    Attributes</span>
223<span class="sd">    ----------</span>
224<span class="sd">    path : str</span>
225<span class="sd">        Directory where to list the files.</span>
226
227<span class="sd">    pattern : str</span>
228<span class="sd">        Regular expression pattern. For example: &#39;*.grb&#39;</span>
229
230<span class="sd">    files : list of str</span>
231<span class="sd">        List of files matching the pattern in the path.</span>
232<span class="sd">    &quot;&quot;&quot;</span>
233    <span class="c1"># --------------------------------------------------------------------------</span>
234    <span class="c1"># CLASS METHODS</span>
235    <span class="c1"># --------------------------------------------------------------------------</span>
236    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">pattern</span><span class="p">):</span>
237        <span class="sd">&quot;&quot;&quot;Assignes a specific pattern for these files.</span>
238
239<span class="sd">        Parameters</span>
240<span class="sd">        ----------</span>
241<span class="sd">        path : str</span>
242<span class="sd">            Directory where to list the files.</span>
243
244<span class="sd">        pattern : str</span>
245<span class="sd">            Regular expression pattern. For example: &#39;*.grb&#39;</span>
246
247<span class="sd">        Return</span>
248<span class="sd">        ------</span>
249
250<span class="sd">        &quot;&quot;&quot;</span>
251
252        <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="o">=</span> <span class="n">path</span>
253        <span class="bp">self</span><span class="o">.</span><span class="n">pattern</span> <span class="o">=</span> <span class="n">pattern</span>
254        <span class="bp">self</span><span class="o">.</span><span class="n">files</span> <span class="o">=</span> <span class="p">[]</span>
255
256        <span class="bp">self</span><span class="o">.</span><span class="n">_list_files</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
257
258        <span class="k">return</span>
259
260
261    <span class="k">def</span> <span class="nf">_list_files</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
262        <span class="sd">&quot;&quot;&quot;Lists all files in the directory with the matching</span>
263<span class="sd">        regular expression pattern.</span>
264
265<span class="sd">        Parameters</span>
266<span class="sd">        ----------</span>
267<span class="sd">        path : str</span>
268<span class="sd">            Path to the files.</span>
269
270<span class="sd">        Return</span>
271<span class="sd">        ------</span>
272
273<span class="sd">        &quot;&quot;&quot;</span>
274        <span class="c1"># Get the absolute path</span>
275        <span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
276
277        <span class="c1"># get all files in the dir and subdir as absolut path</span>
278            <span class="c1"># pylint: disable=W0612</span>
279        <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">dirnames</span><span class="p">,</span> <span class="n">filenames</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
280            <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">filenames</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">pattern</span><span class="p">):</span>
281                <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">filename</span><span class="p">))</span>
282
283        <span class="k">return</span>
284
285
286    <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
287        <span class="sd">&quot;&quot;&quot;Converts the list of files into a single string.</span>
288<span class="sd">        The entries are sepereated by &quot;,&quot; sign.</span>
289
290<span class="sd">        Parameters</span>
291<span class="sd">        ----------</span>
292
293<span class="sd">        Return</span>
294<span class="sd">        ------</span>
295<span class="sd">        files_string : str</span>
296<span class="sd">            The content of the list as a single string.</span>
297<span class="sd">        &quot;&quot;&quot;</span>
298
299        <span class="n">filenames</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
300        <span class="n">files_string</span> <span class="o">=</span> <span class="n">get_list_as_string</span><span class="p">(</span><span class="n">filenames</span><span class="p">,</span> <span class="n">concatenate_sign</span><span class="o">=</span><span class="s1">&#39;, &#39;</span><span class="p">)</span>
301
302        <span class="k">return</span> <span class="n">files_string</span>
303
304
305<div class="viewcode-block" id="UioFiles.delete_files"><a class="viewcode-back" href="../Documentation/Api/api_python.html#UioFiles.UioFiles.delete_files">[docs]</a>    <span class="k">def</span> <span class="nf">delete_files</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
306        <span class="sd">&quot;&quot;&quot;Deletes the files.</span>
307
308<span class="sd">        Parameters</span>
309<span class="sd">        ----------</span>
310
311<span class="sd">        Return</span>
312<span class="sd">        ------</span>
313
314<span class="sd">        &quot;&quot;&quot;</span>
315
316        <span class="k">for</span> <span class="n">old_file</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">:</span>
317            <span class="n">silent_remove</span><span class="p">(</span><span class="n">old_file</span><span class="p">)</span>
318
319        <span class="k">return</span></div></div>
320</pre></div>
321
322           </div>
323           
324          </div>
325          <footer>
326 
327
328  <hr/>
329
330  <div role="contentinfo">
331    <p>
332        &copy; Copyright 2019, Anne Philipp and Leopold Haimberger
333
334    </p>
335  </div>
336  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
337
338</footer>
339
340        </div>
341      </div>
342
343    </section>
344
345  </div>
346 
347
348
349  <script type="text/javascript">
350      jQuery(function () {
351          SphinxRtdTheme.Navigation.enable(true);
352      });
353  </script>
354
355 
356 
357   
358   
359
360</body>
361</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG