Skip to content
CodeMDD.io | Coding Tutorials

Effortlessly Unpacking ZIP Files in Python

[

Python’s zipfile: Manipulate Your ZIP Files Efficiently

Python’s zipfile module is a powerful tool for working with ZIP files. Whether you need to read, write, extract, or manipulate files within a ZIP archive, zipfile provides all the functionality you need. In this tutorial, you will learn how to perform various operations on ZIP files using Python’s zipfile module.

Getting Started With ZIP Files

What Is a ZIP File?

A ZIP file is a widely adopted industry standard for archiving and compressing digital data. It allows you to package multiple files together into a single file, reducing file size and saving disk space. ZIP files are commonly used for data exchange over computer networks.

Why Use ZIP Files?

There are several benefits to using ZIP files:

  • Compression: ZIP files use compression algorithms to reduce the file size of archived files. This can be especially useful when sending or storing large files.

  • Organization: By grouping related files together in a ZIP archive, you can keep your files organized and easily share or transfer them as a single entity.

  • Data Integrity: ZIP files include checksums to ensure the integrity of the archived files. This means that you can verify the integrity of your files after extracting them from a ZIP archive.

  • Cross-Platform Compatibility: ZIP files can be created and extracted on different operating systems, making them a universal format for exchanging files between different platforms.

Can Python Manipulate ZIP Files?

Yes, Python provides the zipfile module, which allows you to easily create, read, write, extract, and manipulate ZIP files. The zipfile module is part of the standard library, so you don’t need to install any additional packages to use it.

Manipulating Existing ZIP Files With Python’s zipfile

Opening ZIP Files for Reading and Writing

To start working with a ZIP file, you first need to open it. You can open a ZIP file for reading or writing using the ZipFile class from the zipfile module.

Here is an example of how to open a ZIP file for reading:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    # Perform operations on the ZIP file
    # ...

And here is an example of how to open a ZIP file for writing:

import zipfile


with zipfile.ZipFile('archive.zip', 'w') as zip_file:
    # Perform operations on the ZIP file
    # ...

Reading Metadata From ZIP Files

You can extract metadata about a ZIP file without actually extracting its contents. The ZipFile class provides methods for retrieving information such as the list of files in the archive, the size of the archive, and the date and time when the archive was created.

Here is an example of how to retrieve the list of files in a ZIP archive:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    file_list = zip_file.namelist()
    print(file_list)

Reading From and Writing to Member Files

Each file in a ZIP archive is called a “member file”. You can read the contents of a member file or write new content to it using the open() method of the ZipFile object.

Here is an example of how to read the contents of a member file as text:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    with zip_file.open('file.txt', 'r') as file:
        content = file.read().decode('utf-8')
        print(content)

And here is an example of how to write new content to a member file:

import zipfile


with zipfile.ZipFile('archive.zip', 'a') as zip_file:
    with zip_file.open('new_file.txt', 'w') as file:
        content = 'This is a new file.'
        file.write(content.encode('utf-8'))

Extracting Member Files From Your ZIP Archives

To extract member files from a ZIP archive, you can use the extractall() method of the ZipFile object. This method extracts all the files in the archive into a specified directory.

Here is an example of how to extract all files from a ZIP archive:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    zip_file.extractall('destination_folder')

Closing ZIP Files After Use

After you finish working with a ZIP file, it is important to close it to release any system resources associated with it. The ZipFile object can be used as a context manager, which ensures that the file is automatically closed when the with block is exited.

Here is an example of how to properly close a ZIP file:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    # Perform operations on the ZIP file


# The ZIP file is automatically closed after exiting the `with` block

Creating, Populating, and Extracting Your Own ZIP Files

Creating a ZIP File From Multiple Regular Files

You can create a new ZIP file and add multiple regular files to it using the write() method of the ZipFile object.

Here is an example of how to create a new ZIP file and add multiple files to it:

import zipfile


with zipfile.ZipFile('new_archive.zip', 'w') as zip_file:
    zip_file.write('file1.txt')
    zip_file.write('file2.txt')
    zip_file.write('file3.txt')

Building a ZIP File From a Directory

If you have a directory with multiple files and subdirectories, you can create a ZIP file that includes all the files and subdirectories using the write() method with the arcname parameter.

Here is an example of how to create a new ZIP file from a directory:

import zipfile
import os


source_directory = 'source_dir'
destination_zip = 'new_archive.zip'


with zipfile.ZipFile(destination_zip, 'w') as zip_file:
    for root, dirs, files in os.walk(source_directory):
        for file in files:
            file_path = os.path.join(root, file)
            zip_file.write(file_path, arcname=os.path.relpath(file_path, start=source_directory))

Compressing Files and Directories

By default, the write() method compresses the files and directories you add to a ZIP archive. If you want to disable compression for specific files or directories, you can pass the ZIP_STORED constant as the compression parameter.

Here is an example of how to add a file to a ZIP archive without compressing it:

import zipfile


with zipfile.ZipFile('archive.zip', 'w') as zip_file:
    zip_file.write('file.txt', compress_type=zipfile.ZIP_STORED)

Creating ZIP Files Sequentially

You can create a ZIP archive incrementally by opening it with the 'a' mode, then adding files to it using the write() method.

Here is an example of how to create a ZIP file sequentially:

import zipfile


with zipfile.ZipFile('archive.zip', 'a') as zip_file:
    zip_file.write('file1.txt')
    zip_file.write('file2.txt')
    zip_file.write('file3.txt')

Extracting Files and Directories

To extract specific files or directories from a ZIP archive, you can use the extract() method of the ZipFile object.

Here is an example of how to extract a specific file from a ZIP archive:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    zip_file.extract('file.txt', path='destination_folder')

Exploring Additional Classes From zipfile

The zipfile module provides additional classes that allow you to perform advanced operations on ZIP files.

Finding Path in a ZIP File

The Path class from the zipfile module allows you to navigate through the file structure of a ZIP archive as if it were a normal file system.

Here is an example of how to find a specific file in a ZIP archive:

import zipfile


with zipfile.ZipFile('archive.zip', 'r') as zip_file:
    path = zipfile.Path(zip_file, 'path/to/file.txt')
    print(path.read_text())

Building Importable ZIP Files With PyZipFile

The PyZipFile class from the zipfile module allows you to create importable ZIP files that can be used as libraries in Python projects.

Here is an example of how to create an importable ZIP file:

import zipfile


with zipfile.PyZipFile('library.zip', 'w') as zip_file:
    zip_file.writepy('package_name')

Running zipfile From Your Command Line

You can run the zipfile module directly from the command line by using the -m flag followed by the name of the zipfile module.

Here is an example of how to run the zipfile module from the command line:

Terminal window
python -m zipfile -c archive.zip file1.txt file2.txt

Using Other Libraries to Manage ZIP Files

Although Python’s zipfile module provides a comprehensive set of tools for working with ZIP files, there are also other third-party libraries that offer additional functionality and convenience. Some popular alternatives to zipfile include zipfile36 and pyminizip.

Conclusion

Python’s zipfile module is a powerful tool for working with ZIP files. Whether you need to read, write, extract, or manipulate files within a ZIP archive, zipfile provides all the necessary functionality. In this tutorial, you learned the basics of working with ZIP files using Python’s zipfile module. You also saw how to perform various operations such as opening, reading metadata, writing, extracting, and creating ZIP files. With this knowledge, you can confidently handle ZIP files and streamline your file processing workflows.