src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html

branch
eric7
changeset 10784
521fd465b048
parent 10671
f2d75784e574
child 10795
89cfe35c12f9
--- a/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html	Fri Jun 14 11:18:10 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html	Fri Jun 14 11:23:45 2024 +0200
@@ -297,7 +297,7 @@
 <hr />
 <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>)
+<b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, recursive=True, dirsonly=False, </i>)
 <p>
     Function returning a list of all files and directories.
 </p>
@@ -308,27 +308,36 @@
 <dd>
 root of the tree to check
 </dd>
-<dt><i>filesonly</i> (bool)</dt>
+<dt><i>filesonly</i> (bool (optional))</dt>
 <dd>
-flag indicating that only files are wanted
+flag indicating that only files are wanted (defaults to False)
 </dd>
-<dt><i>pattern</i> (str or list of str)</dt>
+<dt><i>pattern</i> (str or list of str (optional))</dt>
 <dd>
 a filename pattern or list of filename patterns to check
-        against
+        against (defaults to None)
 </dd>
-<dt><i>followsymlinks</i> (bool)</dt>
+<dt><i>followsymlinks</i> (bool (optional))</dt>
 <dd>
 flag indicating whether symbolic links
-        should be followed
+        should be followed (defaults to True)
 </dd>
-<dt><i>checkStop</i> (function)</dt>
+<dt><i>checkStop</i> (function (optional))</dt>
+<dd>
+function to be called to check for a stop (defaults to None)
+</dd>
+<dt><i>ignore</i> (list of str (optional))</dt>
 <dd>
-function to be called to check for a stop
+list of entries to be ignored (defaults to None)
 </dd>
-<dt><i>ignore</i> (list of str)</dt>
+<dt><i>recursive</i> (bool (optional))</dt>
 <dd>
-list of entries to be ignored
+flag indicating a recursive search (defaults to True)
+</dd>
+<dt><i>dirsonly</i> (bool)</dt>
+<dd>
+flag indicating to return only directories. When True it has
+        precedence over the 'filesonly' parameter ((defaults to False)
 </dd>
 </dl>
 <dl>

eric ide

mercurial