diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html
--- a/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,24 +7,23 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.SystemUtilities.FileSystemUtilities</h1>
-
<p>
Module implementing file system related utility functions.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>_DeviceFileMarker</td></tr><tr><td>_RemoteFileMarker</td></tr>
+<tr><td>_DeviceFileMarker</td></tr>
+<tr><td>_RemoteFileMarker</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#absolutePath">absolutePath</a></td>
<td>Public method to convert a path relative to a start path to an absolute path.</td>
@@ -158,16 +157,17 @@
<td>Function returning a path, that is using native separator characters.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="absolutePath" ID="absolutePath"></a>
<h2>absolutePath</h2>
<b>absolutePath</b>(<i>path, start</i>)
-
<p>
Public method to convert a path relative to a start path to an
absolute path.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -197,11 +197,11 @@
<a NAME="absoluteUniversalPath" ID="absoluteUniversalPath"></a>
<h2>absoluteUniversalPath</h2>
<b>absoluteUniversalPath</b>(<i>path, start</i>)
-
<p>
Public method to convert a path relative to a start path with
universal separators to an absolute path.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -231,10 +231,10 @@
<a NAME="compactPath" ID="compactPath"></a>
<h2>compactPath</h2>
<b>compactPath</b>(<i>path, width, measure=len</i>)
-
<p>
Function to return a compacted path fitting inside the given width.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -269,10 +269,10 @@
<a NAME="deviceFileName" ID="deviceFileName"></a>
<h2>deviceFileName</h2>
<b>deviceFileName</b>(<i>fileName</i>)
-
<p>
Function to create a device (MicroPython) file name given a plain file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -298,10 +298,10 @@
<a NAME="direntries" ID="direntries"></a>
<h2>direntries</h2>
<b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, </i>)
-
<p>
Function returning a list of all files and directories.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -350,10 +350,10 @@
<a NAME="findVolume" ID="findVolume"></a>
<h2>findVolume</h2>
<b>findVolume</b>(<i>volumeName, findAll=False</i>)
-
<p>
Function to find the directory belonging to a given volume name.
</p>
+
<dl>
<dt><i>volumeName</i> (str)</dt>
@@ -385,10 +385,10 @@
<a NAME="fromNativeSeparators" ID="fromNativeSeparators"></a>
<h2>fromNativeSeparators</h2>
<b>fromNativeSeparators</b>(<i>path</i>)
-
<p>
Function returning a path, that is using "/" separator characters.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -414,10 +414,10 @@
<a NAME="getDirs" ID="getDirs"></a>
<h2>getDirs</h2>
<b>getDirs</b>(<i>path, excludeDirs</i>)
-
<p>
Function returning a list of all directories below path.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -447,10 +447,10 @@
<a NAME="getExecutablePath" ID="getExecutablePath"></a>
<h2>getExecutablePath</h2>
<b>getExecutablePath</b>(<i>file</i>)
-
<p>
Function to build the full path of an executable file from the environment.
</p>
+
<dl>
<dt><i>file</i> (str)</dt>
@@ -478,10 +478,10 @@
<a NAME="getExecutablePaths" ID="getExecutablePaths"></a>
<h2>getExecutablePaths</h2>
<b>getExecutablePaths</b>(<i>file</i>)
-
<p>
Function to build all full path of an executable file from the environment.
</p>
+
<dl>
<dt><i>file</i> (str)</dt>
@@ -509,13 +509,13 @@
<a NAME="getUserMounts" ID="getUserMounts"></a>
<h2>getUserMounts</h2>
<b>getUserMounts</b>(<i></i>)
-
<p>
Function to determine all available user mounts.
</p>
<p>
Note: On Windows platforms all available drives are returned.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -534,7 +534,6 @@
<a NAME="getVolumeName" ID="getVolumeName"></a>
<h2>getVolumeName</h2>
<b>getVolumeName</b>(<i>diskName</i>)
-
<p>
Local function to determine the volume of a disk or device.
</p>
@@ -546,13 +545,13 @@
<p>
Code from http://stackoverflow.com/a/12056414
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getWindowsExecutablePath" ID="getWindowsExecutablePath"></a>
<h2>getWindowsExecutablePath</h2>
<b>getWindowsExecutablePath</b>(<i>file</i>)
-
<p>
Function to build the full path of an executable file from the environment
on Windows platforms.
@@ -562,6 +561,7 @@
such with the extensions .cmd or .bat and finally the given file name as
is. The first match is returned.
</p>
+
<dl>
<dt><i>file</i> (str)</dt>
@@ -589,10 +589,10 @@
<a NAME="isDeviceFileName" ID="isDeviceFileName"></a>
<h2>isDeviceFileName</h2>
<b>isDeviceFileName</b>(<i>fileName</i>)
-
<p>
Function to check, if the given file name is a device file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -618,10 +618,10 @@
<a NAME="isDrive" ID="isDrive"></a>
<h2>isDrive</h2>
<b>isDrive</b>(<i>path</i>)
-
<p>
Function to check, if a path is a Windows drive.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -647,10 +647,10 @@
<a NAME="isExecutable" ID="isExecutable"></a>
<h2>isExecutable</h2>
<b>isExecutable</b>(<i>exe</i>)
-
<p>
Function to check, if a file is executable.
</p>
+
<dl>
<dt><i>exe</i> (str)</dt>
@@ -676,10 +676,10 @@
<a NAME="isPlainFileName" ID="isPlainFileName"></a>
<h2>isPlainFileName</h2>
<b>isPlainFileName</b>(<i>fileName</i>)
-
<p>
Function to check, if the given file name is a plain (i.e. local) file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -705,10 +705,10 @@
<a NAME="isRemoteFileName" ID="isRemoteFileName"></a>
<h2>isRemoteFileName</h2>
<b>isRemoteFileName</b>(<i>fileName</i>)
-
<p>
Function to check, if the given file name is a remote file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -734,10 +734,10 @@
<a NAME="isinpath" ID="isinpath"></a>
<h2>isinpath</h2>
<b>isinpath</b>(<i>file</i>)
-
<p>
Function to check for an executable file.
</p>
+
<dl>
<dt><i>file</i> (str)</dt>
@@ -764,7 +764,6 @@
<a NAME="joinext" ID="joinext"></a>
<h2>joinext</h2>
<b>joinext</b>(<i>prefix, ext</i>)
-
<p>
Function to join a file extension to a path.
</p>
@@ -772,6 +771,7 @@
The leading "." of ext is replaced by a platform specific extension
separator if necessary.
</p>
+
<dl>
<dt><i>prefix</i> (str)</dt>
@@ -801,11 +801,11 @@
<a NAME="normabsjoinpath" ID="normabsjoinpath"></a>
<h2>normabsjoinpath</h2>
<b>normabsjoinpath</b>(<i>a, *p</i>)
-
<p>
Function returning a normalized, absolute path of the joined parts passed
into it.
</p>
+
<dl>
<dt><i>a</i> (str)</dt>
@@ -835,11 +835,11 @@
<a NAME="normcaseabspath" ID="normcaseabspath"></a>
<h2>normcaseabspath</h2>
<b>normcaseabspath</b>(<i>path</i>)
-
<p>
Function returning an absolute path, that is normalized with respect to
its case and references.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -865,11 +865,11 @@
<a NAME="normcasepath" ID="normcasepath"></a>
<h2>normcasepath</h2>
<b>normcasepath</b>(<i>path</i>)
-
<p>
Function returning a path, that is normalized with respect to its case
and references.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -895,10 +895,10 @@
<a NAME="normjoinpath" ID="normjoinpath"></a>
<h2>normjoinpath</h2>
<b>normjoinpath</b>(<i>a, *p</i>)
-
<p>
Function returning a normalized path of the joined parts passed into it.
</p>
+
<dl>
<dt><i>a</i> (str)</dt>
@@ -928,10 +928,10 @@
<a NAME="plainFileName" ID="plainFileName"></a>
<h2>plainFileName</h2>
<b>plainFileName</b>(<i>fileName</i>)
-
<p>
Function to create a plain file name given a device or remote file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -957,11 +957,11 @@
<a NAME="relativeUniversalPath" ID="relativeUniversalPath"></a>
<h2>relativeUniversalPath</h2>
<b>relativeUniversalPath</b>(<i>path, start</i>)
-
<p>
Function to convert a file path to a path relative to a start path
with universal separators.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -992,10 +992,10 @@
<a NAME="remoteFileName" ID="remoteFileName"></a>
<h2>remoteFileName</h2>
<b>remoteFileName</b>(<i>fileName</i>)
-
<p>
Function to create a remote file name given a plain file name.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -1021,10 +1021,10 @@
<a NAME="samefilepath" ID="samefilepath"></a>
<h2>samefilepath</h2>
<b>samefilepath</b>(<i>f1, f2, followSymlinks=True</i>)
-
<p>
Function to compare two paths. Strips the filename.
</p>
+
<dl>
<dt><i>f1</i> (str)</dt>
@@ -1060,10 +1060,10 @@
<a NAME="samepath" ID="samepath"></a>
<h2>samepath</h2>
<b>samepath</b>(<i>f1, f2, followSymlinks=True</i>)
-
<p>
Function to compare two paths.
</p>
+
<dl>
<dt><i>f1</i> (str)</dt>
@@ -1099,10 +1099,10 @@
<a NAME="splitPath" ID="splitPath"></a>
<h2>splitPath</h2>
<b>splitPath</b>(<i>name</i>)
-
<p>
Function to split a pathname into a directory part and a file part.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1128,10 +1128,10 @@
<a NAME="startfile" ID="startfile"></a>
<h2>startfile</h2>
<b>startfile</b>(<i>filePath</i>)
-
<p>
Function to open the given file path with the system default application.
</p>
+
<dl>
<dt><i>filePath</i> (str or Path)</dt>
@@ -1157,10 +1157,10 @@
<a NAME="startswithPath" ID="startswithPath"></a>
<h2>startswithPath</h2>
<b>startswithPath</b>(<i>path, start</i>)
-
<p>
Function to check, if a path starts with a given start path.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -1191,10 +1191,10 @@
<a NAME="toNativeSeparators" ID="toNativeSeparators"></a>
<h2>toNativeSeparators</h2>
<b>toNativeSeparators</b>(<i>path</i>)
-
<p>
Function returning a path, that is using native separator characters.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -1216,4 +1216,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
