file_decompressed_name Property

File name to decompress to, or compress from.

Syntax

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

file_decompressed_name = property(get_file_decompressed_name, set_file_decompressed_name)

Default Value

""

Remarks

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

When compressing a file, 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 when compress is called, a trappable error will be generated, and the archive will not be correctly written.

When decompressing files, this property may be set prior to calling extract. If this property is set to the empty string when extract is called, extract will automatically set this property to an appropriate value.

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.