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.