ArchiveWriter Class

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter class allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

class secureblackbox.ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Work with ArchiveWriter builds on the following steps:

Creating or opening the archive.

Use create_new to create a new archive, or one of the Open* methods (such as open or open_bytes) to open an existing compressed file.

Inspecting the archive contents

Use the files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' > and > properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• add_file - adds an entry with the contents of a local file.
• add_files - adds a set of files from a local directory.
• add_virtual - allocates an entry in the archive. The actual data can be provided later using on_prepare_file and on_before_compress_file events.

You can combine different entry types when building your archive.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using update_file and update_files methods. The remove method lets you delete individual files from the archive.

Use decryption_password property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the on_decryption_password_needed event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's save (or save_bytes) method to save the updated archive, and then close to close the archive file and release the associated memory.

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

The type of the archive.

Syntax

def get_archive_type() -> int: ...

archive_type = property(get_archive_type, None)

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

compression_algorithm Property

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

def get_compression_algorithm() -> int: ...
def set_compression_algorithm(value: int) -> None: ...

compression_algorithm = property(get_compression_algorithm, set_compression_algorithm)

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

compression_level Property

The compression level to apply to the archived data.

Syntax

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

compression_level = property(get_compression_level, set_compression_level)

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

decryption_cert_count Property

The number of records in the DecryptionCert arrays.

Syntax

def get_decryption_cert_count() -> int: ...
def set_decryption_cert_count(value: int) -> None: ...

