Changeset 47be2684 in flex_extract.git for Documentation/html/_modules/tools.html


Ignore:
Timestamp:
Oct 28, 2020, 10:28:24 AM (4 years ago)
Author:
Leopold Haimberger <leopold.haimberger@…>
Branches:
ctbto, dev
Children:
75db9b0
Parents:
697b8d0
Message:

Adaptations to allow for a system installation with separate user and system path. Updated documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • Documentation/html/_modules/tools.html

    r08c9091 r47be2684  
    411411                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    412412                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The name of the ECMWF server name where the&#39;</span>
    413                         <span class="s1">&#39;job script is to be submitted &#39;</span> 
     413                        <span class="s1">&#39;job script is to be submitted &#39;</span>
    414414                        <span class="s1">&#39;(e.g. ecgate | cca | ccb)&#39;</span><span class="p">)</span>
    415415
    … …  
    786786    <span class="sd">&#39;&#39;&#39;Creates a directory.</span>
    787787
    788 <span class="sd">    If the directory already exists, an information is printed and the creation </span>
     788<span class="sd">    If the directory already exists, an information is printed and the creation</span>
    789789<span class="sd">    skipped. The program stops only if there is another problem.</span>
    790790
    … …  
    10181018<span class="sd">    ----------</span>
    10191019<span class="sd">    cmd_list : list of str</span>
    1020 <span class="sd">        A list of the components for the command line execution. </span>
    1021 <span class="sd">        They will be concatenated with blank space for the command </span>
     1020<span class="sd">        A list of the components for the command line execution.</span>
     1021<span class="sd">        They will be concatenated with blank space for the command</span>
    10221022<span class="sd">        to be submitted, like [&#39;mv&#39;, file1, file2] for mv file1 file2.</span>
    10231023
    … …  
    10721072
    10731073    <span class="k">return</span> <span class="n">start_period</span><span class="p">,</span> <span class="n">end_period</span></div>
     1074
     1075
     1076<div class="viewcode-block" id="check_for_string_in_file"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.check_for_string_in_file">[docs]</a><span class="k">def</span> <span class="nf">check_for_string_in_file</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="n">search_string</span><span class="p">):</span>
     1077    <span class="sd">&quot;&quot;&quot;</span>
     1078<span class="sd">    Search for a specific string in a file and return True if</span>
     1079<span class="sd">    the string was found.</span>
     1080
     1081<span class="sd">    Parameters</span>
     1082<span class="sd">    ----------</span>
     1083<span class="sd">    filepath : str</span>
     1084<span class="sd">        The full file path which is to be examined.</span>
     1085
     1086<span class="sd">    search_string : str</span>
     1087<span class="sd">        The string which is looked up for in the file.</span>
     1088
     1089<span class="sd">    Return</span>
     1090<span class="sd">    ------</span>
     1091<span class="sd">    Boolean :</span>
     1092<span class="sd">        True : String was found</span>
     1093<span class="sd">        False : String was not found</span>
     1094<span class="sd">    &quot;&quot;&quot;</span>
     1095    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fio</span><span class="p">:</span>
     1096        <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">fio</span><span class="p">:</span>
     1097            <span class="k">if</span> <span class="n">search_string</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
     1098                <span class="k">return</span> <span class="kc">True</span>
     1099    <span class="k">return</span> <span class="kc">False</span></div>
     1100
     1101
     1102<div class="viewcode-block" id="overwrite_lines_in_file"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.overwrite_lines_in_file">[docs]</a><span class="k">def</span> <span class="nf">overwrite_lines_in_file</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="n">search_string</span><span class="p">,</span> <span class="n">sub_string</span><span class="p">):</span>
     1103    <span class="sd">&quot;&quot;&quot;</span>
     1104<span class="sd">    Overwrites lines which contain the given search string with the</span>
     1105<span class="sd">    substitution string.</span>
     1106
     1107<span class="sd">    Parameters</span>
     1108<span class="sd">    ----------</span>
     1109<span class="sd">    search_string : str</span>
     1110<span class="sd">        The string which is looked up for in the file.</span>
     1111
     1112<span class="sd">    sub_string : str</span>
     1113<span class="sd">        The string which overwrites the search string.</span>
     1114
     1115<span class="sd">    Return</span>
     1116<span class="sd">    ------</span>
     1117<span class="sd">    &quot;&quot;&quot;</span>
     1118    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fio</span><span class="p">:</span>
     1119        <span class="n">data</span> <span class="o">=</span> <span class="n">fio</span><span class="o">.</span><span class="n">readlines</span><span class="p">()</span>
     1120
     1121    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fio</span><span class="p">:</span>
     1122        <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
     1123            <span class="k">if</span> <span class="n">search_string</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
     1124                <span class="n">fio</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">sub_string</span><span class="p">)</span>
     1125            <span class="k">else</span><span class="p">:</span>
     1126                <span class="n">fio</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
     1127
     1128    <span class="k">return</span></div>
     1129
    10741130</pre></div>
    10751131
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG