Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html
src/eric7/Documentation/Source/eric7.SystemUtilities.FileSystemUtilities.html
- branch
- eric7
- changeset 10784
- 521fd465b048
- parent 10671
- f2d75784e574
- child 10795
- 89cfe35c12f9
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 295 <div align="right"><a href="#top">Up</a></div> | 295 <div align="right"><a href="#top">Up</a></div> |
| 296 <hr /> | 296 <hr /> |
| 297 <hr /> | 297 <hr /> |
| 298 <a NAME="direntries" ID="direntries"></a> | 298 <a NAME="direntries" ID="direntries"></a> |
| 299 <h2>direntries</h2> | 299 <h2>direntries</h2> |
| 300 <b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, </i>) | 300 <b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, recursive=True, dirsonly=False, </i>) |
| 301 <p> | 301 <p> |
| 302 Function returning a list of all files and directories. | 302 Function returning a list of all files and directories. |
| 303 </p> | 303 </p> |
| 304 | 304 |
| 305 <dl> | 305 <dl> |
| 306 | 306 |
| 307 <dt><i>path</i> (str)</dt> | 307 <dt><i>path</i> (str)</dt> |
| 308 <dd> | 308 <dd> |
| 309 root of the tree to check | 309 root of the tree to check |
| 310 </dd> | 310 </dd> |
| 311 <dt><i>filesonly</i> (bool)</dt> | 311 <dt><i>filesonly</i> (bool (optional))</dt> |
| 312 <dd> | 312 <dd> |
| 313 flag indicating that only files are wanted | 313 flag indicating that only files are wanted (defaults to False) |
| 314 </dd> | 314 </dd> |
| 315 <dt><i>pattern</i> (str or list of str)</dt> | 315 <dt><i>pattern</i> (str or list of str (optional))</dt> |
| 316 <dd> | 316 <dd> |
| 317 a filename pattern or list of filename patterns to check | 317 a filename pattern or list of filename patterns to check |
| 318 against | 318 against (defaults to None) |
| 319 </dd> | 319 </dd> |
| 320 <dt><i>followsymlinks</i> (bool)</dt> | 320 <dt><i>followsymlinks</i> (bool (optional))</dt> |
| 321 <dd> | 321 <dd> |
| 322 flag indicating whether symbolic links | 322 flag indicating whether symbolic links |
| 323 should be followed | 323 should be followed (defaults to True) |
| 324 </dd> | 324 </dd> |
| 325 <dt><i>checkStop</i> (function)</dt> | 325 <dt><i>checkStop</i> (function (optional))</dt> |
| 326 <dd> | 326 <dd> |
| 327 function to be called to check for a stop | 327 function to be called to check for a stop (defaults to None) |
| 328 </dd> | 328 </dd> |
| 329 <dt><i>ignore</i> (list of str)</dt> | 329 <dt><i>ignore</i> (list of str (optional))</dt> |
| 330 <dd> | 330 <dd> |
| 331 list of entries to be ignored | 331 list of entries to be ignored (defaults to None) |
| 332 </dd> | |
| 333 <dt><i>recursive</i> (bool (optional))</dt> | |
| 334 <dd> | |
| 335 flag indicating a recursive search (defaults to True) | |
| 336 </dd> | |
| 337 <dt><i>dirsonly</i> (bool)</dt> | |
| 338 <dd> | |
| 339 flag indicating to return only directories. When True it has | |
| 340 precedence over the 'filesonly' parameter ((defaults to False) | |
| 332 </dd> | 341 </dd> |
| 333 </dl> | 342 </dl> |
| 334 <dl> | 343 <dl> |
| 335 <dt>Return:</dt> | 344 <dt>Return:</dt> |
| 336 <dd> | 345 <dd> |
