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.unpack_archive() method in Python is used to unpack an archive file.
Syntax: shutil.unpack_archive(filename [, extract_dir [, format]])
Parameter:
filename: A path-like object representing the full path of archived file. A path-like object is either a string or bytes object representing a path.
extract_dir (optional): A path-like object representing the path of the target directory where the archive is unpacked. A path-like object is either a string or bytes object representing a path. This is an optional parameter and if not provided the current working directory is used as target directory.
formats (optional): A string representing an archive format. The value of format can be any one of “zip”, “tar”, “gztar”, “bztar”, or “xztar” or any other registered unpacking format. This is also an optional parameter and if not provided, the extension of archived file name is used as format. An unpacker must be registered for this extension otherwise ‘ValueError’ exception will be raised.
Return Type: This method does not return any value.
Code #1: Use of shutil.unpack_archive() method to unpack an archive file
Python3
# Python program to explain shutil.unpack_archive() method # importing shutil module import shutil# Full path of # the archive filefilename = "/home/User/Downloads/file.zip"# Target directoryextract_dir = "/home/ihritik/Documents"# Format of archive filearchive_format = "zip"# Unpack the archive file shutil.unpack_archive(filename, extract_dir, archive_format) print("Archive file unpacked successfully.") |
Archive file unpacked successfully.
Code #2: Use of shutil.unpack_archive() method to unpack an archive file
Python3
# Python program to explain shutil.unpack_archive() method # importing shutil module import shutil# Full path of # the archive filefilename = "/home/User/Downloads/file.zip"# Unpack the archived file shutil.unpack_archive(filename) print("Archive file unpacked successfully.")# As extract_dir and format parameters# are not provided So,# shutil.unpack_archive() method will# unpack the archive file in # current working directory and extension# of the archive filename i.e zip# will be taken as format to unpack |
Archive file unpacked successfully.
