Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.MicroPython.MicroPythonFileSystemUtilities.html
eric6/Documentation/Source/eric6.MicroPython.MicroPythonFileSystemUtilities.html
- changeset 7273
- 391d6b7b1eff
- parent 7145
- ceb3e8b242c1
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.MicroPython.MicroPythonFileSystemUtilities</h1> | 23 <h1>eric6.MicroPython.MicroPythonFileSystemUtilities</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing some file system utility functions. | 26 Module implementing some file system utility functions. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 32 <tr><td>None</td></tr> | 36 <tr><td>None</td></tr> |
| 33 </table> | 37 </table> |
| 34 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 | |
| 35 <table> | 40 <table> |
| 41 | |
| 36 <tr> | 42 <tr> |
| 37 <td><a href="#decoratedName">decoratedName</a></td> | 43 <td><a href="#decoratedName">decoratedName</a></td> |
| 38 <td>Function to decorate the given name according to the given mode.</td> | 44 <td>Function to decorate the given name according to the given mode.</td> |
| 39 </tr><tr> | 45 </tr> |
| 46 <tr> | |
| 40 <td><a href="#fstat">fstat</a></td> | 47 <td><a href="#fstat">fstat</a></td> |
| 41 <td>Function to get the stat() of file.</td> | 48 <td>Function to get the stat() of file.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#isVisible">isVisible</a></td> | 51 <td><a href="#isVisible">isVisible</a></td> |
| 44 <td>Function to check, if a filesystem entry is a hidden file or directory.</td> | 52 <td>Function to check, if a filesystem entry is a hidden file or directory.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#listdirStat">listdirStat</a></td> | 55 <td><a href="#listdirStat">listdirStat</a></td> |
| 47 <td>Function to get a list of directory entries and associated stat() tuples.</td> | 56 <td>Function to get a list of directory entries and associated stat() tuples.</td> |
| 48 </tr><tr> | 57 </tr> |
| 58 <tr> | |
| 49 <td><a href="#mode2string">mode2string</a></td> | 59 <td><a href="#mode2string">mode2string</a></td> |
| 50 <td>Function to convert a mode value to a string representation.</td> | 60 <td>Function to convert a mode value to a string representation.</td> |
| 51 </tr><tr> | 61 </tr> |
| 62 <tr> | |
| 52 <td><a href="#mtime2string">mtime2string</a></td> | 63 <td><a href="#mtime2string">mtime2string</a></td> |
| 53 <td>Function to convert a time value to a string representation.</td> | 64 <td>Function to convert a time value to a string representation.</td> |
| 54 </tr> | 65 </tr> |
| 55 </table> | 66 </table> |
| 56 <hr /><hr /> | 67 <hr /> |
| 68 <hr /> | |
| 57 <a NAME="decoratedName" ID="decoratedName"></a> | 69 <a NAME="decoratedName" ID="decoratedName"></a> |
| 58 <h2>decoratedName</h2> | 70 <h2>decoratedName</h2> |
| 59 <b>decoratedName</b>(<i>name, mode, isDir=False</i>) | 71 <b>decoratedName</b>(<i>name, mode, isDir=False</i>) |
| 72 | |
| 60 <p> | 73 <p> |
| 61 Function to decorate the given name according to the given mode. | 74 Function to decorate the given name according to the given mode. |
| 62 </p><dl> | 75 </p> |
| 76 <dl> | |
| 77 | |
| 63 <dt><i>name</i> (str)</dt> | 78 <dt><i>name</i> (str)</dt> |
| 64 <dd> | 79 <dd> |
| 65 file or directory name | 80 file or directory name |
| 66 </dd><dt><i>mode</i> (int)</dt> | 81 </dd> |
| 82 <dt><i>mode</i> (int)</dt> | |
| 67 <dd> | 83 <dd> |
| 68 mode value | 84 mode value |
| 69 </dd><dt><i>isDir</i> (bool)</dt> | 85 </dd> |
| 86 <dt><i>isDir</i> (bool)</dt> | |
| 70 <dd> | 87 <dd> |
| 71 flag indicating that name is a directory | 88 flag indicating that name is a directory |
| 72 </dd> | 89 </dd> |
| 73 </dl><dl> | 90 </dl> |
| 91 <dl> | |
| 74 <dt>Returns:</dt> | 92 <dt>Returns:</dt> |
| 75 <dd> | 93 <dd> |
| 76 decorated file or directory name | 94 decorated file or directory name |
| 77 </dd> | 95 </dd> |
| 78 </dl><dl> | 96 </dl> |
| 97 <dl> | |
| 79 <dt>Return Type:</dt> | 98 <dt>Return Type:</dt> |
| 80 <dd> | 99 <dd> |
| 81 str | 100 str |
| 82 </dd> | 101 </dd> |
| 83 </dl> | 102 </dl> |
| 84 <div align="right"><a href="#top">Up</a></div> | 103 <div align="right"><a href="#top">Up</a></div> |
| 85 <hr /><hr /> | 104 <hr /> |
| 105 <hr /> | |
| 86 <a NAME="fstat" ID="fstat"></a> | 106 <a NAME="fstat" ID="fstat"></a> |
| 87 <h2>fstat</h2> | 107 <h2>fstat</h2> |
| 88 <b>fstat</b>(<i>filename</i>) | 108 <b>fstat</b>(<i>filename</i>) |
| 109 | |
| 89 <p> | 110 <p> |
| 90 Function to get the stat() of file. | 111 Function to get the stat() of file. |
| 91 </p><dl> | 112 </p> |
| 113 <dl> | |
| 114 | |
| 92 <dt><i>filename</i> (str)</dt> | 115 <dt><i>filename</i> (str)</dt> |
| 93 <dd> | 116 <dd> |
| 94 name of the file | 117 name of the file |
| 95 </dd> | 118 </dd> |
| 96 </dl><dl> | 119 </dl> |
| 120 <dl> | |
| 97 <dt>Returns:</dt> | 121 <dt>Returns:</dt> |
| 98 <dd> | 122 <dd> |
| 99 tuple containing the stat() result | 123 tuple containing the stat() result |
| 100 </dd> | 124 </dd> |
| 101 </dl><dl> | 125 </dl> |
| 126 <dl> | |
| 102 <dt>Return Type:</dt> | 127 <dt>Return Type:</dt> |
| 103 <dd> | 128 <dd> |
| 104 tuple | 129 tuple |
| 105 </dd> | 130 </dd> |
| 106 </dl> | 131 </dl> |
| 107 <div align="right"><a href="#top">Up</a></div> | 132 <div align="right"><a href="#top">Up</a></div> |
| 108 <hr /><hr /> | 133 <hr /> |
| 134 <hr /> | |
| 109 <a NAME="isVisible" ID="isVisible"></a> | 135 <a NAME="isVisible" ID="isVisible"></a> |
| 110 <h2>isVisible</h2> | 136 <h2>isVisible</h2> |
| 111 <b>isVisible</b>(<i>name, showHidden</i>) | 137 <b>isVisible</b>(<i>name, showHidden</i>) |
| 138 | |
| 112 <p> | 139 <p> |
| 113 Function to check, if a filesystem entry is a hidden file or directory. | 140 Function to check, if a filesystem entry is a hidden file or directory. |
| 114 </p><dl> | 141 </p> |
| 142 <dl> | |
| 143 | |
| 115 <dt><i>name</i> (str)</dt> | 144 <dt><i>name</i> (str)</dt> |
| 116 <dd> | 145 <dd> |
| 117 name to be checked | 146 name to be checked |
| 118 </dd><dt><i>showHidden</i> (bool)</dt> | 147 </dd> |
| 148 <dt><i>showHidden</i> (bool)</dt> | |
| 119 <dd> | 149 <dd> |
| 120 flag indicating to show hidden files as well | 150 flag indicating to show hidden files as well |
| 121 </dd> | 151 </dd> |
| 122 </dl><dl> | 152 </dl> |
| 153 <dl> | |
| 123 <dt>Returns:</dt> | 154 <dt>Returns:</dt> |
| 124 <dd> | 155 <dd> |
| 125 flag indicating a visible filesystem entry | 156 flag indicating a visible filesystem entry |
| 126 </dd> | 157 </dd> |
| 127 </dl><dl> | 158 </dl> |
| 159 <dl> | |
| 128 <dt>Return Type:</dt> | 160 <dt>Return Type:</dt> |
| 129 <dd> | 161 <dd> |
| 130 bool | 162 bool |
| 131 </dd> | 163 </dd> |
| 132 </dl> | 164 </dl> |
| 133 <div align="right"><a href="#top">Up</a></div> | 165 <div align="right"><a href="#top">Up</a></div> |
| 134 <hr /><hr /> | 166 <hr /> |
| 167 <hr /> | |
| 135 <a NAME="listdirStat" ID="listdirStat"></a> | 168 <a NAME="listdirStat" ID="listdirStat"></a> |
| 136 <h2>listdirStat</h2> | 169 <h2>listdirStat</h2> |
| 137 <b>listdirStat</b>(<i>dirname, showHidden=False</i>) | 170 <b>listdirStat</b>(<i>dirname, showHidden=False</i>) |
| 171 | |
| 138 <p> | 172 <p> |
| 139 Function to get a list of directory entries and associated stat() tuples. | 173 Function to get a list of directory entries and associated stat() tuples. |
| 140 </p><dl> | 174 </p> |
| 175 <dl> | |
| 176 | |
| 141 <dt><i>dirname</i> (str)</dt> | 177 <dt><i>dirname</i> (str)</dt> |
| 142 <dd> | 178 <dd> |
| 143 name of the directory to list | 179 name of the directory to list |
| 144 </dd><dt><i>showHidden</i> (bool)</dt> | 180 </dd> |
| 181 <dt><i>showHidden</i> (bool)</dt> | |
| 145 <dd> | 182 <dd> |
| 146 flag indicating to show hidden files as well | 183 flag indicating to show hidden files as well |
| 147 </dd> | 184 </dd> |
| 148 </dl><dl> | 185 </dl> |
| 186 <dl> | |
| 149 <dt>Returns:</dt> | 187 <dt>Returns:</dt> |
| 150 <dd> | 188 <dd> |
| 151 list of tuples containing the entry name and the associated | 189 list of tuples containing the entry name and the associated |
| 152 stat() tuple | 190 stat() tuple |
| 153 </dd> | 191 </dd> |
| 154 </dl><dl> | 192 </dl> |
| 193 <dl> | |
| 155 <dt>Return Type:</dt> | 194 <dt>Return Type:</dt> |
| 156 <dd> | 195 <dd> |
| 157 list of tuple of (str, tuple) | 196 list of tuple of (str, tuple) |
| 158 </dd> | 197 </dd> |
| 159 </dl> | 198 </dl> |
| 160 <div align="right"><a href="#top">Up</a></div> | 199 <div align="right"><a href="#top">Up</a></div> |
| 161 <hr /><hr /> | 200 <hr /> |
| 201 <hr /> | |
| 162 <a NAME="mode2string" ID="mode2string"></a> | 202 <a NAME="mode2string" ID="mode2string"></a> |
| 163 <h2>mode2string</h2> | 203 <h2>mode2string</h2> |
| 164 <b>mode2string</b>(<i>mode</i>) | 204 <b>mode2string</b>(<i>mode</i>) |
| 205 | |
| 165 <p> | 206 <p> |
| 166 Function to convert a mode value to a string representation. | 207 Function to convert a mode value to a string representation. |
| 167 </p><dl> | 208 </p> |
| 209 <dl> | |
| 210 | |
| 168 <dt><i>mode</i> (int)</dt> | 211 <dt><i>mode</i> (int)</dt> |
| 169 <dd> | 212 <dd> |
| 170 mode value | 213 mode value |
| 171 </dd> | 214 </dd> |
| 172 </dl><dl> | 215 </dl> |
| 216 <dl> | |
| 173 <dt>Returns:</dt> | 217 <dt>Returns:</dt> |
| 174 <dd> | 218 <dd> |
| 175 string representation of the given mode value | 219 string representation of the given mode value |
| 176 </dd> | 220 </dd> |
| 177 </dl><dl> | 221 </dl> |
| 222 <dl> | |
| 178 <dt>Return Type:</dt> | 223 <dt>Return Type:</dt> |
| 179 <dd> | 224 <dd> |
| 180 str | 225 str |
| 181 </dd> | 226 </dd> |
| 182 </dl> | 227 </dl> |
| 183 <div align="right"><a href="#top">Up</a></div> | 228 <div align="right"><a href="#top">Up</a></div> |
| 184 <hr /><hr /> | 229 <hr /> |
| 230 <hr /> | |
| 185 <a NAME="mtime2string" ID="mtime2string"></a> | 231 <a NAME="mtime2string" ID="mtime2string"></a> |
| 186 <h2>mtime2string</h2> | 232 <h2>mtime2string</h2> |
| 187 <b>mtime2string</b>(<i>mtime</i>) | 233 <b>mtime2string</b>(<i>mtime</i>) |
| 234 | |
| 188 <p> | 235 <p> |
| 189 Function to convert a time value to a string representation. | 236 Function to convert a time value to a string representation. |
| 190 </p><dl> | 237 </p> |
| 238 <dl> | |
| 239 | |
| 191 <dt><i>mtime</i> (int)</dt> | 240 <dt><i>mtime</i> (int)</dt> |
| 192 <dd> | 241 <dd> |
| 193 time value | 242 time value |
| 194 </dd> | 243 </dd> |
| 195 </dl><dl> | 244 </dl> |
| 245 <dl> | |
| 196 <dt>Returns:</dt> | 246 <dt>Returns:</dt> |
| 197 <dd> | 247 <dd> |
| 198 string representation of the given time | 248 string representation of the given time |
| 199 </dd> | 249 </dd> |
| 200 </dl><dl> | 250 </dl> |
| 251 <dl> | |
| 201 <dt>Return Type:</dt> | 252 <dt>Return Type:</dt> |
| 202 <dd> | 253 <dd> |
| 203 str | 254 str |
| 204 </dd> | 255 </dd> |
| 205 </dl> | 256 </dl> |
