Zip Class

Properties   Methods   Events   Config Settings   Errors  

The Zip class implements a PKZip-compatible Zip compressor and decompressor.

Syntax

class ipworkszip.Zip

Remarks

The class uses the Deflate algorithm specified in RFC 1951 for compression, and produces and reads output compatible with PKZip, WinZip, etc.

To create a new archive, first set the archive_file property to the name of the archive to be created. Then, specify the files to be compressed either by invoking include_files, or by adding a new object to the files collection and setting the values of the file_decompressed_name and file_compressed_name. fields. Finally, call the compress method to create the archive.

To decompress an existing archive, set archive_file to the name of the archive to be decompressed. The extract_to_path property may be set, and then calling the extract_all method will decompress all files in the archive to this path.

For finer control, the scan method should be used to read the file information stored in the archive. This will fill out the information in the files collection. The values of file_decompressed_name may then be changed if desired. Finally, extract_all may be used to decompress the entire archive, or extract may be used for finer control.

Data may be streamed out by setting WriteToProgressEvent to true. Then, the on_progress event may be trapped to retrieve the data.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress()

Example (Extracting from an Archive)

ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll()

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

archive_file Property

The name of the zip, gzip, tar, or jar archive.

Syntax

def get_archive_file() -> str: ...
def set_archive_file(value: str) -> None: ...

archive_file = property(get_archive_file, set_archive_file)

Default Value

""

Remarks

This property specifies the name of the archive to be read or written. This property is required when extracting files.

When scan, extract, or extract_all is invoked, the file specified by archive_file will be opened for read. If the file does not exist, a trappable error will be generated.

When compress is called, the file named by archive_file will be written; if a file of this name already exists the on_overwrite event will be fired. If archive_file is set to the empty string (""), the archive will not be written to disk, and will be provided only through the on_progress event.

The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as "zip"); an extension will not automatically be appended by the class.

If the file cannot be read, or written, as appropriate, a trappable error will be generated.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress()

Note: an archive already open for read may be closed by setting archive_file to the empty string ("").

compression_level Property

The compression level to use.

Syntax

def get_compression_level() -> int: ...
def set_compression_level(value: int) -> None: ...

compression_level = property(get_compression_level, set_compression_level)

Default Value

4

Remarks

This property specifies the level of compression to be used, between 0 and 6. Higher values will cause the class to compress better; lower values will cause the class to compress faster. A value of 0 will store the file without compression.

Set the level of compression_level in the on_begin_file event to apply different levels of compression to different files.

compression_method Property

The compression method to use.

Syntax

def get_compression_method() -> int: ...
def set_compression_method(value: int) -> None: ...

compression_method = property(get_compression_method, set_compression_method)

Default Value

0

Remarks

This property specifies the compression method to use. By default the class uses the Deflate compression method (a value of 0). Supported values are:

• 0 (cmDeflate - default)
• 1 (cmPPMd)
• 2 (cmBzip2)

encryption_algorithm Property

The algorithm used to encrypt files written to the archive.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

0

Remarks

The algorithm used to encrypt files written to the archive.

Note that files will only be encrypted if password is set. By default the class will use standard zip encryption if password is set, and will not encrypt data otherwise.

The class supports the use of AES, the Advanced Encryption Standard, as well as standard Zip encryption. The default encryption algorithm is the algorithm introduced in version 2.0 of the Zip specification, and is compatible with virtually all other zip utilities. However, this algorithm is considered weak and should not be used to protect sensitive data.

AES is a U.S. government standard cleared to protect even the most sensitive data. The file format used to create AES-encrypted files is designed to be compatible with WinZip 9.0. AES-encrypted files created by the class may or may not be compatible with other Zip utilities.

The class supports the use of AES with key lengths of 128, 192, or 256 bits. Note that even with the weakest (128-bit) keys AES is much more secure than standard Zip encryption.

If you use strong or maximum AES encryption the class will generate a unique salt value and cryptographic key for each file encrypted. If you use weak encryption the class will use the same salt for each file in the archive. If you are encrypting a large number of files this will have a substantial effect on performance. Set the AESGenerateUniqueKeys configuration setting to configure the salt generation independent of the key length.

If using AES encryption it is important to choose a good password. For 128-bit keys it is recommended that your password be 32 characters long, and for 256-bit keys, 64 characters.

