Changes in Documentation/html/Documentation/Api/api_python.html [47be2684:08c9091] in flex_extract.git
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
Documentation/html/Documentation/Api/api_python.html
r47be2684 r08c9091 2494 2494 <p>This module contains a collection of diverse tasks within flex_extract.</p> 2495 2495 <dl class="function"> 2496 <dt id="tools.check_for_string_in_file">2497 <code class="sig-prename descclassname">tools.</code><code class="sig-name descname">check_for_string_in_file</code><span class="sig-paren">(</span><em class="sig-param">filepath</em>, <em class="sig-param">search_string</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#check_for_string_in_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.check_for_string_in_file" title="Permalink to this definition">¶</a></dt>2498 <dd><p>Search for a specific string in a file and return True if2499 the string was found.</p>2500 <dl class="field-list simple">2501 <dt class="field-odd">Parameters</dt>2502 <dd class="field-odd"><ul class="simple">2503 <li><p><strong>filepath</strong> (<em>str</em>) – The full file path which is to be examined.</p></li>2504 <li><p><strong>search_string</strong> (<em>str</em>) – The string which is looked up for in the file.</p></li>2505 </ul>2506 </dd>2507 <dt class="field-even">Returns</dt>2508 <dd class="field-even"><p>True : String was found2509 False : String was not found</p>2510 </dd>2511 <dt class="field-odd">Return type</dt>2512 <dd class="field-odd"><p>Boolean</p>2513 </dd>2514 </dl>2515 </dd></dl>2516 2517 <dl class="function">2518 2496 <dt id="tools.clean_up"> 2519 2497 <code class="sig-prename descclassname">tools.</code><code class="sig-name descname">clean_up</code><span class="sig-paren">(</span><em class="sig-param">c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#clean_up"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.clean_up" title="Permalink to this definition">¶</a></dt> … … 2754 2732 <dt class="field-odd">Parameters</dt> 2755 2733 <dd class="field-odd"><p><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</p> 2756 </dd>2757 </dl>2758 </dd></dl>2759 2760 <dl class="function">2761 <dt id="tools.overwrite_lines_in_file">2762 <code class="sig-prename descclassname">tools.</code><code class="sig-name descname">overwrite_lines_in_file</code><span class="sig-paren">(</span><em class="sig-param">filepath</em>, <em class="sig-param">search_string</em>, <em class="sig-param">sub_string</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#overwrite_lines_in_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.overwrite_lines_in_file" title="Permalink to this definition">¶</a></dt>2763 <dd><p>Overwrites lines which contain the given search string with the2764 substitution string.</p>2765 <dl class="field-list simple">2766 <dt class="field-odd">Parameters</dt>2767 <dd class="field-odd"><ul class="simple">2768 <li><p><strong>search_string</strong> (<em>str</em>) – The string which is looked up for in the file.</p></li>2769 <li><p><strong>sub_string</strong> (<em>str</em>) – The string which overwrites the search string.</p></li>2770 </ul>2771 2734 </dd> 2772 2735 </dl>
Note: See TracChangeset
for help on using the changeset viewer.