Python | shutil.get_unpack_formats() method

Shutil module in Python provides many functions of high-level operations on files and collections of files. It comes under Python’s standard utility modules. This module helps in automating process of copying and removal of files and directories.

shutil.get_unpack_formats() method in Python is used to get the list of all supported formats available for unpacking archived files.
Following formats are available by default for unpacking archived files:

• zip: ZIP file. If the zlib module is available
• tar: uncompressed tar file.
• gztar: gzip’ed tar-file. If the zlib module is available
• bztar: bzip2’ed tar-file. If the bz2 module is available
• xztar: xz’ed tar-file. If the lzma module is available

We can also register new formats or specify own function for unpacking existing formats using shutil.register_unpack_format() method or deregister a existing format using shutil.unregister_unpack_format() method.

Syntax: shutil.get_unpack_formats()

Parameter: No parameter is required

Return Type: This method returns a list which represents the available formats supported for unpacking archived files. Each element of the list is a tuple (name, extension description).

Code: Use of shutil.get_unpack_formats() method

# Python program to explain shutil.get_unpack_formats() method

# importing shutil module
import shutil

# Get the list of
# supported unpacking formats
formats = shutil.get_unpack_formats()


# Print the list
print("Supported unpacking formats:\n", formats)

Output:

Supported unpacking formats:
Supported unpacking formats:
 [('bztar', ['.tar.bz2', '.tbz2'], "bzip2'ed tar-file"), ('gztar', ['.tar.gz', '.tgz'], "gzip'ed tar-file"), ('tar', ['.tar'], 'uncompressed tar file'), ('xztar', ['.tar.xz', '.txz'], "xz'ed tar-file"), ('zip', ['.zip'], 'ZIP file')]

Reference: https://docs.python.org/3/library/shutil.html

My Personal Notes arrow_drop_up

Save