Python shutil.make_archive() Function: Usage and Examples

This Python tutorial explains shutil.make_archive() Function: Usage and Examples. Follow the example, inspect the output, and practise an input change so you understand the behavior rather than simply copying the syntax.

What This Feature Does

Create an archive from a directory using shutil.make_archive().

shutil.make_archive(base_name, format, root_dir=...) builds ZIP or other supported archives. The format parameter controls archive type; base_name normally omits the extension. The result is the archive pathname.

When to Use It

This technique belongs to file copying, temporary files and matching. It is useful when the input, operation and expected outcome are known. Start with a small controlled example before integrating it into a larger workflow.

Step-by-Step Python Example

Read the code once before running it. Notice which values are inputs, which function or method performs the work, and whether the result is returned or stored by changing an existing object.

from pathlib import Path
from tempfile import TemporaryDirectory
import shutil

with TemporaryDirectory() as temporary_folder:
    root_folder = Path(temporary_folder)
    source_folder = root_folder / "reports"
    source_folder.mkdir()
    (source_folder / "summary.txt").write_text("ready", encoding="utf-8")
    archive_path = shutil.make_archive(str(root_folder / "backup"), "zip", root_dir=source_folder)
    print(Path(archive_path).suffix)

Understanding the Code

First, the imports make pathlib, tempfile, shutil available. They provide the filesystem, data or standard-library functions used later.
Find the call shutil.make_archive(str(root_folder / "backup"), "zip", root_dir=source_folder). Its parameters determine the specific operation demonstrated in the title.
Its purpose is to create an archive from a directory using shutil.make_archive(). Compare this description against the result printed by the program.
The sample uses TemporaryDirectory() so any practice files are removed after the context ends; it does not work on your real documents.
The print() expressions display a checkable outcome. Print values and exception names are not substitutes for the program result itself.

Expected Output

.zip

The output is the observable result of the sample operation. Compare its value and type with the explanation, not just whether the program runs.

Important Details and Edge Cases

Use zipfile when fine-grained control over archive entries is required.

Before applying this to real documents, check whether the method reads data, creates a new file, moves it, or overwrites an existing file. Work in a disposable test directory first and handle OSError-related failures in applications.

Practice: Try It Yourself

Create a ZIP file from two small example files.

Begin by copying the example into a separate practice file. Change one input at a time, run it again, and describe why the result changed. If the exercise writes or deletes files, keep it inside a temporary test folder.

Official Python Documentation

For the complete reference, see the Python standard library documentation.

Common Beginner Mistakes

Providing a base_name with an archive extension and creating a doubled suffix.
Archiving sensitive files without reviewing the directory contents first.
Before applying this to real documents, check whether the method reads data, creates a new file, moves it, or overwrites an existing file. Work in a disposable test directory first and handle OSError-related failures in applications.

Key Takeaways

Create an archive from a directory using shutil.make_archive().
shutil.make_archive(base_name, format, root_dir=...) builds ZIP or other supported archives. The format parameter controls archive type; base_name normally omits the extension. The result is the archive pathname.
Avoid this common pitfall: Providing a base_name with an archive extension and creating a doubled suffix.