eric7.SystemUtilities.FileSystemUtilities

Module implementing file system related utility functions.

Global Attributes

Classes

Functions

absolutePath

Public method to convert a path relative to a start path to an absolute path.

path (str)

file or directory name to convert

start (str)

start path

Return:

absolute path

Return Type:

str

absoluteUniversalPath

Public method to convert a path relative to a start path with universal separators to an absolute path.

path (str)

file or directory name to convert

start (str)

start path

Return:

absolute path with native separators

Return Type:

str

checkValidPath

Function to check the given path for any invalid characters (basic shell metacharacters).

A critical error message is shown with the given message or a default one, if such characters are found. In that situation an empty path will be returned. If the path is OK, it will be returned unaltered or as an normalized absolute path, if the 'to_abs' flagis True.

path (str)

file or directory path to be checked

msg (str (optional))

error message to be shown in case of bad characters (defaults to ""). It may contain one replacement field named 'path' to receive the passed in path.

to_abs (bool (optional))

flag indicating to convert the path to a normalized absolute path (defaults to False)

Return:

validated path iaw. described rules

Return Type:

str

compactPath

Function to return a compacted path fitting inside the given width.

path (str)

path to be compacted

width (int)

width for the compacted path

measure (function(str))

reference to a function used to measure the length of the string

Return:

compacted path

Return Type:

str

deviceFileName

Function to create a device (MicroPython) file name given a plain file name.

fileName (str)

plain file name

Return:

device file name

Return Type:

str

direntries

Function returning a list of all files and directories.

path (str)

root of the tree to check

filesonly (bool (optional))

flag indicating that only files are wanted (defaults to False)

pattern (str or list of str (optional))

a filename pattern or list of filename patterns to check against (defaults to None)

followsymlinks (bool (optional))

flag indicating whether symbolic links should be followed (defaults to True)

checkStop (function (optional))

function to be called to check for a stop (defaults to None)

ignore (list of str (optional))

list of entries to be ignored (defaults to None)

recursive (bool (optional))

flag indicating a recursive search (defaults to True)

dirsonly (bool)

flag indicating to return only directories. When True it has precedence over the 'filesonly' parameter ((defaults to False)

Return:

list of all files and directories in the tree rooted at path. The names are expanded to start with path.

Return Type:

list of str

findVolume

Function to find the directory belonging to a given volume name.

volumeName (str)

name of the volume to search for

findAll (bool (optional))

flag indicating to get the directories for all volumes starting with the given name (defaults to False)

markerFile (str (optional))

name of a file to check for its existence (defaults to None)

Return:

directory path or list of directory paths for the given volume name

Return Type:

str or list of str

fromNativeSeparators

Function returning a path, that is using "/" separator characters.

path (str)

path to be converted

Return:

path with converted separator characters

Return Type:

str

getDirSize

Function to calculate the directory size for a given path.

path (str (optional))

name of the directory (defaults to ".")

recurse (bool (optional))

flag indicating a recursive calculation (i.e. calculate the size of the directory tree rooted at the given path) (defaults to False)

Return:

size in bytes

Return Type:

int

getDirTreeSize

Function to calculate the directory tree size for a given path.

path (str (optional))

name of the directory (defaults to ".")

Return:

size in bytes

Return Type:

int

getDirs

Function returning a list of all directories below path.

path (str)

root of the tree to check

excludeDirs (list of str)

base name of directories to ignore

Return:

list of all directories found

Return Type:

list of str

getExecutablePath

Function to build the full path of an executable file from the environment.

file (str)

filename of the executable to check

Return:

full executable name, if the executable file is accessible via the executable search path defined by the PATH environment variable, or an empty string otherwise.

Return Type:

str

getExecutablePaths

Function to build all full path of an executable file from the environment.

file (str)

filename of the executable

Return:

list of full executable names, if the executable file is accessible via the executable search path defined by the PATH environment variable, or an empty list otherwise.

Return Type:

list of str

getSize

Function to calculate the size of a given file or directory.

path (str (optional))

path of the file or directory (defaults to ".")

recurse (bool (optional))

flag indicating a recursive calculation (i.e. calculate the size of the directory tree rooted at the given path) (defaults to False)

Return:

size in bytes

Return Type:

int

getUserMounts

Function to determine all available user mounts.

Note: On Windows platforms all available drives are returned.

Return:

list of user mounts or drives

Return Type:

list of str

isDeviceFileName

Function to check, if the given file name is a device file name.

fileName (str)

file name to be checked

Return:

flag indicating a device file name

Return Type:

bool

isDrive

Function to check, if a path is a Windows drive.

path (str)

path name to be checked

Return:

flag indicating a Windows drive

Return Type:

bool

isExecutable

Function to check, if a file is executable.

exe (str)

filename of the executable to check

Return:

flag indicating executable status

Return Type:

bool

isPlainFileName

Function to check, if the given file name is a plain (i.e. local) file name.

fileName (str)

file name to be checked

Return:

flag indicating a local file name

Return Type:

bool

isRemoteFileName

Function to check, if the given file name is a remote file name.

fileName (str)

file name to be checked

Return:

flag indicating a remote file name

Return Type:

bool

isinpath

Function to check for an executable file.

file (str)

filename of the executable to check

Return:

flag indicating, if the executable file is accessible via the executable search path defined by the PATH environment variable.

Return Type:

bool

joinext

Function to join a file extension to a path.

The leading "." of ext is replaced by a platform specific extension separator if necessary.

prefix (str)

the basepart of the filename

ext (str)

the extension part

Return:

the complete filename

Return Type:

str

normabsjoinpath

Function returning a normalized, absolute path of the joined parts passed into it.

a (str)

first path to be joined

p (str)

variable number of path parts to be joined

Return:

absolute, normalized path

Return Type:

str

normcaseabspath

Function returning an absolute path, that is normalized with respect to its case and references.

path (str)

file path

Return:

absolute, normalized path

Return Type:

str

normcasepath

Function returning a path, that is normalized with respect to its case and references.

path (str)

file path

Return:

case normalized path

Return Type:

str

normjoinpath

Function returning a normalized path of the joined parts passed into it.

a (str)

first path to be joined

p (str)

variable number of path parts to be joined

Return:

normalized path

Return Type:

str

plainFileName

Function to create a plain file name given a device or remote file name.

fileName (str)

device or remote file name

Return:

plain file name

Return Type:

str

relativeUniversalPath

Function to convert a file path to a path relative to a start path with universal separators.

path (str)

file or directory name to convert

start (str)

start path

Return:

relative path or unchanged path, if path does not start with the start path with universal separators

Return Type:

str

remoteFileName

Function to create a remote file name given a plain file name.

fileName (str)

plain file name

Return:

remote file name

Return Type:

str

samefilepath

Function to compare two paths. Strips the filename.

f1 (str)

first filepath for the compare

f2 (str)

second filepath for the compare

followSymlinks (bool (optional))

flag indicating to respect symbolic links for the comparison (i.e. compare the real paths) (defaults to True)

Return:

flag indicating whether the two paths represent the same path on disk

Return Type:

bool

samepath

Function to compare two paths.

f1 (str)

first filepath for the compare

f2 (str)

second filepath for the compare

followSymlinks (bool (optional))

flag indicating to respect symbolic links for the comparison (i.e. compare the real paths) (defaults to True)

Return:

flag indicating whether the two paths represent the same path on disk

Return Type:

bool

splitPath

Function to split a pathname into a directory part and a file part.

name (str)

path name

Return:

tuple containing directory name and file name

Return Type:

tuple of (str, str)

startfile

Function to open the given file path with the system default application.

filePath (str or Path)

file path to be opened

Return:

flag indicating a successful start of the associated application

Return Type:

bool

startsWithPath

Function to check, if a path starts with a given start path.

path (str)

path to be checked

start (str)

start path

Return:

flag indicating that the path starts with the given start path

Return Type:

bool

toNativeSeparators

Function returning a path, that is using native separator characters.

path (str)

path to be converted

Return:

path with converted separator characters

Return Type:

str

winGetVolumes

Function to determine all volumes and associated drive letters that could possibly belong to a MicroPython device (Windows only).

Return:

list of tuples containing the volume name and associated drive letter

Return Type:

list of tuples of (str, str)