Important: Note that AES encryption only encrypts the contents of encrypted files within the Zip archive; it does not prevent an attacker from reading the names of files in the archive, or from adding or deleting files to or from the archive. To prevent this consider first storing your files in an unencrypted zip file, and then storing this zip file in another, AES-encrypted zip file.

Property values:

excluded_files Property

A list of files to exclude.

Syntax

def get_excluded_files() -> str: ...
def set_excluded_files(value: str) -> None: ...

excluded_files = property(get_excluded_files, set_excluded_files)

Default Value

""

Remarks

This property specifies files that should be excluded when compress or extract is invoked. When compress is invoked, each value of file_decompressed_name in files will be compared to excluded_files, and each file will be excluded if the name matches. When extract is called, each value of file_compressed_name in files matching the parameter to extract will be compared to excluded_files, and will be excluded if appropriate. Calling the extract_all method will ignore this property and extract all files in the archive.

This property may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be excluded; subdirectories will be recursed into if recurse_subdirectories is true. If no path is specified but wildcards are, matching files in all directories will be excluded. If a single filename without a path is specified, it must correspond exactly to the appropriate value of file_compressed_name or file_decompressed_name.

Directories should end with a slash ("/" or "\", as appropriate.) If a directory is specified, all files and subdirectories in the specified directory will be excluded.

A pipe character ("|") should be used to separate multiple file or directory names.

The following examples illustrate the use of the property:

Example

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.IncludeFiles("c:\test\*") ZipControl.ExcludedFiles = "*.tmp" ZipControl.Compress() Example

ZipControl.ArchiveFile = "c:\test.tar" ZipControl.Scan() ZipControl.ExcludedFiles = "*.bak | backup/" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("*") As per the examples, the property should be specified differently for compression and decompression. When invoking compress, the format of excluded_files should correspond to that of the local file system. When invoking extract the format should correspond to standard (UNIX) format, and should not contain drive letters or backslashes.

You may exclude files based on their attributes as well: See the ExcludedAttributes configuration setting for more information.

If the property is set to the empty string, no files will be excluded. This property is never reset automatically, so be sure to reset it manually if using a single instance of the class for both compression and extraction. Failure to do so may result in I/O errors or unexpected results.

extract_to_path Property

A base path to decompress to.

Syntax

def get_extract_to_path() -> str: ...
def set_extract_to_path(value: str) -> None: ...

extract_to_path = property(get_extract_to_path, set_extract_to_path)

Default Value

""

Remarks

Setting the extract_to_path property affects the operation of the extract and extract_all methods. Setting this property to a nonempty string will cause all decompressed files to be written to the specified path. If pathnames are given in the values of file_decompressed_name they will be regarded as relative to extract_to_path.

If the specified directory does not exist, it will be created when extraction is done.

extract_to_path should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\temp\" on a Windows system.

Example (Extracting from an Archive)

ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll()

Example - Adding Files Dim i as Integer ZipControl.ArchiveFile = "c:\test.zip" ZipControl.Scan() For i = 0 to ZipControl.Files.Count - 1 ZipControl.Files(i).DecompressedName(i) = "c:\temp\" + ZipControl.Files(i).DecompressedName Next i ZipControl.ExtractToPath = "" ZipControl.ExtractAll() ZipControl.IncludeFiles("c:\extra\*") ZipControl.Compress()

file_count Property

The number of records in the File arrays.

Syntax

def get_file_count() -> int: ...
def set_file_count(value: int) -> None: ...

file_count = property(get_file_count, set_file_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• file_attributes
• file_comment
• file_compressed_date
• file_compressed_name
• file_compressed_size
• file_compression_level
• file_crc
• file_decompressed_name
• file_decompressed_size
• file_encryption_algorithm
• file_hash
• file_input_data
• file_password
• file_password_required

The array indices start at 0 and end at file_count - 1.

file_attributes Property

The attributes of the files to be compressed or decompressed.

Syntax

def get_file_attributes(file_index: int) -> int: ...
def set_file_attributes(file_index: int, value: int) -> None: ...

Default Value

0

Remarks

The attributes of the files to be compressed or decompressed. It will then be written to the archive during compression and to the file system during extraction.

If desired, you may change the value of Attributes before compressing or decompressing.

The property is a bitmask of flags, corresponding to the MS-DOS directory byte:

In the Java Edition, due to limitations of the JRE, the effect of this property is limited. When including files, only the Hidden and Readonly bits will be read from the file system, and during extraction only the Readonly attribute will be written.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_comment Property

Specifies a comment for the entry in the zip file.

Syntax

def get_file_comment(file_index: int) -> str: ...
def set_file_comment(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

Specifies a comment for the entry in the zip file. Before compression, set This property to include comments in this zip file. After an archive has been scanned, This property will contain any comments the zip file contains.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_compressed_date Property

The date and time of the entry, as stored within the archive.

Syntax

def get_file_compressed_date(file_index: int) -> int: ...
def set_file_compressed_date(file_index: int, value: int) -> None: ...

Default Value

0

Remarks

The date and time of the entry, as stored within the archive.

FileCompressedDate contains the last modified date of the file, as stored within the archive (it does not generally correspond to when the file was compressed).

FileCompressedDate is returned in a platform-specific format. The Java,C++, and most other Editions will return the number of milliseconds since January 1, 1970, 00:00:00. This value may be passed directly to the java.util.Date constructor to create a java.util.Date object representing this date.

The .NET Edition will return the number of ticks, or 100-nanosecond intervals, since January 1, 0001, 00:00:00. This value may be passed directly to the System.DateTime constructor to create a System.DateTime object representing this date.

Reading the value of this property will return a meaningful value only after the archive has been successfully scanned or decompressed, and only if the values of archive_file, files collection, and file_compressed_name have not been changed since. If a meaningful value is not available this property will return a value of 0.

NOTE: This may be set accordingly when the file_input_stream property is set to a valid stream to input the data for the current file. If not set, the default, 0, is used. Otherwise the value is read from disk.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_compressed_name Property

The file name of the current file, as stored inside of the archive.

Syntax

def get_file_compressed_name(file_index: int) -> str: ...
def set_file_compressed_name(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

The file name of the current file, as stored inside of the archive. This may be the same as in file_decompressed_name, but is not required to be.

All paths are stored in the archive in standard (UNIX) format. Pathnames specified in the host operating system's format will be immediately converted.

This field should generally be set with a relative path or with no path at all. The exact interpretation of the path is left to the decompression software; generally, pathnames will be interpreted as relative to a base directory, and these subdirectories will be created as needed. Absolute pathnames (paths beginning with a / character) will not be interpreted correctly by the class, and may or may not be interpreted correctly by other decompression software.

Paths should be specified in standard (UNIX) format. They may also be specified in the format native to the host operating system, in which case they will be immediately converted.

Example

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.Files.Add(new ZIPFile()) ZipControl.Files[0].DecompressedName = "c:\test\ipworkszip\temp\test.txt" ZipControl.Files[0].CompressedName = "readme.txt" ZipControl.Compress()

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_compressed_size Property

The size of the compressed data, as compressed within the archive.

Syntax

def get_file_compressed_size(file_index: int) -> int: ...

Default Value

-1

Remarks

The size of the compressed data, as compressed within the archive. Headers, footers, etc., are not included in the size.

Reading the value of this property will return a meaningful value only after the archive has been compressed, scanned, or decompressed, and only if the values of archive_file, or files have not been changed since. If a meaningful value is not available this property will return a value of -1.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_compression_level Property

The compression level to use for the file.

Syntax

def get_file_compression_level(file_index: int) -> int: ...
def set_file_compression_level(file_index: int, value: int) -> None: ...

Default Value

4

Remarks

The compression level to use for the file. This property specifies the level of compression to be used, between 0 and 6. Higher values will cause the class to compress better; lower values will cause the class to compress faster. A value of 0 will store the file without compression.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_crc Property

The CRC value for the specified file found in the archive.

Syntax

def get_file_crc(file_index: int) -> int: ...

Default Value

0

Remarks

The file_crc value for the specified file found in the archive. This value is populated after compression or decompression.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_decompressed_name Property

The name of the file in the archive, as stored on the file system, outside the archive.

Syntax

def get_file_decompressed_name(file_index: int) -> str: ...
def set_file_decompressed_name(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the file in the archive, as stored on the file system, outside the archive.

When compressing files, This property should be specified with a path, if necessary, to allow the file to be found by the class. If the file cannot be found during compression, a trappable error will be generated, and the archive will not be correctly written.

When decompressing files, the property indicates where the file should be written. After the archive is scanned, the values of file_compressed_name and DecompressedName will be set to the exact filenames found in the archive. The value of DecompressedName may then be changed if desired.

If DecompressedName is set to an empty string before extraction, the file will not be written to disk at all. It will still be written to the Progress event if WriteToProgressEvent is set to true.

If DecompressedName is set to an empty string before compression, the file will be skipped, and not written to the archive.

A base path for decompression may be specified by setting the extract_to_path property. If extract_to_path is set to a non-empty string, the files will be decompressed to the directory specified in extract_to_path. If the value of file_decompressed_name contains a pathname it will be regarded as relative to extract_to_path.

Paths on the local file system should be specified in the format native to the host operating system. They may also be specified in standard (UNIX) format, in which case they will be immediately converted.

Example

ZipControl.ArchiveFile = "c:\test.tar" ZipControl.Scan() ZipControl.ExtractToPath = "c:\temp\" ZipControl.Files[1].DecompressedName = "test\temp.out" ZipControl.Extract(ZipControl.Files[1].CompressedName) Incorrect Example ZipControl.ExtractToPath = "c:\temp\" ZipControl.Files[1].DecompressedName = "c:\temp\test\temp.out" 'The file would be extracted to c:\temp\c:\temp\test\temp.out

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_decompressed_size Property

The size of the file, as decompressed outside the archive.

Syntax

def get_file_decompressed_size(file_index: int) -> int: ...

Default Value

-1

Remarks

The size of the file, as decompressed outside the archive. If an archive is open for read (i.e. has been scanned or decompressed), this information will be read from the archive headers. If an archive is not open for read, the class will retrieve the information for the corresponding value of file_decompressed_name from the local file system.

A value of -1 will be returned in case of an I/O error.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_encryption_algorithm Property

The algorithm used to encrypt the specified file written to the archive.

Syntax

def get_file_encryption_algorithm(file_index: int) -> int: ...
def set_file_encryption_algorithm(file_index: int, value: int) -> None: ...

Default Value

0

Remarks

The algorithm used to encrypt the specified file written to the archive.

Note that the file will only be encrypted if file_password is set. By default the class will use standard zip encryption if file_password is set, and will not encrypt data otherwise.

The class supports the use of AES, the Advanced Encryption Standard, as well as standard Zip encryption. The default encryption algorithm is the algorithm introduced in version 2.0 of the Zip specification, and is compatible with virtually all other zip utilities. However, this algorithm is considered weak and should not be used to protect sensitive data.

AES is a U.S. government standard cleared to protect even the most sensitive data. The file format used to create AES-encrypted files is designed to be compatible with WinZip 9.0. AES-encrypted files created by the class may or may not be compatible with other Zip utilities.

The class supports the use of AES with key lengths of 128, 192, or 256 bits. Note that even with the weakest (128-bit) keys AES is much more secure than standard Zip encryption.

If you use strong or maximum AES encryption the class will generate a unique salt value and cryptographic key for each file encrypted. If you use weak encryption the class will use the same salt for each file in the archive. If you are encrypting a large number of files this will have a substantial effect on performance. Set the AESGenerateUniqueKeys configuration setting to configure the salt generation independent of the key length.

If using AES encryption it is important to choose a good file_password. For 128-bit keys it is recommended that your password be 32 characters long, and for 256-bit keys, 64 characters.

Important: Note that AES encryption only encrypts the contents of encrypted files within the Zip archive; it does not prevent an attacker from reading the names of files in the archive, or from adding or deleting files to or from the archive. To prevent this consider first storing your files in an unencrypted zip file, and then storing this zip file in another, AES-encrypted zip file.

To set the file_encryption_algorithm or file_password properties for the entire archive, use the encryption_algorithm or password properties.

Property values:

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_hash Property

The computed hash for the specified File.

Syntax

def get_file_hash(file_index: int) -> str: ...

Default Value

""

Remarks

The computed hash for the specified File.

This property is populated with the hash value computed for the specified file after calling compress. This property is only applicable if the FileHashAlgorithm configuration setting is set.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

file_input_data Property

When This property is set, the class will read in the data from This property instead of reading from the file contained in the DecompressedName property.

Syntax

def get_file_input_data(file_index: int) -> bytes: ...
def set_file_input_data(file_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

When This property is set, the class will read in the data from This property instead of reading from the file contained in the file_decompressed_name property.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_password Property

This property specifies the case-sensitive password used to encrypt or decrypt the current file.

Syntax

def get_file_password(file_index: int) -> str: ...
def set_file_password(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property specifies the case-sensitive password used to encrypt or decrypt the current file. If set to an empty string, no password is used.

For archives that have multiple files with the same password, you may use the password property instead of the password property of the files collection. You may also use file_password_required property to see if a file requires a password after an archive has been scanned.

In this release, streaming out of encrypted archives is not supported. When compressing, WriteToProgressEvent must be set to false if Password is set.

Example (Compressing an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Password = "nsoftware" ZipControl.Compress()

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

file_password_required Property

This property describes whether or not the current file has been encrypted or not and requires a password to decompress.

Syntax

def get_file_password_required(file_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property describes whether or not the current file has been encrypted or not and requires a password to decompress. It is populated after the archive has been scanned.

The file_index parameter specifies the index of the item in the array. The size of the array is controlled by the file_count property.

This property is read-only.

overwrite_files Property

Whether or not to overwrite files.

Syntax

def get_overwrite_files() -> bool: ...
def set_overwrite_files(value: bool) -> None: ...

overwrite_files = property(get_overwrite_files, set_overwrite_files)

Default Value

TRUE

Remarks

If this property is set to true, existing files will be overwritten when decompressing. When extract or extract_all is called, each file specified in files will be checked for existence. If a file exists, the on_overwrite event will be fired, and the files will be overwritten if overwrite_files is set to true.

More precise control of which files should be overwritten may be gained by listening to the on_overwrite event and altering its parameters when the event is fired.

This property only affects the operation of extract and extract_all. When compressing files, archive_file will always be overwritten unless the user specifies otherwise in the on_overwrite event.

password Property

A password for the zip archive.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property specifies the case-sensitive password used to encrypt or decrypt the archive. If set to an empty string, no password is used.

In this release, streaming out of encrypted archives is not supported. When compressing, WriteToProgressEvent must be set to false if password is set.

Example (Compressing an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Password = "nsoftware" ZipControl.Compress()

recurse_subdirectories Property

Whether or not to recurse into subdirectories.

Syntax

def get_recurse_subdirectories() -> bool: ...
def set_recurse_subdirectories(value: bool) -> None: ...

recurse_subdirectories = property(get_recurse_subdirectories, set_recurse_subdirectories)

Default Value

TRUE

Remarks

This property affects the behavior of include_files and extract and the meaning of excluded_files. If this property is set to true, include_files will recurse into all subdirectories whenever it performs a search on the file system.

Be sure recurse_subdirectories is set to the appropriate value before invoking include_files, extract, or compress; changing the value of this property after method calls will not retroactively alter their effects.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress()

zip_comment Property

The comment for the entire zip file.

Syntax

def get_zip_comment() -> str: ...
def set_zip_comment(value: str) -> None: ...

zip_comment = property(get_zip_comment, set_zip_comment)

Default Value

""

Remarks

Specifies a global comment for the zip file. Set this property before invoking compress to include a comment in the zip file. Read it after invoking scan to read the zip comment.

zip_data Property

(Decompression only) The zip file contents as a byte array.

Syntax

def get_zip_data() -> bytes: ...
def set_zip_data(value: bytes) -> None: ...

zip_data = property(get_zip_data, set_zip_data)

Default Value

""

Remarks

Normally you should set archive_file before invoking scan or extract. If you prefer to read the zip file from memory you may set zip_data instead. zip_data should be set to the entire contents of the zip file; this will allow you to read from the archive without writing any temporary files to disk.

If you would like to extract data from the archive without ever writing to disk you should also set WriteToProgressEvent to true, and after invoking scan, you should set the value of file_decompressed_name for each file in the files collection to an empty string. Then, when you invoke extract (or extract_all) the data will be provided in the on_progress event.

This property is write-only. Note that modifying a zip file stored in zip_data is not supported, so append, delete, etc., will throw exceptions.

abort Method

Aborts the current operation.

Syntax

def abort() -> None: ...

Remarks

abort may be used to immediately interrupt compression or decompression. Any files partially written by the class will be deleted.

In case append or delete is aborted the archive will be left in its original state.

append_files Method

Adds specified files to an existing archive.

Syntax

def append_files() -> None: ...

Remarks

All files contained in the files collection will be appended to the archive specified by archive_file.

When append_files is called, only those files which are to be added to the archive must exist inside the collection. Note that if you call scan or extract, you must empty the collection before adding files to the collection to be appended.

After the file is added, the collection will be updated appropriately.

This method may only be used to add files to an existing archive. To add files to a new archive, the include_files and compress methods should be used.

compress Method

Creates the compressed archive.

Syntax

def compress() -> None: ...

Remarks

Invoking compress creates the archive specified by archive_file. When the method is called, all files specified by the file_decompressed_name field of the files collection will be compressed and written to archive_file.

The compressed data may be streamed out by setting WriteToProgressEvent to true. If streaming is enabled the compressed data will also be provided via the on_progress event. If archive_file is set to an empty string the archive will be written only to this event.

The files to compress are specified in the files collection. The file names are specified by file_compressed_name and file_decompressed_name. These should be specified before invoking compress, either manually or by invoking include_files.

The on_begin_file and on_end_file events will be fired as files are processed, and the on_progress event will be fired as data is compressed.

Existing files will be overwritten by the class if overwrite_files is set to true. Finer control over which files are overwritten may be gained by trapping the on_overwrite event.

Example (Creating an Archive)

ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress()

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

delete Method

Deletes one or more files from an existing archive.

Syntax

def delete(file_names: str) -> None: ...

Remarks

delete deletes one or more files from an existing archive, without reprocessing the compressed data. The archive will be opened immediately, and the file(s) will immediately be removed permanently from the archive.

The list of filenames should be specified exactly as when calling extract:

Filenames may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if recurse_subdirectories is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of file_compressed_name.

Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.

A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

The excluded_files property may be used to further limit the files to be deleted. When delete is used to delete a directory or match wildcards, each file to be deleted is first compared against excluded_files, and any files marked as excluded will not be deleted. When delete is used to delete a single file, the value of excluded_files will be ignored.

When the method is invoked, the scan method will first be invoked, if it has not been invoked already. Note that if include_files has been invoked, or if the values of file_compressed_name and file_decompressed_name for each file in the files collection have been set, this information will be reset by the call to scan.

When deleting multiple files, the class will operate most efficiently if all filenames are passed to delete in a single invocation of the method. Invoking delete repeatedly on large archives is not recommended.

Invoking delete will only remove files from archive_file; it will not delete the files from the disk.

Example

ZipControl.ArchiveFile = "c:\\test.zip" ZipControl.Delete("default_readme.txt"); ZipControl.Append("\\mydir\\my_readme.txt", "my_readme.txt")

extract Method

Extracts a single file, directory, or group of files, from the archive.

Syntax

def extract(file_names: str) -> None: ...

Remarks

extract extracts one or more files from the archive. The file(s) will be extracted to the directory specified by extract_to_path, and given the names found in the archive or specified by the file_decompressed_name of the file in the files collection.

Filenames may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if recurse_subdirectories is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of file_compressed_name.

Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.

A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

The excluded_files property may be used to further limit the files to be extracted. When extract is used to extract a directory or match wildcards, each file to be extracted is first compared against excluded_files, and any files marked as excluded will not be extracted. When extract is used to extract a single file, the value of excluded_files will be ignored.

To extract all files in the archive, the extract_all method may be used.

The on_begin_file and on_end_file events will be fired before and after each file is extracted, and the on_progress event will be fired as the data is extracted. If WriteToProgressEvent is set to true, the decompressed data will be streamed out through the on_progress event.

Example

ZipControl.ArchiveFile = "c:\test.tar" ZipControl.ExcludedFiles = "*.bak | backup/" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("*") Example ZipControl.ArchiveFile = "c:\test.zip" ZipControl.ExcludedFiles = "" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("code/") Example ZipControl.ArchiveFile = "c:\test.jar" ZipControl.ExcludedFiles = "*.txt" ZipControl.ExtractToPath = "c:\" ZipControl.Extract("* | docs/readme.txt")

extract_all Method

Extracts all files from the compressed archive.

Syntax

def extract_all() -> None: ...

Remarks

extract_all extracts all files from the archive. The file(s) will be extracted to the directory specified by extract_to_path, and given the names found in the archive or specified by the file_decompressed_name field of the file in the files collection.

If scan has not been invoked when extract_all is called, scan will automatically be invoked, and the files collection will be set to the values found in the archive. To manually set the decompressed filenames, scan should be invoked before setting the file_decompressed_name field.

Invoking this method is equivalent to setting excluded_files to the empty string, and then invoking extract with "*" as the argument. Calling this method will cause the excluded_files property to be ignored; to extract all files except those specified by excluded_files, call the extract method with the wildcard "*" as the method parameter instead of calling this method.

The on_begin_file and on_end_file events will be fired before and after each file is extracted, and the on_progress event will be fired as the data is extracted. If WriteToProgressEvent is set to true, the decompressed data will be streamed out through the on_progress event.

Example (Extracting from an Archive)

ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll()

include_files Method

Specifies that the indicated files should be added to the archive.

Syntax

def include_files(file_names: str) -> None: ...

Remarks

include_files may be used before compress, to specify the files to be compressed. Invoking this method populates the files collection accordingly.

Invoking the method does not create or alter the archive.

The argument should be a pipe ("|") -delimited sequence of one or more filenames. The filenames should be specified with paths if necessary, so that the files may be found on the local file system. The filenames will be stored as is in the file_decompressed_name field, and without a pathname in the file_compressed_name field of the files collection.

Filenames may include the wildcards '?', '*', and '[ .. ]'. '?' will match any single character, and '*' will match an arbitrary sequence of characters. '[ .. ]' may be used to match any of the characters inside, or a range, such as '[a-z]'. A '\' can be used to escape wildcard characters.

If wildcards are specified, the file system will be scanned and all files matching the specified mask will be added. Moreover, subdirectories will be recursed into if recurse_subdirectories is set to true. When recursing into subdirectories, relative path information will be stored in file_compressed_name field of the files collection.

The excluded_files may be used to limit the files to be compressed. This property is checked when compress is invoked, rather than when include_files is invoked, so this property may be set before or after invoking include_files.

Note that invoking include_files will not reset the class, or remove old values of file_compressed_name and file_decompressed_name. This may be done by first clearing the files collection.

Example

ZipControl.IncludeFiles("c:\test\* | c:\readme") ZipControl.ExcludedFiles = "*.tmp" ZipControl.Compress()

reset Method

Resets the class.

Syntax

def reset() -> None: ...

Remarks

reset resets the state of the class. The files collection will be cleared, all properties will be set to their default values, and any files open will be closed.

scan Method

Scans the compressed archive.

Syntax

def scan() -> None: ...

Remarks

This method will scan the archive specified by archive_file. The number of files and their names and sizes will be determined and written to the files collection.

After scanning the archive, the values of file_decompressed_name may be changed if desired, and any number of files may be decompressed. The extract method allows you to decompress files of your choice, and the extract_all method will decompress the entire archive.

Changing the values of the file_compressed_name field or the number of files in the files collection will invalidate the scan. If either of these is changed and extract or extract_all is then called; scan will automatically be called again, and these values will be reset to their original values.

Calling this method will frequently generate a trappable error if the archive is corrupt. This is not guaranteed, however, as scan only examines the headers.

Example

Dim i As Integer ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.Scan For i = 0 To ZipControl.FileCount - 1 Debug.Print "File Name: " & ZipControl.FileDecompressedName(i) Debug.Print "File Size: " & ZipControl.FileDecompressedSize(i) Next i

update Method

Will update certain files in an archive.

Syntax

def update(file_names: str) -> None: ...

Remarks

When this method is called, the class will attempt to update files in the specified archive with the current files listed in the files collection. You may use the FileNames parameter to tell the class which files in the collection/archive must be updated.

Filenames may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if recurse_subdirectories is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of file_compressed_name.

Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected.

A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly.

on_begin_file Event

Fired before each file is processed.

Syntax

class ZipBeginFileEventParams(object):
  @property
  def index() -> int: ...

  @property
  def skip() -> bool: ...
  @skip.setter
  def skip(value) -> None: ...

# In class Zip:
@property
def on_begin_file() -> Callable[[ZipBeginFileEventParams], None]: ...
@on_begin_file.setter
def on_begin_file(event_hook: Callable[[ZipBeginFileEventParams], None]) -> None: ...

Remarks

on_begin_file is fired before each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file about to be processed, and the file_compressed_name, file_decompressed_name, file_compressed_size (decompression only), and file_decompressed_size fields of the files collection for this index contain more detailed information about the file about to be processed.

When extracting, an alternate location may be specified by trapping the event, and modifying file_decompressed_name and/or extract_to_path. If file_decompressed_name is set to an empty string, the file will not be written to disk. If WriteToProgressEvent is true, the file will still be decompressed, and the data may be extracted through the on_progress event.

This event may also be trapped while compressing. file_compressed_name and file_decompressed_name may be changed.

You may set the Skip parameter to true in order to skip the file completely while compressing or extracting.

on_end_file Event

Fired after each file is processed.

Syntax

class ZipEndFileEventParams(object):
  @property
  def index() -> int: ...

# In class Zip:
@property
def on_end_file() -> Callable[[ZipEndFileEventParams], None]: ...
@on_end_file.setter
def on_end_file(event_hook: Callable[[ZipEndFileEventParams], None]) -> None: ...

Remarks

on_end_file is fired after each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file processed, and the file_compressed_name, file_decompressed_name, file_compressed_size, and file_decompressed_size fields in the files collection for this index contain more detailed information about the file processed.

on_error Event

Information about non-fatal errors.

Syntax

class ZipErrorEventParams(object):
  @property
  def description() -> str: ...

  @property
  def error_code() -> int: ...

  @property
  def index() -> int: ...

  @property
  def filename() -> str: ...

  @property
  def ignore() -> bool: ...
  @ignore.setter
  def ignore(value) -> None: ...

# In class Zip:
@property
def on_error() -> Callable[[ZipErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[ZipErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired when non-fatal errors occur during compression or decompression. Note that if this event is fired during decompression this may indicate that the archive is corrupt.

By default these errors will cause the component to fail with an exception. The exception may be overridden by setting Ignore to true. This will cause the error to be ignored, the file will be skipped if necessary, and the class will continue operation.

ErrorCode will correspond to one of the following errors:

Description contains a textual description of the error. Index and Filename contain the array index (where appropriate) and filename of the file being processed at the time of the error.

on_overwrite Event

Fired whenever a file exists and may be overwritten.

Syntax

class ZipOverwriteEventParams(object):
  @property
  def filename() -> str: ...
  @filename.setter
  def filename(value) -> None: ...

  @property
  def overwrite() -> bool: ...
  @overwrite.setter
  def overwrite(value) -> None: ...

# In class Zip:
@property
def on_overwrite() -> Callable[[ZipOverwriteEventParams], None]: ...
@on_overwrite.setter
def on_overwrite(event_hook: Callable[[ZipOverwriteEventParams], None]) -> None: ...

Remarks

on_overwrite is fired when a file is about to be overwritten, and would overwrite an existing file. The event is fired during decompression.

Filename contains the full name of the file, specified with its pathname.

Overwrite specifies whether or not the file will be overwritten. For Zip, Jar, and Tar, this is equal by default to the value of the overwrite_files property. For Gzip, this value defaults to true.

Either of the parameters may be changed when the event is fired. Changing the value of Overwrite will override the default behavior of the class, and cause the file to be overwritten or not overwritten, depending on the value set. If Filename is changed, the value of Overwrite will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten.

on_password Event

Fired when a file is encrypted, and the file's password is incorrect.

Syntax

class ZipPasswordEventParams(object):
  @property
  def index() -> int: ...

  @property
  def password() -> str: ...
  @password.setter
  def password(value) -> None: ...

# In class Zip:
@property
def on_password() -> Callable[[ZipPasswordEventParams], None]: ...
@on_password.setter
def on_password(event_hook: Callable[[ZipPasswordEventParams], None]) -> None: ...

Remarks

This event is fired when the class attempts to uncompress an encrypted file and the decryption fails due to an invalid password. The file may be identified in the collection by the Index parameter.

Setting the Password parameter in this event will cause the class to attempt to decrypt and decompress the file again with the specified password.

If the Password parameter is an empty string when this event completes, an error will occur.

on_progress Event

Fired as progress is made.

Syntax

class ZipProgressEventParams(object):
  @property
  def data() -> bytes: ...

  @property
  def filename() -> str: ...

  @property
  def bytes_processed() -> int: ...

  @property
  def percent_processed() -> int: ...

# In class Zip:
@property
def on_progress() -> Callable[[ZipProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[ZipProgressEventParams], None]) -> None: ...

Remarks

The on_progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.

Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.

BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.

If WriteToProgressEvent is false, Data will contain null.

Zip Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

Zip Config Settings

Base Config Settings

Zip Errors

Errors

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

Note that some non-fatal errors may be trapped and explicitly ignored in the on_error event. This will allow the class to continue operation even in case of error.

Zip Errors