--- a/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html Thu Dec 07 10:40:05 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html Thu Dec 07 10:40:51 2023 +0100
@@ -166,19 +166,25 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-file or directory name to convert (string)
+file or directory name to convert
</dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (str)</dt>
<dd>
-start path (string)
+start path
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-absolute path (string)
+absolute path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -194,19 +200,25 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-file or directory name to convert (string)
+file or directory name to convert
</dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (str)</dt>
<dd>
-start path (string)
+start path
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-absolute path with native separators (string)
+absolute path with native separators
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -221,15 +233,15 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-path to be compacted (string)
+path to be compacted
</dd>
-<dt><i>width</i></dt>
+<dt><i>width</i> (int)</dt>
<dd>
-width for the compacted path (integer)
+width for the compacted path
</dd>
-<dt><i>measure</i></dt>
+<dt><i>measure</i> (function(str))</dt>
<dd>
reference to a function used to measure the length of the
string
@@ -238,7 +250,13 @@
<dl>
<dt>Return:</dt>
<dd>
-compacted path (string)
+compacted path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -319,7 +337,7 @@
<dl>
<dt>Return Type:</dt>
<dd>
-list of strs
+list of str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -398,13 +416,13 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
root of the tree to check
</dd>
-<dt><i>excludeDirs</i></dt>
+<dt><i>excludeDirs</i> (list of str)</dt>
<dd>
-basename of directories to ignore
+base name of directories to ignore
</dd>
</dl>
<dl>
@@ -413,6 +431,12 @@
list of all directories found
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
@@ -425,19 +449,25 @@
</p>
<dl>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
<dd>
-filename of the executable to check (string)
+filename of the executable to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
full executable name, if the executable file is accessible
- via the searchpath defined by the PATH environment variable, or an
+ via the executable search path defined by the PATH environment variable, or an
empty string otherwise.
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
@@ -450,17 +480,23 @@
</p>
<dl>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
<dd>
-filename of the executable (string)
+filename of the executable
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of full executable names (list of strings), if the executable
- file is accessible via the searchpath defined by the PATH environment
- variable, or an empty list otherwise.
+list of full executable names, if the executable file is accessible via
+ the executable search path defined by the PATH environment variable, or an
+ empty list otherwise.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -524,19 +560,25 @@
</p>
<dl>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
<dd>
-filename of the executable to check (string)
+filename of the executable to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-full executable name, if the executable file is accessible
- via the searchpath defined by the PATH environment variable, or an
+full executable name, if the executable file is accessible via the
+ executable search path defined by the PATH environment variable, or an
empty string otherwise.
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
@@ -607,15 +649,21 @@
</p>
<dl>
-<dt><i>exe</i></dt>
+<dt><i>exe</i> (str)</dt>
<dd>
-filename of the executable to check (string)
+filename of the executable to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating executable status (boolean)
+flag indicating executable status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -688,16 +736,22 @@
</p>
<dl>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
<dd>
-filename of the executable to check (string)
+filename of the executable to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag to indicate, if the executable file is accessible
- via the searchpath defined by the PATH environment variable.
+flag indicating, if the executable file is accessible via the executable
+ search path defined by the PATH environment variable.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -716,19 +770,25 @@
</p>
<dl>
-<dt><i>prefix</i></dt>
+<dt><i>prefix</i> (str)</dt>
<dd>
-the basepart of the filename (string)
+the basepart of the filename
</dd>
-<dt><i>ext</i></dt>
+<dt><i>ext</i> (str)</dt>
<dd>
-the extension part (string)
+the extension part
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-the complete filename (string)
+the complete filename
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -744,19 +804,25 @@
</p>
<dl>
-<dt><i>a</i></dt>
+<dt><i>a</i> (str)</dt>
<dd>
-first path to be joined (string)
+first path to be joined
</dd>
-<dt><i>p</i></dt>
+<dt><i>p</i> (str)</dt>
<dd>
-variable number of path parts to be joind (string)
+variable number of path parts to be joined
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-absolute, normalized path (string)
+absolute, normalized path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -772,15 +838,21 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-file path (string)
+file path
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-absolute, normalized path (string)
+absolute, normalized path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -796,15 +868,21 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-file path (string)
+file path
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-case normalized path (string)
+case normalized path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -819,19 +897,25 @@
</p>
<dl>
-<dt><i>a</i></dt>
+<dt><i>a</i> (str)</dt>
<dd>
-first path to be joined (string)
+first path to be joined
</dd>
-<dt><i>p</i></dt>
+<dt><i>p</i> (str)</dt>
<dd>
-variable number of path parts to be joined (string)
+variable number of path parts to be joined
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-normalized path (string)
+normalized path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -876,20 +960,26 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-file or directory name to convert (string)
+file or directory name to convert
</dd>
-<dt><i>start</i></dt>
+<dt><i>start</i> (str)</dt>
<dd>
-start path (string)
+start path
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
relative path or unchanged path, if path does not start with
- the start path with universal separators (string)
+ the start path with universal separators
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -926,27 +1016,38 @@
<hr />
<a NAME="samefilepath" ID="samefilepath"></a>
<h2>samefilepath</h2>
-<b>samefilepath</b>(<i>f1, f2</i>)
+<b>samefilepath</b>(<i>f1, f2, followSymlinks=True</i>)
<p>
Function to compare two paths. Strips the filename.
</p>
<dl>
-<dt><i>f1</i></dt>
+<dt><i>f1</i> (str)</dt>
<dd>
-first filepath for the compare (string)
+first filepath for the compare
</dd>
-<dt><i>f2</i></dt>
+<dt><i>f2</i> (str)</dt>
<dd>
-second filepath for the compare (string)
+second filepath for the compare
+</dd>
+<dt><i>followSymlinks</i> (bool (optional))</dt>
+<dd>
+flag indicating to respect symbolic links for the comparison
+ (i.e. compare the real paths) (defaults to True)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating whether the two paths represent the
- same path on disk.
+ same path on disk
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -954,27 +1055,38 @@
<hr />
<a NAME="samepath" ID="samepath"></a>
<h2>samepath</h2>
-<b>samepath</b>(<i>f1, f2</i>)
+<b>samepath</b>(<i>f1, f2, followSymlinks=True</i>)
<p>
Function to compare two paths.
</p>
<dl>
-<dt><i>f1</i></dt>
+<dt><i>f1</i> (str)</dt>
<dd>
-first path for the compare (string)
+first filepath for the compare
</dd>
-<dt><i>f2</i></dt>
+<dt><i>f2</i> (str)</dt>
<dd>
-second path for the compare (string)
+second filepath for the compare
+</dd>
+<dt><i>followSymlinks</i> (bool (optional))</dt>
+<dd>
+flag indicating to respect symbolic links for the comparison
+ (i.e. compare the real paths) (defaults to True)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating whether the two paths represent the
- same path on disk.
+ same path on disk
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -989,15 +1101,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-path name (string)
+path name
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-a tuple of 2 strings (dirname, filename).
+tuple containing directory name and file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
