--- a/eric7/Documentation/Source/eric7.Utilities.__init__.html Mon May 23 17:31:02 2022 +0200 +++ b/eric7/Documentation/Source/eric7.Utilities.__init__.html Mon May 23 18:15:10 2022 +0200 @@ -138,6 +138,14 @@ <td>Module function to generate a string with various version infos.</td> </tr> <tr> +<td><a href="#getCoverageFileName">getCoverageFileName</a></td> +<td>Function to build a file name for a coverage data file.</td> +</tr> +<tr> +<td><a href="#getCoverageFileNames">getCoverageFileNames</a></td> +<td>Function to build a list of coverage data file names.</td> +</tr> +<tr> <td><a href="#getDirs">getDirs</a></td> <td>Function returning a list of all directories below path.</td> </tr> @@ -166,6 +174,14 @@ <td>Function to get the help text for the supported %-codes.</td> </tr> <tr> +<td><a href="#getProfileFileName">getProfileFileName</a></td> +<td>Function to build a file name for a profile data file.</td> +</tr> +<tr> +<td><a href="#getProfileFileNames">getProfileFileNames</a></td> +<td>Function to build a list of profile data file names.</td> +</tr> +<tr> <td><a href="#getPythonLibPath">getPythonLibPath</a></td> <td>Function to determine the path to Python's library.</td> </tr> @@ -186,8 +202,8 @@ <td>Module function to get the Python path (sys.path) of a specific interpreter.</td> </tr> <tr> -<td><a href="#getTestFileName">getTestFileName</a></td> -<td>Function to build the filename of a unittest file.</td> +<td><a href="#getTestFileNames">getTestFileNames</a></td> +<td>Function to build the potential file names of a test file.</td> </tr> <tr> <td><a href="#getUserName">getUserName</a></td> @@ -1241,6 +1257,69 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="getCoverageFileName" ID="getCoverageFileName"></a> +<h2>getCoverageFileName</h2> +<b>getCoverageFileName</b>(<i>fn, mustExist=True</i>) + +<p> + Function to build a file name for a coverage data file. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +file name basis to be used for the coverage data file name +</dd> +<dt><i>mustExist</i> (bool (optional))</dt> +<dd> +flag indicating to check that the file exists (defaults + to True) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +coverage data file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getCoverageFileNames" ID="getCoverageFileNames"></a> +<h2>getCoverageFileNames</h2> +<b>getCoverageFileNames</b>(<i>fn</i>) + +<p> + Function to build a list of coverage data file names. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +file name basis to be used for the coverage data file +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of existing coverage data files +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="getDirs" ID="getDirs"></a> <h2>getDirs</h2> <b>getDirs</b>(<i>path, excludeDirs</i>) @@ -1408,6 +1487,69 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="getProfileFileName" ID="getProfileFileName"></a> +<h2>getProfileFileName</h2> +<b>getProfileFileName</b>(<i>fn, mustExist=True</i>) + +<p> + Function to build a file name for a profile data file. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +file name basis to be used for the profile data file name +</dd> +<dt><i>mustExist</i> (bool (optional))</dt> +<dd> +flag indicating to check that the file exists (defaults + to True) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +profile data file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getProfileFileNames" ID="getProfileFileNames"></a> +<h2>getProfileFileNames</h2> +<b>getProfileFileNames</b>(<i>fn</i>) + +<p> + Function to build a list of profile data file names. +</p> +<dl> + +<dt><i>fn</i> (str)</dt> +<dd> +file name basis to be used for the profile data file +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of existing profile data files +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="getPythonLibPath" ID="getPythonLibPath"></a> <h2>getPythonLibPath</h2> <b>getPythonLibPath</b>(<i></i>) @@ -1510,28 +1652,34 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> -<a NAME="getTestFileName" ID="getTestFileName"></a> -<h2>getTestFileName</h2> -<b>getTestFileName</b>(<i>fn</i>) +<a NAME="getTestFileNames" ID="getTestFileNames"></a> +<h2>getTestFileNames</h2> +<b>getTestFileNames</b>(<i>fn</i>) <p> - Function to build the filename of a unittest file. + Function to build the potential file names of a test file. </p> <p> - The filename for the unittest file is built by prepending - the string "test" to the filename passed into this function. + The file names for the test file is built by prepending the string + "test" and "test_" to the file name passed into this function. </p> <dl> -<dt><i>fn</i></dt> +<dt><i>fn</i> (str)</dt> <dd> -filename basis to be used for the unittest filename (string) +file name basis to be used for the test file names </dd> </dl> <dl> <dt>Return:</dt> <dd> -filename of the corresponding unittest file (string) +file names of the corresponding test file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <div align="right"><a href="#top">Up</a></div>