decryption_cert_count = property(get_decryption_cert_count, set_decryption_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• decryption_cert_bytes
• decryption_cert_handle

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

decryption_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_decryption_cert_bytes(decryption_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The decryption_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the decryption_cert_count property.

This property is read-only.

decryption_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_decryption_cert_handle(decryption_cert_index: int) -> int: ...
def set_decryption_cert_handle(decryption_cert_index: int, value: int) -> None: ...

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The decryption_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the decryption_cert_count property.

decryption_password Property

The decryption password.

Syntax

def get_decryption_password() -> str: ...
def set_decryption_password(value: str) -> None: ...

decryption_password = property(get_decryption_password, set_decryption_password)

Default Value

""

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from on_decryption_password_needed event handler.

encryption_algorithm Property

Specifies the encryption algorithm to apply to the archive.

Syntax

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

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

""

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Class supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

encryption_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_encryption_cert_bytes() -> bytes: ...

encryption_cert_bytes = property(get_encryption_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

encryption_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_encryption_cert_handle() -> int: ...
def set_encryption_cert_handle(value: int) -> None: ...

encryption_cert_handle = property(get_encryption_cert_handle, set_encryption_cert_handle)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

encryption_key_length Property

The length of the encryption key.

Syntax

def get_encryption_key_length() -> int: ...
def set_encryption_key_length(value: int) -> None: ...

encryption_key_length = property(get_encryption_key_length, set_encryption_key_length)

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

encryption_password Property

Specifies the archive encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside encryption_type and encryption_algorithm properties to set up the whole set of protection settings for the archive.

encryption_type Property

The type of encryption to apply to the archive.

Syntax

def get_encryption_type() -> int: ...
def set_encryption_type(value: int) -> None: ...

encryption_type = property(get_encryption_type, set_encryption_type)

Default Value

0

Remarks

Specifies the encryption type for the archive.

file_data Property

The contents of the file being added to the archive.

Syntax

def get_file_data() -> bytes: ...
def set_file_data(value: bytes) -> None: ...

file_data = property(get_file_data, set_file_data)

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use file_stream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

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_action
• file_attributes
• file_compressed_size
• file_data_source
• file_directory
• file_encryption_algorithm
• file_encryption_key_length
• file_encryption_type
• file_file_name
• file_folder
• file_local_path
• file_m_time
• file_new_file
• file_path
• file_signature_count
• file_signed
• file_size

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

file_action Property

This property contains the action to apply to the file.

Syntax

def get_file_action(file_index: int) -> int: ...
def set_file_action(file_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property contains the action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:

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

This property provides access to file attributes.

Syntax

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

Default Value

""

Remarks

This property provides access to file attributes.

ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive.

Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows:

Writer.Files[0].Attributes = "unix:-rwxr-xr-x"; Writer.Files[1].Attributes = "unix:-r--r--r--"; Writer.Files[2].Attributes = "dos:readonly"; Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive

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

This property contains the size of the file after compression.

Syntax

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

Default Value

0

Remarks

This property contains the size of the file after 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.

This property is read-only.

file_data_source Property

This property contains the type of data source for this entry.

Syntax

def get_file_data_source(file_index: int) -> int: ...
def set_file_data_source(file_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property contains the type of data source for this entry.

Use this property to control the data source for this entry.

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

This property tells if the entry is a directory or a regular file.

Syntax

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

Default Value

FALSE

Remarks

This property tells if the entry is a directory or a regular file.

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

This property returns the symmetric algorithm that was used to encrypt the file.

Syntax

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

Default Value

""

Remarks

This property returns the symmetric algorithm that was used to encrypt the file.

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

This property returns the length, in bits, of the encryption key.

Syntax

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

Default Value

0

Remarks

This property returns the length, in bits, of the encryption key.

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

This property contains the type of encryption applied to the file.

Syntax

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

Default Value

0

Remarks

This property contains the type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.

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

This property specifies the original name of the compressed file or folder.

Syntax

def get_file_file_name(file_index: int) -> str: ...
def set_file_file_name(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property specifies the original name of the compressed file or folder.

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

This property includes the containing folder of the entry.

Syntax

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

Default Value

""

Remarks

This property includes the containing folder of the entry.

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

This property contains the local path associated with this entry.

Syntax

def get_file_local_path(file_index: int) -> str: ...
def set_file_local_path(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the local path associated with this entry.

It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

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

This property contains the entry's last modification time.

Syntax

def get_file_m_time(file_index: int) -> str: ...
def set_file_m_time(file_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the entry's last modification time.

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

This property indicates whether the entry corresponds to a file to be added to the archive.

Syntax

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

Default Value

FALSE

Remarks

This property indicates whether the entry corresponds to a file to be added to the archive.

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

This property contains the full internal path of the archived entry.

Syntax

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

Default Value

""

Remarks

This property contains the full internal path of the archived entry.

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

This property includes the number of signatures covering the entry.

Syntax

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

Default Value

0

Remarks

This property includes the number of signatures covering the entry.

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

This property indicates whether the entry is signed.

Syntax

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

Default Value

FALSE

Remarks

This property indicates whether the entry is signed.

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

This property specifies the size of the file before compression.

Syntax

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

Default Value

0

Remarks

This property specifies the size of the file before 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.

This property is read-only.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

hash_algorithm Property

Specifies the hash algorithm to be used to generate the signature.

Syntax

def get_hash_algorithm() -> str: ...
def set_hash_algorithm(value: str) -> None: ...

hash_algorithm = property(get_hash_algorithm, set_hash_algorithm)

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

new_archive Property

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

def get_new_archive() -> bool: ...

new_archive = property(get_new_archive, None)

Default Value

FALSE

Remarks

This property is set to true if the archive is new, or to false if the class control is editing an existing archive.

new_archive would typically be set to true after a create_new call, and to false after an open call.

This property is read-only.

opened Property

Indicates whether class is currently in edit mode.

Syntax

def get_opened() -> bool: ...

opened = property(get_opened, None)

Default Value

FALSE

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with open or created with create_new call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

overwrite Property

Whether the class should overwrite existing files.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

Enable this property to force overwriting of existing files.

signing_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_signing_cert_bytes() -> bytes: ...

signing_cert_bytes = property(get_signing_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

signing_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_signing_cert_handle() -> int: ...
def set_signing_cert_handle(value: int) -> None: ...

signing_cert_handle = property(get_signing_cert_handle, set_signing_cert_handle)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

signing_chain_count Property

The number of records in the SigningChain arrays.

Syntax

def get_signing_chain_count() -> int: ...
def set_signing_chain_count(value: int) -> None: ...

signing_chain_count = property(get_signing_chain_count, set_signing_chain_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

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

signing_chain_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_signing_chain_bytes(signing_chain_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.

This property is read-only.

signing_chain_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_signing_chain_handle(signing_chain_index: int) -> int: ...
def set_signing_chain_handle(signing_chain_index: int, value: int) -> None: ...

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.

add_empty_dir Method

Adds an empty folder to the archive.

Syntax

def add_empty_dir(path: str) -> int: ...

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the files collection.

add_file Method

Adds a file to the archive.

Syntax

def add_file(path: str, local_path: str) -> int: ...

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

add_files Method

Adds a group of files to the archive.

Syntax

def add_files(folder: str, local_path: str, recursive: bool) -> None: ...

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

add_virtual Method

Adds a file placeholder to the archive.

Syntax

def add_virtual(path: str) -> int: ...

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use on_prepare_file event or files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the on_before_compress_file event handler.

This method returns the index of the new entry in the files collection.

close Method

Closes the archive.

Syntax

def close() -> None: ...

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

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.

create_new Method

Creates a new archive.

Syntax

def create_new(archive_type: int) -> None: ...

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with save or save_stream method.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

open Method

Opens an archive file.

Syntax

def open(archive_type: int, archive_name: str) -> None: ...

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with save or save_stream method.

open_bytes Method

Loads an archive file from a byte array.

Syntax

def open_bytes(archive_type: int, archive_bytes: bytes) -> None: ...

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with save, save_stream, or save_bytes method.

remove Method

Removes file(s) and/or folder(s) from the archive.

Syntax

def remove(path: str) -> None: ...

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

save Method

Compresses the archive and saves it to a file.

Syntax

def save(archive_name: str) -> None: ...

Remarks

Use this method to finalize all preparations, compress all the entries set up in files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, on_prepare_file event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with on_before_compress_file and on_after_compress_file "brackets". Subscribe to on_before_compress_file to supply the file contents for entries with Buffer and Stream data sources. on_after_compress_file is a good place to release the content stream alloated in the on_before_compress_file event handler.

on_progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

save_bytes Method

Compresses the archive and saves it to a byte array.

Syntax

def save_bytes() -> bytes: ...

Remarks

Use this method to finalize all preparations and compress all entries contained in the files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events class fires. See the description of the save method for the details.

update_file Method

Updates an existing compressed entry with a fresher local version.

Syntax

def update_file(path: str, local_path: str) -> None: ...

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

update_files Method

Updates a selection of files in the archive.

Syntax

def update_files(folder: str, local_path: str, add_missing_files: bool, remove_missing_files: bool, recursive: bool) -> None: ...

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

update_virtual Method

Updates an entry in the archive with on-the-fly content.

Syntax

def update_virtual(path: str) -> None: ...

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to on_before_compress_file to supply the actual data via file_data or file_stream properties.

on_action_needed Event

Requests a decision from the application in case of a conflict.

Syntax

class ArchiveWriterActionNeededEventParams(object):
  @property
  def what_for() -> int: ...

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

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

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

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class ArchiveWriter:
@property
def on_action_needed() -> Callable[[ArchiveWriterActionNeededEventParams], None]: ...
@on_action_needed.setter
def on_action_needed(event_hook: Callable[[ArchiveWriterActionNeededEventParams], None]) -> None: ...

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

on_after_compress_file Event

Marks the completion of compression of a file.

Syntax

class ArchiveWriterAfterCompressFileEventParams(object):
  @property
  def path() -> str: ...

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

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

# In class ArchiveWriter:
@property
def on_after_compress_file() -> Callable[[ArchiveWriterAfterCompressFileEventParams], None]: ...
@on_after_compress_file.setter
def on_after_compress_file(event_hook: Callable[[ArchiveWriterAfterCompressFileEventParams], None]) -> None: ...

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

on_before_compress_file Event

Marks the start of compression of a file.

Syntax

class ArchiveWriterBeforeCompressFileEventParams(object):
  @property
  def path() -> str: ...

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

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

# In class ArchiveWriter:
@property
def on_before_compress_file() -> Callable[[ArchiveWriterBeforeCompressFileEventParams], None]: ...
@on_before_compress_file.setter
def on_before_compress_file(event_hook: Callable[[ArchiveWriterBeforeCompressFileEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

If passing the data from a stream or buffer, use on_after_compress_file to dispose of any objects allocated in this event handler (such as the source stream).

Use on_prepare_file event to adjust the file data source on the fly.

on_decryption_password_needed Event

Fires when the class needs a password to decrypt the archive.

Syntax

class ArchiveWriterDecryptionPasswordNeededEventParams(object):
  @property
  def password_target() -> str: ...

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

# In class ArchiveWriter:
@property
def on_decryption_password_needed() -> Callable[[ArchiveWriterDecryptionPasswordNeededEventParams], None]: ...
@on_decryption_password_needed.setter
def on_decryption_password_needed(event_hook: Callable[[ArchiveWriterDecryptionPasswordNeededEventParams], None]) -> None: ...

Remarks

Class fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to decryption_password property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

on_error Event

Reports information about errors during archive assembling.

Syntax

class ArchiveWriterErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

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

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

on_notification Event

This event notifies the application about an underlying control flow event.

Syntax

class ArchiveWriterNotificationEventParams(object):
  @property
  def event_id() -> str: ...

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

# In class ArchiveWriter:
@property
def on_notification() -> Callable[[ArchiveWriterNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[ArchiveWriterNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

on_prepare_file Event

Fires for every file to be compressed before the compression starts.

Syntax

class ArchiveWriterPrepareFileEventParams(object):
  @property
  def path() -> str: ...

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

  @property
  def data_source() -> int: ...
  @data_source.setter
  def data_source(value) -> None: ...

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

  @property
  def action() -> int: ...
  @action.setter
  def action(value) -> None: ...

# In class ArchiveWriter:
@property
def on_prepare_file() -> Callable[[ArchiveWriterPrepareFileEventParams], None]: ...
@on_prepare_file.setter
def on_prepare_file(event_hook: Callable[[ArchiveWriterPrepareFileEventParams], None]) -> None: ...

Remarks

Class fires this event for every file included in the files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

Please do not assign file_stream or file_data in this event handler: this should be done further down the road in the on_before_compress_file event handler. The purpose of this event is to prepare the compression plan by summarizing what should be done and to which files.

The Action parameter, which is also tuneable, indicates the action for class to take on the file:

on_progress Event

Reports the progress of data compression.

Syntax

class ArchiveWriterProgressEventParams(object):
  @property
  def processed() -> int: ...

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

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

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

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

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

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

on_recipient_found Event

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

class ArchiveWriterRecipientFoundEventParams(object):
  @property
  def public_key_hash() -> str: ...

  @property
  def cert_found() -> bool: ...

# In class ArchiveWriter:
@property
def on_recipient_found() -> Callable[[ArchiveWriterRecipientFoundEventParams], None]: ...
@on_recipient_found.setter
def on_recipient_found(event_hook: Callable[[ArchiveWriterRecipientFoundEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the decryption_certificates list. If it wasn't, you need to locate it on the system and add it to that list: class won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

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

ArchiveWriter Config Settings

Base Config Settings

ArchiveWriter Errors