Subgroup: File

Class: QgsFileUtils

class qgis.core.QgsFileUtils

Bases: sip.wrapper

Class for file utilities.

New in version 3.0: Methods

addExtensionFromFilter Ensures that a fileName ends with an extension from the specified filter string.
ensureFileNameHasExtension Ensures that a fileName ends with an extension from the provided list of extensions.
extensionsFromFilter Returns a list of the extensions contained within a file filter string.
findClosestExistingPath Returns the top-most existing folder from path.
representFileSize Returns the human size from bytes
stringToSafeFilename 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 specified filter string.

E.g. a fileName of “d:/my_file” with a filter of “GeoTIFF Files (*.tiff *.tif)” will return “d:/my_file.tif”, where as fileName of “d:/my_file.TIFF” or “d:/my_file.TIF” will be returned unchanged.

ensureFileNameHasExtension(fileName: str, extensions: Iterable[str]) → str

Ensures that a fileName ends with an extension from the provided list of extensions.

E.g. if extensions contains “tif” and “tiff”, then a fileName of “d:/my_file” will return “d:/my_file.tif”. A fileName of “d:/my_file.TIFF” or “d:/my_file.TIF” will be returned unchanged.

extensionsFromFilter(filter: str) → List[str]

Returns a list of the extensions contained within a file filter string. E.g. a filter of “GeoTIFF Files (*.tiff *.tif)” would return a list containing “tiff”, “tif”. The initial ‘.’ is stripped off the extension.

findClosestExistingPath(path: str) → str

Returns the top-most existing folder from path. E.g. if path 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.