Class: QgsProjectArchive

Allows managing the zip/unzip actions on project files.

Class Hierarchy

Base classes

QgsArchive

Manages zip/unzip operations for an archive.

class qgis.core.QgsProjectArchive

Bases: QgsArchive

auxiliaryStorageFile(self) → str

Returns the current .qgd auxiliary storage file or an empty string if there’s none

Return type:

str

clearProjectFile(self) → bool

Remove the current .qgs project file from the temporary directory.

Return type:

bool

Returns:

True if the file is well removed, False otherwise

projectFile(self) → str

Returns the current .qgs project file or an empty string if there’s none

Return type:

str

virtual unzip(self, zipFilename: str | None) → bool

Clear the current content of this archive and unzip. If a project file is found in the content, then this archive may be considered as a valid one. Files are unzipped in the temporary directory.

Parameters:

zipFilename (Optional[str]) – The zip file to unzip

Return type:

bool

Returns:

True if a project file has been found, False otherwise