eric6/Documentation/Source/eric6.MicroPython.MicroPythonFileSystemUtilities.html

changeset 7273
391d6b7b1eff
parent 7145
ceb3e8b242c1
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.MicroPython.MicroPythonFileSystemUtilities.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.MicroPython.MicroPythonFileSystemUtilities.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,186 +18,237 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.MicroPython.MicroPythonFileSystemUtilities</h1>
+
 <p>
 Module implementing some file system utility functions.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Functions</h3>
+
 <table>
+
 <tr>
 <td><a href="#decoratedName">decoratedName</a></td>
 <td>Function to decorate the given name according to the given mode.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#fstat">fstat</a></td>
 <td>Function to get the stat() of file.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#isVisible">isVisible</a></td>
 <td>Function to check, if a filesystem entry is a hidden file or directory.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#listdirStat">listdirStat</a></td>
 <td>Function to get a list of directory entries and associated stat() tuples.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#mode2string">mode2string</a></td>
 <td>Function to convert a mode value to a string representation.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#mtime2string">mtime2string</a></td>
 <td>Function to convert a time value to a string representation.</td>
 </tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="decoratedName" ID="decoratedName"></a>
 <h2>decoratedName</h2>
 <b>decoratedName</b>(<i>name, mode, isDir=False</i>)
+
 <p>
     Function to decorate the given name according to the given mode.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i> (str)</dt>
 <dd>
 file or directory name
-</dd><dt><i>mode</i> (int)</dt>
+</dd>
+<dt><i>mode</i> (int)</dt>
 <dd>
 mode value
-</dd><dt><i>isDir</i> (bool)</dt>
+</dd>
+<dt><i>isDir</i> (bool)</dt>
 <dd>
 flag indicating that name is a directory
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 decorated file or directory name
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="fstat" ID="fstat"></a>
 <h2>fstat</h2>
 <b>fstat</b>(<i>filename</i>)
+
 <p>
     Function to get the stat() of file.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>filename</i> (str)</dt>
 <dd>
 name of the file
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple containing the stat() result
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 tuple
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="isVisible" ID="isVisible"></a>
 <h2>isVisible</h2>
 <b>isVisible</b>(<i>name, showHidden</i>)
+
 <p>
     Function to check, if a filesystem entry is a hidden file or directory.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>name</i> (str)</dt>
 <dd>
 name to be checked
-</dd><dt><i>showHidden</i> (bool)</dt>
+</dd>
+<dt><i>showHidden</i> (bool)</dt>
 <dd>
 flag indicating to show hidden files as well
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a visible filesystem entry
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="listdirStat" ID="listdirStat"></a>
 <h2>listdirStat</h2>
 <b>listdirStat</b>(<i>dirname, showHidden=False</i>)
+
 <p>
     Function to get a list of directory entries and associated stat() tuples.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>dirname</i> (str)</dt>
 <dd>
 name of the directory to list
-</dd><dt><i>showHidden</i> (bool)</dt>
+</dd>
+<dt><i>showHidden</i> (bool)</dt>
 <dd>
 flag indicating to show hidden files as well
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 list of tuples containing the entry name and the associated
         stat() tuple
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 list of tuple of (str, tuple)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="mode2string" ID="mode2string"></a>
 <h2>mode2string</h2>
 <b>mode2string</b>(<i>mode</i>)
+
 <p>
     Function to convert a mode value to a string representation.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>mode</i> (int)</dt>
 <dd>
 mode value
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 string representation of the given mode value
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="mtime2string" ID="mtime2string"></a>
 <h2>mtime2string</h2>
 <b>mtime2string</b>(<i>mtime</i>)
+
 <p>
     Function to convert a time value to a string representation.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>mtime</i> (int)</dt>
 <dd>
 time value
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 string representation of the given time
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 str

eric ide

mercurial