Tar Class

Properties   Methods   Events   Config Settings   Errors  

The Tar class implements a tar archive utility, compatible with the UNIX tar and untar utilities. The class supports the old v7 tar format. The class also implements gzip compression and can be used to create or decompress .tar.gz archives.

Syntax

class ipworkszip.Tar

Remarks

The interface is identical to that of the Zip class, and is the same whether gzip compression is used or not. In particular, the compress method is used to create tar archives, even if actual compression is not used.

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.

tar.gz files may be created or extracted by setting the use_gzip_compression property to true. When compress is invoked, this will cause all output to be streamed through a gzip compressor as it is written. When extracting or scanning the tar archive will automatically be decompressed and written temporarily to disk. Note that this might cause scan, extract, and extract_all to operate slowly without firing events.

.gz files may also be compressed or decompressed using the Gzip class.

Example (Creating a Tar File)

ZipControl.ArchiveFile = "c:\test.tar.gz" ZipControl.RecurseSubdirectories = true ZipControl.UseGzipCompression = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress() Example (Extracting from a Tar File)

ZipControl.ArchiveFile = "c:\temp.tar" ZipControl.UseGzipCompression = false 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 ("").

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_compressed_date
• file_compressed_name
• file_compressed_size
• file_decompressed_name
• file_decompressed_size
• file_hard_link_name
• file_input_data
• file_permissions
• file_sym_link_name

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

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_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_hard_link_name Property

The hard link name, for a file that represents a hard link.

Syntax

def get_file_hard_link_name(file_index: int) -> str: ...
def set_file_hard_link_name(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

The hard link name, for a file that represents a hard link. If you specify file_hard_link_name the file will be added to the tar file as a hard link. You should specify the name of the link in file_compressed_name and the name of the linked file in file_hard_link_name.

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_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_permissions Property

This property contains the UNIX permissions of the file, as stored in the tar archive.

Syntax

def get_file_permissions(file_index: int) -> str: ...
def set_file_permissions(file_index: int, value: str) -> None: ...

Default Value

"644"

Remarks

This property contains the UNIX permissions of the file, as stored in the tar archive. It will be written to the tar archive during compression. As native code is not used, permissions are read from and written to the tar archive only, and not to the file system.

The value should be specified as a string of three characters, representing the owner's permissions, the group's permissions, and others' permissions. Each character should be a bitmask of 4 (read access), 2 (write access), or 1 (executable access), as in chmod.

In Java, if the SetFilePermissions configuration setting is set to true, the class will shell out an instance of chmod for each file, and will attempt to set the file permissions to those specified in file_permissions. Obviously, this functionality is operating system dependent and will fail in Windows in particular; it may also fail in other operating systems for a variety of reasons.

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_sym_link_name Property

The symbolic link name, for a file that represents a symbolic link.

Syntax

def get_file_sym_link_name(file_index: int) -> str: ...
def set_file_sym_link_name(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

The symbolic link name, for a file that represents a symbolic link. If you specify file_sym_link_name the file will be added to the tar file as a symbolic link. You should specify the name of the link in file_compressed_name and the name of the linked file in file_sym_link_name.

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.

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.

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()

tar_data Property

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

Syntax

def set_tar_data(value: bytes) -> None: ...

tar_data = property(None, set_tar_data)

Default Value

""

Remarks

Normally you should set archive_file before invoking scan or extract. If you prefer to read the tar file from memory you may set tar_data instead. tar_data should be set to the entire contents of the tar 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 tar file stored in tar_data is not supported, so append, delete, etc., will throw exceptions.

This property is write-only.

use_gzip_compression Property

Whether or not to use gzip compression.

Syntax

def get_use_gzip_compression() -> bool: ...
def set_use_gzip_compression(value: bool) -> None: ...

use_gzip_compression = property(get_use_gzip_compression, set_use_gzip_compression)

Default Value

FALSE

Remarks

If this property is set to true, the class will operate on tar archives that have been compressed with gzip. The interface of the component remains the same. During compression, the data will be streamed through a gzip compressor as it is written to the file. During decompression, the class will unzip the data to a temporary tar archive, and then automatically scan or decompress the tar archive.

The creation of the temporary tar file will occur when the scan method is invoked (note that this method is invoked automatically by extract and extract_all if it is not invoked explicitly by the user). The entire file must be decompressed, so scan might operate slowly, and the on_progress event will be fired as the tar file is extracted. If scan is invoked automatically by extract or extract_all, the PercentProcessed parameter of the event will increase from 0 to 100 as the archive is decompressed, and again as files are extracted from the temporary file.

The temporary file will automatically be deleted by the class after it is no longer needed. To extract the tar file itself (rather than its contents), the Gzip class should be used.

Due to the nature of the gzip format, append and delete are not supported for .tar.gz files.

If this property is set to false, the class will create and read ordinary, uncompressed tar archives.

NOTE: This is not supported when using an input stream for extraction.

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 Method

Adds a file to an existing archive.

Syntax

def append(decompressed_name: str, compressed_name: str) -> None: ...

Remarks

append may be used to add a file to an existing archive. Unlike include_files, append compresses and adds the file to the archive as soon as it is invoked.

DecompressedName should be set to the name of the single file to be added. It should be specified with a path if necessary, to allow the class to find it. The value of CompressedName is the name that will be stored in the archive.

When append 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 have been set for that file in the files collection, this information will be reset by the call to scan.

After the file is added, the array properties will be updated appropriately.

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

Due to the nature of the gzip format, append and delete are not supported for .tar.gz files.

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

on_begin_file Event

Fired before each file is processed.

Syntax

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

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

# In class Tar:
@property
def on_begin_file() -> Callable[[TarBeginFileEventParams], None]: ...
@on_begin_file.setter
def on_begin_file(event_hook: Callable[[TarBeginFileEventParams], 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 TarEndFileEventParams(object):
  @property
  def index() -> int: ...

# In class Tar:
@property
def on_end_file() -> Callable[[TarEndFileEventParams], None]: ...
@on_end_file.setter
def on_end_file(event_hook: Callable[[TarEndFileEventParams], 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 TarErrorEventParams(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 Tar:
@property
def on_error() -> Callable[[TarErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TarErrorEventParams], 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 TarOverwriteEventParams(object):
  @property
  def filename() -> str: ...
  @filename.setter
  def filename(value) -> None: ...

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

# In class Tar:
@property
def on_overwrite() -> Callable[[TarOverwriteEventParams], None]: ...
@on_overwrite.setter
def on_overwrite(event_hook: Callable[[TarOverwriteEventParams], 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_progress Event

Fired as progress is made.

Syntax

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

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

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

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

# In class Tar:
@property
def on_progress() -> Callable[[TarProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[TarProgressEventParams], 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.

Tar 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.

Tar Config Settings

Base Config Settings

Tar 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.

Tar Errors