Ignore:
Timestamp:
Jan 15, 2019, 1:03:37 AM (5 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
6f951ca
Parents:
0629ba8
Message:

new build of sphinx for updated api

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/Sphinx/build/html/_modules/UioFiles.html

    r274f9ef r2625ca8  
    165165<span class="c1">#        - added pattern search in method list_files</span>
    166166<span class="c1">#</span>
    167 <span class="c1">#    February 2018 - Anne Philipp (University of Vienna):</span>
     167<span class="c1">#    February - December 2018 - Anne Philipp (University of Vienna):</span>
    168168<span class="c1">#        - applied PEP8 style guide</span>
    169169<span class="c1">#        - added documentation</span>
    … …  
    173173<span class="c1">#        - modified the class so that it is initiated with a pattern instead</span>
    174174<span class="c1">#          of suffixes. Gives more precision in selection of files.</span>
     175<span class="c1">#        - added delete method</span>
    175176<span class="c1">#</span>
    176177<span class="c1"># @License:</span>
    177 <span class="c1">#    (C) Copyright 2014-2018.</span>
    178 <span class="c1">#</span>
    179 <span class="c1">#    This software is licensed under the terms of the Apache Licence Version 2.0</span>
    180 <span class="c1">#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.</span>
    181 <span class="c1">#</span>
    182 <span class="c1"># @Class Decription:</span>
    183 <span class="c1">#    The class is for file manipulation. It is initiated with a regular</span>
    184 <span class="c1">#    expression pattern for this instance and can produce a list of Files</span>
    185 <span class="c1">#    from the given file pattern. These files can be deleted.</span>
    186 <span class="c1">#</span>
    187 <span class="c1"># @Class Content:</span>
    188 <span class="c1">#    - __init__</span>
    189 <span class="c1">#    - __str__</span>
    190 <span class="c1">#    - __list_files__</span>
    191 <span class="c1">#    - delete_files</span>
    192 <span class="c1">#</span>
    193 <span class="c1"># @Class Attributes:</span>
    194 <span class="c1">#    - pattern</span>
    195 <span class="c1">#    - files</span>
    196 <span class="c1">#</span>
     178<span class="c1">#    (C) Copyright 2014-2019.</span>
     179<span class="c1">#    Anne Philipp, Leopold Haimberger</span>
     180<span class="c1">#</span>
     181<span class="c1">#    This work is licensed under the Creative Commons Attribution 4.0</span>
     182<span class="c1">#    International License. To view a copy of this license, visit</span>
     183<span class="c1">#    http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
     184<span class="c1">#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
    197185<span class="c1">#*******************************************************************************</span>
    198186
    … …  
    204192<span class="kn">import</span> <span class="nn">fnmatch</span>
    205193
    206 <span class="c1"># software specific module from flex_extract</span>
     194<span class="c1"># software specific modules from flex_extract</span>
    207195<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="c1">#import profiling</span>
    209196<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>
    210197
    … …  
    214201
    215202<div class="viewcode-block" id="UioFiles"><a class="viewcode-back" href="../api.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">&#39;&#39;&#39;Class to manipulate files. At initialisation it has the pattern</span>
    217 <span class="sd">    which stores a regular expression pattern for the files, the path</span>
    218 <span class="sd">    to the files and the files already.</span>
     203    <span class="sd">&#39;&#39;&#39;Collection of files matching a specific pattern.</span>
     204
     205<span class="sd">    The pattern can contain regular expressions for the files.</span>
     206<span class="sd">    The files are listed and can be transformed to a single string or</span>
     207<span class="sd">    they can be deleted.</span>
     208
     209<span class="sd">    Attributes</span>
     210<span class="sd">    ----------</span>
     211<span class="sd">    path : str</span>
     212<span class="sd">        Directory where to list the files.</span>
     213
     214<span class="sd">    pattern : str</span>
     215<span class="sd">        Regular expression pattern. For example: &#39;\*.grb&#39;</span>
     216
     217<span class="sd">    files : list of str</span>
     218<span class="sd">        List of files matching the pattern in the path.</span>
    219219<span class="sd">    &#39;&#39;&#39;</span>
    220220    <span class="c1"># --------------------------------------------------------------------------</span>
    221     <span class="c1"># CLASS FUNCTIONS</span>
     221    <span class="c1"># CLASS METHODS</span>
    222222    <span class="c1"># --------------------------------------------------------------------------</span>
    223223    <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>
    … …  
    226226<span class="sd">        Parameters</span>
    227227<span class="sd">        ----------</span>
    228 <span class="sd">        path : :obj:`string`</span>
     228<span class="sd">        path : str</span>
    229229<span class="sd">            Directory where to list the files.</span>
    230230
    231 <span class="sd">        pattern : :obj:`string`</span>
     231<span class="sd">        pattern : str</span>
    232232<span class="sd">            Regular expression pattern. For example: &#39;\*.grb&#39;</span>
    233233
    … …  
    241241        <span class="bp">self</span><span class="o">.</span><span class="n">files</span> <span class="o">=</span> <span class="p">[]</span>
    242242
    243         <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>
     243        <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>
    244244
    245245        <span class="k">return</span>
    246246
    247     <span class="c1">#@profiling.timefn</span>
    248     <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>
     247
     248    <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>
    249249        <span class="sd">&#39;&#39;&#39;Lists all files in the directory with the matching</span>
    250250<span class="sd">        regular expression pattern.</span>
    … …  
    252252<span class="sd">        Parameters</span>
    253253<span class="sd">        ----------</span>
    254 <span class="sd">        path : :obj:`string`</span>
     254<span class="sd">        path : str</span>
    255255<span class="sd">            Path to the files.</span>
    256256
    … …  
    269269        <span class="k">return</span>
    270270
     271
    271272    <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    272273        <span class="sd">&#39;&#39;&#39;Converts the list of files into a single string.</span>
    … …  
    278279<span class="sd">        Return</span>
    279280<span class="sd">        ------</span>
    280 <span class="sd">        files_string : :obj:`string`</span>
     281<span class="sd">        files_string : str</span>
    281282<span class="sd">            The content of the list as a single string.</span>
    282283<span class="sd">        &#39;&#39;&#39;</span>
    … …  
    286287
    287288        <span class="k">return</span> <span class="n">files_string</span>
     289
    288290
    289291<div class="viewcode-block" id="UioFiles.delete_files"><a class="viewcode-back" href="../api.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>
    … …  
    314316  <div role="contentinfo">
    315317    <p>
    316         &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
     318        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger
    317319
    318320    </p>
    … …  
    333335 
    334336
    335     <script type="text/javascript">
    336         var DOCUMENTATION_OPTIONS = {
    337             URL_ROOT:'../',
    338             VERSION:'7.1 alpha',
    339             LANGUAGE:'None',
    340             COLLAPSE_INDEX:false,
    341             FILE_SUFFIX:'.html',
    342             HAS_SOURCE:  true,
    343             SOURCELINK_SUFFIX: '.txt'
    344         };
    345     </script>
    346       <script type="text/javascript" src="../_static/jquery.js"></script>
    347       <script type="text/javascript" src="../_static/underscore.js"></script>
    348       <script type="text/javascript" src="../_static/doctools.js"></script>
    349       <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
     337   
     338   
     339      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
     340        <script type="text/javascript" src="../_static/jquery.js"></script>
     341        <script type="text/javascript" src="../_static/underscore.js"></script>
     342        <script type="text/javascript" src="../_static/doctools.js"></script>
     343   
    350344
    351345 
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG