Class: QgsFileUtils¶
-
class
qgis.core.
QgsFileUtils
¶ Bases:
sip.wrapper
Class for file utilities.
New in version 3.0: Enums
Methods
Ensures that a
fileName
ends with an extension from the specifiedfilter
string.Ensures that a
fileName
ends with an extension from the provided list ofextensions
.Returns a list of the extensions contained within a file
filter
string.Returns the top-most existing folder from
path
.Returns the human size from bytes
Converts a
string
to a safe filename, replacing characters which are not safe for filenames with an ‘_’ character.Signals
Attributes
-
addExtensionFromFilter
(fileName: str, filter: str) → str¶ Ensures that a
fileName
ends with an extension from the specifiedfilter
string.E.g. a
fileName
of “d:/my_file” with a filter of “GeoTIFF Files (*.tiff *.tif)” will return “d:/my_file.tif”, where asfileName
of “d:/my_file.TIFF” or “d:/my_file.TIF” will be returned unchanged.See also
See also
-
ensureFileNameHasExtension
(fileName: str, extensions: Iterable[str]) → str¶ Ensures that a
fileName
ends with an extension from the provided list ofextensions
.E.g. if extensions contains “tif” and “tiff”, then a
fileName
of “d:/my_file” will return “d:/my_file.tif”. AfileName
of “d:/my_file.TIFF” or “d:/my_file.TIF” will be returned unchanged.See also
See also
-
extensionsFromFilter
(filter: str) → List[str]¶ Returns a list of the extensions contained within a file
filter
string. E.g. afilter
of “GeoTIFF Files (*.tiff *.tif)” would return a list containing “tiff”, “tif”. The initial ‘.’ is stripped off the extension.See also
See also
-
findClosestExistingPath
(path: str) → str¶ Returns the top-most existing folder from
path
. E.g. ifpath
is “/home/user/projects/2018/P4343” and “/home/user/projects” exists but no “2018” subfolder exists, then the function will return “/home/user/projects”.New in version 3.2.
-
representFileSize
(bytes: int) → str¶ Returns the human size from bytes
-
stringToSafeFilename
(string: str) → str¶ Converts a
string
to a safe filename, replacing characters which are not safe for filenames with an ‘_’ character.Warning
This method strips slashes from the filename, so it is safe to call with file names only, not complete paths.
-