TarCompress - gws_core

Class to compress and uncompress tar file.

:return: description :rtype: type

Attributes

compress_option: strdestination_file_path: strtar_file: TarFile

Functions

__INIT__

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

Parameters:

Name	Type	Default value	Description
destination_file_path	`str`

ADD_DIR

Parameters:

Name	Type	Default value	Description
dir_path	`str`
dir_name	`str`

ADD_FILE

Parameters:

Name	Type	Default value	Description
file_path	`str`
file_name	`str`

ADD_FS_NODE

Parameters:

Name	Type	Default value	Description
fs_node_path	`str`
fs_node_name	`str`

Return type:

str

CAN_UNCOMPRESS_FILE - @classmethod

Return true if the file can be uncompressed by this class

Parameters:

Name	Type	Default value	Description
file_path	`str`

Return type:

bool

COMPRESS_DIR - @classmethod

Compress a folder into a tar.gz file.

Parameters:

Name	Type	Default value	Description
dir_path	`str`
destination_file_path	`str`		Path of the tar.gz file to create ``

DECOMPRESS - @classmethod

Uncompress a tar.gz file.

Parameters:

Name	Type	Default value	Description
file_path	`str`
destination_folder	`str`

GET_SUPPORTED_EXTENSIONS - @classmethod

Return the list of supported extensions

Return type:

set

GET_ALL_SUPPORTED_EXTENSIONS - @staticmethod

Return the list of all supported extensions without '.'

Return type:

Set

IS_COMPRESSED_FILE - @staticmethod

Check if the file is a compressed file.

Parameters:

Name	Type	Default value	Description
file_path	`str`

Return type:

bool

SMART_DECOMPRESS - @staticmethod

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

Parameters:

Name	Type	Default value	Description
file_path	`str`
destination_folder	`str`