Class: QgsArchive¶

Manages zip/unzip operations for an archive.

Class Hierarchy¶

Allows managing the zip/unzip actions on project files.

Methods

`addFile`	Add a new file to this archive.
`clear`	Clear the current content of this archive and create a new temporary directory.
`dir`	Returns the current temporary directory.
`exists`	Returns `True` if the archive exists on the filesystem, `False` otherwise.
`files`	Returns the list of files within this archive
`removeFile`	Remove a file from this archive and from the filesystem.
`zip`	Zip the content of this archive

Virtual Methods

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

Clear the current content of this archive and unzip.

class qgis.core.QgsArchive[source]¶

Bases: object

addFile(self, filename: str | None)[source]¶

Add a new file to this archive. During a zip action, this file will be part of the resulting zipped file.

Parameters:: filename (Optional[str]) – A file to add when zipping this archive

clear(self)[source]¶: Clear the current content of this archive and create a new temporary directory.

dir(self) → str[source]¶

Returns the current temporary directory.

exists(self) → bool[source]¶

Returns True if the archive exists on the filesystem, False otherwise.

Added in version 3.20.

files(self) → List[str][source]¶

Returns the list of files within this archive

removeFile(self, filename: str | None) → bool[source]¶

Remove a file from this archive and from the filesystem.

Parameters:: filename (Optional[str]) – The path of the file to remove
Return type:: bool
Returns:: True if the file has been removed from the filesystem, False otherwise

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

Clear the current content of this archive and unzip. Files are unzipped in the temporary directory.

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

Zip the content of this archive

Parameters:: zipFilename (Optional[str]) – The name of the zip to generate
Return type:: bool
Returns:: False if something goes wrong, True otherwise