Class: QgsZipUtils¶
-
class
qgis.core.
QgsZipUtils
¶ Bases:
sip.simplewrapper
-
isZipFile
(filename: str) → bool¶ Returns true if the file name is a zipped file ( i.e with a ‘.qgz’ extension, false otherwise.
- Parameters
filename (str) – The name of the file
- Return type
bool
- Returns
true if the file is zipped, false otherwise
-
unzip
(zip: str, dir: str) → Tuple[bool, List[str]]¶ Unzip a zip file in an output directory. An error is returned if the zip filename does not exist, the output directory does not exist or is not writable.
- Parameters
zip (str) – The zip filename
dir (str) – The output directory
files – The absolute path of unzipped files
New in version 3.0.
- Return type
Tuple[bool, List[str]]
-
zip
(zip: str, files: Iterable[str]) → bool¶ Zip the list of files in the zip file. If the zip file already exists or is empty, an error is returned. If an input file does not exist, an error is also returned.
- Parameters
zip (str) – The zip filename
files (Iterable[str]) – The absolute path to files to embed within the zip
New in version 3.0.
- Return type
bool
-