manifest_file Property

The name of the manifest file.

Syntax

def get_manifest_file() -> str: ...
def set_manifest_file(value: str) -> None: ...

manifest_file = property(get_manifest_file, set_manifest_file)

Default Value

""

Remarks

This property specifies the location of the manifest to be written to the jar archive.

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. If the format is not native to the host operating system, the class will immediately attempt to convert it.

When compress is invoked, the location of the manifest is determined according to manifest_file and the file_compressed_name and file_decompressed_name fields of the files collection. The collection will be updated immediately prior to compression, and additional entries will be added at the beginning if necessary. If manifest_file is set to a nonempty string, its value will be written to the appropriate value of file_decompressed_name, overwriting any pre-existing value. If manifest_file is set to an empty string, and any value of the file_compressed_name field in the files collection has the value "META-INF/MANIFEST.MF", the corresponding value of file_decompressed_name will be used as the source of the manifest. If a source for the manifest is not specified, a default manifest will automatically be generated and added to the archive.

When scan is called (either by the user or by extract or extract_all), the location of the manifest will be determined, and the value of this property will be set to the corresponding value of the file_decompressed_name for that file. The value of manifest_file may then be changed to write the manifest to a different location.

After calling scan, "META-INF/MANIFEST.MF" may be passed as an argument to extract to extract the manifest.

If during compression the file cannot be read, a trappable error will be generated.