Python | shutil.unpack_archive() 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.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

filter_none

edit
close

play_arrow

link
brightness_4
code

# Python program to explain shutil.unpack_archive() method 
   
# importing shutil module 
import shutil
  
# Full path of 
# the archive file
filename = "/home/User/Downloads/file.zip"
  
# Target directory
extract_dir = "/home/ihritik/Documnets"
  
# Format of archie file
archive_format = "zip"
  
# Unpack the archive file 
shutil.unpack_archive(filename, extract_dir, archive_format) 
print("Archive file unpacked successfully.")

chevron_right


Output:

Archive file unpacked successfully.

Code #2: Use of shutil.unpack_archive() method to unpack an archive file

filter_none

edit
close

play_arrow

link
brightness_4
code

# Python program to explain shutil.unpack_archive() method 
   
# importing shutil module 
import shutil
  
# Full path of 
# the archive file
filename = "/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
    

chevron_right


Output:

Archive file unpacked successfully.


My Personal Notes arrow_drop_up

self motivated and passionate programmer

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.


Article Tags :

Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.