Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 32 additions & 10 deletions extras/fileformats/extras/application/archive.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,24 @@
},
)

ZIP_COMPRESSION_TYPES = {
"ZIP_STORED": zipfile.ZIP_STORED,
"ZIP_DEFLATED": zipfile.ZIP_DEFLATED,
"ZIP_BZIP2": zipfile.ZIP_BZIP2,
"ZIP_LZMA": zipfile.ZIP_LZMA,
}

ZIP_COMPRESSION_ANNOT = (
int,
{
"help": (
"help_string": (
"The type of compression applied to zip file, "
"', '".join(ZIP_COMPRESSION_TYPES.keys()) + ", "
"see https://docs.python.org/3/library/zipfile.html#zipfile.ZIP_DEFLATED "
"for valid compression types"
"for all valid compression types"
),
"allowed_values": [
zipfile.ZIP_STORED,
zipfile.ZIP_DEFLATED,
zipfile.ZIP_BZIP2,
zipfile.ZIP_LZMA,
],
"allowed_values": ZIP_COMPRESSION_TYPES,

},
)

Expand Down Expand Up @@ -146,12 +150,16 @@ def create_zip(
in_file: FsObject,
out_file: ty.Optional[Path] = None,
base_dir: ty.Optional[Path] = None,
compression: int = zipfile.ZIP_DEFLATED,
compression: ty.Union[int, str] = zipfile.ZIP_DEFLATED,
allowZip64: bool = True,
compresslevel: ty.Optional[int] = None,
compresslevel: ty.Optional[ty.Union[int, str]] = None,
strict_timestamps: bool = True,
) -> Zip:

compression = parse_zip_compression(compression)
if isinstance(compresslevel, str):
compresslevel = int(compresslevel)

if len(in_file.fspaths) > 1:
raise NotImplementedError(
"Can only archive file-sets with single paths currently"
Expand Down Expand Up @@ -189,6 +197,20 @@ def create_zip(
return Zip(out_file)


def parse_zip_compression(compression: ty.Union[int, str]) -> int:
"""Resolve a zipfile compression value from either an int constant
(e.g. zipfile.ZIP_STORED) or its name as a string (e.g. "ZIP_STORED")."""
if isinstance(compression, str):
try:
return ZIP_COMPRESSION_TYPES[compression.upper()]
except KeyError:
raise ValueError(
f"Unrecognised zip compression type {compression!r}, "
f"must be one of {list(ZIP_COMPRESSION_TYPES)}"
) from None
return compression


@converter(source_format=Zip, target_format=FsObject) # type: ignore[untyped-decorator]
@converter(source_format=Zip[Compressed], target_format=Compressed) # type: ignore[untyped-decorator,misc]
@python.define(outputs={"out_file": Path}) # type: ignore[untyped-decorator]
Expand Down
Loading