Скачать или смотреть The Correct Way to Use zipfile in Python to Archive Each File

Discover the best practices for using Python's zipfile module to create separate archives for your files while avoiding full path storage.
---
This video is based on the question https://stackoverflow.com/q/65394528/ asked by the user 'LaoDa581' ( https://stackoverflow.com/u/11199199/ ) and on the answer https://stackoverflow.com/a/65395230/ provided by the user '001' ( https://stackoverflow.com/u/669576/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: What is correct way to use zipfile to archive each file?

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
The Correct Way to Use zipfile in Python to Archive Each File

If you are looking to archive multiple files into separate ZIP files using Python, you may encounter a common issue: each ZIP file unintentionally includes the full path of the original files. This can clutter your archives and detract from their usefulness. In this guide, we will walk through the correct way to use the zipfile module to create individual ZIP files for each of your files without including unwanted path information.

Understanding the Problem

You might have a directory filled with files that you'd like to encapsulate in ZIP files. For example, take a look at this directory structure:

[[See Video to Reveal this Text or Code Snippet]]

After implementing a simple script to zip the files, you notice that when you open file_1.zip, it contains not just file_1.py but also the complete path C:\Users\User\Downloads\file_1.py. This is not ideal if your goal is to keep the archives simple and file-related only.

Solution: Using zipfile Correctly

To achieve the desired outcome, you'll need to customize how files are written into your ZIP archives. Below, we break down the solution into clear steps.

Step 1: Utilize the write Method

The write method of the ZipFile class allows you to specify what name the file should have inside the zip. By providing just the file name as the second argument, you can discard the full path.

Step 2: Use os.walk()

To ensure that you catch files in nested directories efficiently, making use of os.walk() is a game changer. This function allows for recursive directory traversal, so you don't have to hard-code paths.

Here’s the Correct Code Implementation

[[See Video to Reveal this Text or Code Snippet]]

Explanation of the Code:

Import Required Libraries:

os for interacting with the operating system and file paths.

zipfile for creating and managing ZIP files.

Define the archive Function:

This function accepts a folder parameter that refers to the target directory.

Loop Through Files:

os.walk(folder) traverses all directories and subdirectories.

For each file, it constructs the full path and the target zip file path.

Create and Write to the ZIP File:

The write method takes two arguments:

The full path of the file to archive.

The desired name inside the ZIP (just the file name, not the full path).

Optional Deletion of Original Files:

The line os.remove(full_path) is included to remove the original file after archiving. You may choose to comment this out if you wish to keep the original files.

Conclusion

By using the zipfile module in conjunction with os.walk(), you can ensure that each of your files is archived separately without unnecessary path information cluttering up your ZIP files. Follow the example code in this post for a streamlined approach to file archiving in Python. Happy coding!