Class: QgsProjectArchive¶

Allows managing the zip/unzip actions on project files.

Class Hierarchy¶

Base classes¶

QgsArchive

Manages zip/unzip operations for an archive.

Methods

`auxiliaryStorageFile`	Returns the current .qgd auxiliary storage file or an empty string if there's none
`clearProjectFile`	Remove the current .qgs project file from the temporary directory.
`projectFile`	Returns the current .qgs project file or an empty string if there's none

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsProjectArchive. See the FAQ for more details.

unzip

Clear the current content of this archive and unzip.

class qgis.core.QgsProjectArchive[source]¶

Bases: QgsArchive

auxiliaryStorageFile(self) → str[source]¶

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

Return type:: str

clearProjectFile(self) → bool[source]¶

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[source]¶

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

Return type:: str

virtual unzip(self, zipFilename: str | None) → bool[source]¶

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