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 10388
- a34ce7f42e8b
- parent 9944
- 011ae0edbcff
- child 10395
- 16933878e27b
equal
deleted
inserted
replaced
| 10387:8cf53170e290 | 10388:a34ce7f42e8b |
|---|---|
| 12 Module implementing file system related utility functions. | 12 Module implementing file system related utility functions. |
| 13 </p> | 13 </p> |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 |
| 16 <table> | 16 <table> |
| 17 <tr><td>None</td></tr> | 17 <tr><td>_DeviceFileMarker</td></tr><tr><td>_RemoteFileMarker</td></tr> |
| 18 </table> | 18 </table> |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 |
| 21 <table> | 21 <table> |
| 22 <tr><td>None</td></tr> | 22 <tr><td>None</td></tr> |
| 36 <tr> | 36 <tr> |
| 37 <td><a href="#compactPath">compactPath</a></td> | 37 <td><a href="#compactPath">compactPath</a></td> |
| 38 <td>Function to return a compacted path fitting inside the given width.</td> | 38 <td>Function to return a compacted path fitting inside the given width.</td> |
| 39 </tr> | 39 </tr> |
| 40 <tr> | 40 <tr> |
| 41 <td><a href="#deviceFileName">deviceFileName</a></td> | |
| 42 <td>Function to create a device (MicroPython) file name given a plain file name.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 41 <td><a href="#direntries">direntries</a></td> | 45 <td><a href="#direntries">direntries</a></td> |
| 42 <td>Function returning a list of all files and directories.</td> | 46 <td>Function returning a list of all files and directories.</td> |
| 43 </tr> | 47 </tr> |
| 44 <tr> | 48 <tr> |
| 45 <td><a href="#findVolume">findVolume</a></td> | 49 <td><a href="#findVolume">findVolume</a></td> |
| 72 <tr> | 76 <tr> |
| 73 <td><a href="#getWindowsExecutablePath">getWindowsExecutablePath</a></td> | 77 <td><a href="#getWindowsExecutablePath">getWindowsExecutablePath</a></td> |
| 74 <td>Function to build the full path of an executable file from the environment on Windows platforms.</td> | 78 <td>Function to build the full path of an executable file from the environment on Windows platforms.</td> |
| 75 </tr> | 79 </tr> |
| 76 <tr> | 80 <tr> |
| 81 <td><a href="#isDeviceFileName">isDeviceFileName</a></td> | |
| 82 <td>Function to check, if the given file name is a device file name.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 77 <td><a href="#isDrive">isDrive</a></td> | 85 <td><a href="#isDrive">isDrive</a></td> |
| 78 <td>Function to check, if a path is a Windows drive.</td> | 86 <td>Function to check, if a path is a Windows drive.</td> |
| 79 </tr> | 87 </tr> |
| 80 <tr> | 88 <tr> |
| 81 <td><a href="#isExecutable">isExecutable</a></td> | 89 <td><a href="#isExecutable">isExecutable</a></td> |
| 82 <td>Function to check, if a file is executable.</td> | 90 <td>Function to check, if a file is executable.</td> |
| 83 </tr> | 91 </tr> |
| 84 <tr> | 92 <tr> |
| 93 <td><a href="#isPlainFileName">isPlainFileName</a></td> | |
| 94 <td>Function to check, if the given file name is a plain (i.e.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#isRemoteFileName">isRemoteFileName</a></td> | |
| 98 <td>Function to check, if the given file name is a remote file name.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 85 <td><a href="#isinpath">isinpath</a></td> | 101 <td><a href="#isinpath">isinpath</a></td> |
| 86 <td>Function to check for an executable file.</td> | 102 <td>Function to check for an executable file.</td> |
| 87 </tr> | 103 </tr> |
| 88 <tr> | 104 <tr> |
| 89 <td><a href="#joinext">joinext</a></td> | 105 <td><a href="#joinext">joinext</a></td> |
| 104 <tr> | 120 <tr> |
| 105 <td><a href="#normjoinpath">normjoinpath</a></td> | 121 <td><a href="#normjoinpath">normjoinpath</a></td> |
| 106 <td>Function returning a normalized path of the joined parts passed into it.</td> | 122 <td>Function returning a normalized path of the joined parts passed into it.</td> |
| 107 </tr> | 123 </tr> |
| 108 <tr> | 124 <tr> |
| 125 <td><a href="#plainFileName">plainFileName</a></td> | |
| 126 <td>Function to create a plain file name given a device or remote file name.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 109 <td><a href="#relativeUniversalPath">relativeUniversalPath</a></td> | 129 <td><a href="#relativeUniversalPath">relativeUniversalPath</a></td> |
| 110 <td>Function to convert a file path to a path relative to a start path with universal separators.</td> | 130 <td>Function to convert a file path to a path relative to a start path with universal separators.</td> |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#remoteFileName">remoteFileName</a></td> | |
| 134 <td>Function to create a remote file name given a plain file name.</td> | |
| 111 </tr> | 135 </tr> |
| 112 <tr> | 136 <tr> |
| 113 <td><a href="#samefilepath">samefilepath</a></td> | 137 <td><a href="#samefilepath">samefilepath</a></td> |
| 114 <td>Function to compare two paths.</td> | 138 <td>Function to compare two paths.</td> |
| 115 </tr> | 139 </tr> |
| 218 </dd> | 242 </dd> |
| 219 </dl> | 243 </dl> |
| 220 <div align="right"><a href="#top">Up</a></div> | 244 <div align="right"><a href="#top">Up</a></div> |
| 221 <hr /> | 245 <hr /> |
| 222 <hr /> | 246 <hr /> |
| 247 <a NAME="deviceFileName" ID="deviceFileName"></a> | |
| 248 <h2>deviceFileName</h2> | |
| 249 <b>deviceFileName</b>(<i>fileName</i>) | |
| 250 | |
| 251 <p> | |
| 252 Function to create a device (MicroPython) file name given a plain file name. | |
| 253 </p> | |
| 254 <dl> | |
| 255 | |
| 256 <dt><i>fileName</i> (str)</dt> | |
| 257 <dd> | |
| 258 plain file name | |
| 259 </dd> | |
| 260 </dl> | |
| 261 <dl> | |
| 262 <dt>Return:</dt> | |
| 263 <dd> | |
| 264 device file name | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <dl> | |
| 268 <dt>Return Type:</dt> | |
| 269 <dd> | |
| 270 str | |
| 271 </dd> | |
| 272 </dl> | |
| 273 <div align="right"><a href="#top">Up</a></div> | |
| 274 <hr /> | |
| 275 <hr /> | |
| 223 <a NAME="direntries" ID="direntries"></a> | 276 <a NAME="direntries" ID="direntries"></a> |
| 224 <h2>direntries</h2> | 277 <h2>direntries</h2> |
| 225 <b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, </i>) | 278 <b>direntries</b>(<i>path, filesonly=False, pattern=None, followsymlinks=True, checkStop=None, ignore=None, </i>) |
| 226 | 279 |
| 227 <p> | 280 <p> |
| 485 </dd> | 538 </dd> |
| 486 </dl> | 539 </dl> |
| 487 <div align="right"><a href="#top">Up</a></div> | 540 <div align="right"><a href="#top">Up</a></div> |
| 488 <hr /> | 541 <hr /> |
| 489 <hr /> | 542 <hr /> |
| 543 <a NAME="isDeviceFileName" ID="isDeviceFileName"></a> | |
| 544 <h2>isDeviceFileName</h2> | |
| 545 <b>isDeviceFileName</b>(<i>fileName</i>) | |
| 546 | |
| 547 <p> | |
| 548 Function to check, if the given file name is a device file name. | |
| 549 </p> | |
| 550 <dl> | |
| 551 | |
| 552 <dt><i>fileName</i> (str)</dt> | |
| 553 <dd> | |
| 554 file name to be checked | |
| 555 </dd> | |
| 556 </dl> | |
| 557 <dl> | |
| 558 <dt>Return:</dt> | |
| 559 <dd> | |
| 560 flag indicating a device file name | |
| 561 </dd> | |
| 562 </dl> | |
| 563 <dl> | |
| 564 <dt>Return Type:</dt> | |
| 565 <dd> | |
| 566 bool | |
| 567 </dd> | |
| 568 </dl> | |
| 569 <div align="right"><a href="#top">Up</a></div> | |
| 570 <hr /> | |
| 571 <hr /> | |
| 490 <a NAME="isDrive" ID="isDrive"></a> | 572 <a NAME="isDrive" ID="isDrive"></a> |
| 491 <h2>isDrive</h2> | 573 <h2>isDrive</h2> |
| 492 <b>isDrive</b>(<i>path</i>) | 574 <b>isDrive</b>(<i>path</i>) |
| 493 | 575 |
| 494 <p> | 576 <p> |
| 537 </dd> | 619 </dd> |
| 538 </dl> | 620 </dl> |
| 539 <div align="right"><a href="#top">Up</a></div> | 621 <div align="right"><a href="#top">Up</a></div> |
| 540 <hr /> | 622 <hr /> |
| 541 <hr /> | 623 <hr /> |
| 624 <a NAME="isPlainFileName" ID="isPlainFileName"></a> | |
| 625 <h2>isPlainFileName</h2> | |
| 626 <b>isPlainFileName</b>(<i>fileName</i>) | |
| 627 | |
| 628 <p> | |
| 629 Function to check, if the given file name is a plain (i.e. local) file name. | |
| 630 </p> | |
| 631 <dl> | |
| 632 | |
| 633 <dt><i>fileName</i> (str)</dt> | |
| 634 <dd> | |
| 635 file name to be checked | |
| 636 </dd> | |
| 637 </dl> | |
| 638 <dl> | |
| 639 <dt>Return:</dt> | |
| 640 <dd> | |
| 641 flag indicating a local file name | |
| 642 </dd> | |
| 643 </dl> | |
| 644 <dl> | |
| 645 <dt>Return Type:</dt> | |
| 646 <dd> | |
| 647 bool | |
| 648 </dd> | |
| 649 </dl> | |
| 650 <div align="right"><a href="#top">Up</a></div> | |
| 651 <hr /> | |
| 652 <hr /> | |
| 653 <a NAME="isRemoteFileName" ID="isRemoteFileName"></a> | |
| 654 <h2>isRemoteFileName</h2> | |
| 655 <b>isRemoteFileName</b>(<i>fileName</i>) | |
| 656 | |
| 657 <p> | |
| 658 Function to check, if the given file name is a remote file name. | |
| 659 </p> | |
| 660 <dl> | |
| 661 | |
| 662 <dt><i>fileName</i> (str)</dt> | |
| 663 <dd> | |
| 664 file name to be checked | |
| 665 </dd> | |
| 666 </dl> | |
| 667 <dl> | |
| 668 <dt>Return:</dt> | |
| 669 <dd> | |
| 670 flag indicating a remote file name | |
| 671 </dd> | |
| 672 </dl> | |
| 673 <dl> | |
| 674 <dt>Return Type:</dt> | |
| 675 <dd> | |
| 676 bool | |
| 677 </dd> | |
| 678 </dl> | |
| 679 <div align="right"><a href="#top">Up</a></div> | |
| 680 <hr /> | |
| 681 <hr /> | |
| 542 <a NAME="isinpath" ID="isinpath"></a> | 682 <a NAME="isinpath" ID="isinpath"></a> |
| 543 <h2>isinpath</h2> | 683 <h2>isinpath</h2> |
| 544 <b>isinpath</b>(<i>file</i>) | 684 <b>isinpath</b>(<i>file</i>) |
| 545 | 685 |
| 546 <p> | 686 <p> |
| 695 </dd> | 835 </dd> |
| 696 </dl> | 836 </dl> |
| 697 <div align="right"><a href="#top">Up</a></div> | 837 <div align="right"><a href="#top">Up</a></div> |
| 698 <hr /> | 838 <hr /> |
| 699 <hr /> | 839 <hr /> |
| 840 <a NAME="plainFileName" ID="plainFileName"></a> | |
| 841 <h2>plainFileName</h2> | |
| 842 <b>plainFileName</b>(<i>fileName</i>) | |
| 843 | |
| 844 <p> | |
| 845 Function to create a plain file name given a device or remote file name. | |
| 846 </p> | |
| 847 <dl> | |
| 848 | |
| 849 <dt><i>fileName</i> (str)</dt> | |
| 850 <dd> | |
| 851 device or remote file name | |
| 852 </dd> | |
| 853 </dl> | |
| 854 <dl> | |
| 855 <dt>Return:</dt> | |
| 856 <dd> | |
| 857 plain file name | |
| 858 </dd> | |
| 859 </dl> | |
| 860 <dl> | |
| 861 <dt>Return Type:</dt> | |
| 862 <dd> | |
| 863 str | |
| 864 </dd> | |
| 865 </dl> | |
| 866 <div align="right"><a href="#top">Up</a></div> | |
| 867 <hr /> | |
| 868 <hr /> | |
| 700 <a NAME="relativeUniversalPath" ID="relativeUniversalPath"></a> | 869 <a NAME="relativeUniversalPath" ID="relativeUniversalPath"></a> |
| 701 <h2>relativeUniversalPath</h2> | 870 <h2>relativeUniversalPath</h2> |
| 702 <b>relativeUniversalPath</b>(<i>path, start</i>) | 871 <b>relativeUniversalPath</b>(<i>path, start</i>) |
| 703 | 872 |
| 704 <p> | 873 <p> |
| 724 </dd> | 893 </dd> |
| 725 </dl> | 894 </dl> |
| 726 <div align="right"><a href="#top">Up</a></div> | 895 <div align="right"><a href="#top">Up</a></div> |
| 727 <hr /> | 896 <hr /> |
| 728 <hr /> | 897 <hr /> |
| 898 <a NAME="remoteFileName" ID="remoteFileName"></a> | |
| 899 <h2>remoteFileName</h2> | |
| 900 <b>remoteFileName</b>(<i>fileName</i>) | |
| 901 | |
| 902 <p> | |
| 903 Function to create a remote file name given a plain file name. | |
| 904 </p> | |
| 905 <dl> | |
| 906 | |
| 907 <dt><i>fileName</i> (str)</dt> | |
| 908 <dd> | |
| 909 plain file name | |
| 910 </dd> | |
| 911 </dl> | |
| 912 <dl> | |
| 913 <dt>Return:</dt> | |
| 914 <dd> | |
| 915 remote file name | |
| 916 </dd> | |
| 917 </dl> | |
| 918 <dl> | |
| 919 <dt>Return Type:</dt> | |
| 920 <dd> | |
| 921 str | |
| 922 </dd> | |
| 923 </dl> | |
| 924 <div align="right"><a href="#top">Up</a></div> | |
| 925 <hr /> | |
| 926 <hr /> | |
| 729 <a NAME="samefilepath" ID="samefilepath"></a> | 927 <a NAME="samefilepath" ID="samefilepath"></a> |
| 730 <h2>samefilepath</h2> | 928 <h2>samefilepath</h2> |
| 731 <b>samefilepath</b>(<i>f1, f2</i>) | 929 <b>samefilepath</b>(<i>f1, f2</i>) |
| 732 | 930 |
| 733 <p> | 931 <p> |
