TarCompress

Class to compress and uncompress tar file using system tar via subprocess.

Entries are staged as symlinks in a temp directory so that arcnames can be customized without copying data, then archived in a single tar invocation.

Attributes

compress_option: strdestination_file_path: strsupports_multiple_entries: booltar_create_flags: listtar_extract_flags: list

Functions

__init__

Initialize self. See help(type(self)) for accurate signature.

destination_file_path : str

add_dir

dir_path : str

dir_name : str | None

add_file

file_path : str

file_name : str | None

add_fs_node

fs_node_path : str

fs_node_name : str | None

Return type : str

can_uncompress_file @classmethod

Return true if the file can be uncompressed by this class

file_path : str

Return type : bool

compress_dir @classmethod

Compress a folder into a tar.gz file.

dir_path : str

destination_file_path : str

Path of the tar.gz file to create

compress_dir_content @classmethod

Compress the content of a folder without creating a subfolder hierarchy. Files and folders inside dir_path will be at the root of the compressed file.

dir_path : str

Path of the folder whose content to compress

destination_file_path : str

Path of the compressed file to create

decompress @classmethod

Uncompress a tar archive into destination_folder.

file_path : str

destination_folder : str

get_names @classmethod

Return the list of entry names inside the tar archive.

file_path : str

Return type : list

get_supported_extensions @classmethod

Return the list of supported extensions

Return type : set

is_tar_file @classmethod

Return true if the file is a valid tar archive readable by system tar.

file_path : str

Return type : bool

get_all_supported_extensions @staticmethod

Return the list of all supported extensions without '.'

Return type : set

get_compress_class_by_extension @staticmethod

Return a mapping of supported extension (without leading dot) to its Compress class. Built dynamically from child classes so new compressors are picked up automatically.

multi_entry_only : bool - False

Return type : dict

is_compressed_file @staticmethod

Check if the file is a compressed file.

file_path : str

Return type : bool

sanitize_arcname @staticmethod

Validate and normalize an archive entry name to a safe relative path.

Rejects empty names, absolute paths, and any segment that would escape the archive root via ... Returned value is suitable for joining with a staging directory.

arcname : str

Return type : str

smart_decompress @staticmethod

Detect the extension of the compressed file and use the right decompress method.

file_path : str

destination_folder : str

Have you developed a brick?