How to Create a Tar File in Python Easily

You can create a tar file in Python using the tarfile module. Use tarfile.open() with mode 'w' to write a new tar archive, then add files with add() method.

Syntax

To create a tar file, open a tar archive in write mode and add files to it.

• tarfile.open(name, mode): Opens a tar file. Use mode 'w' to create a new tar archive.
• add(name, arcname=None): Adds a file or directory to the archive. name is the file path, arcname is the name inside the archive.
• close(): Closes the tar file to save changes.

python

import tarfile

tar = tarfile.open('archive.tar', 'w')
tar.add('file_or_folder_path')
tar.close()

Example

This example creates a tar file named example.tar and adds a file called sample.txt to it.

python

import tarfile

# Create a tar file named 'example.tar' in write mode
with tarfile.open('example.tar', 'w') as tar:
    # Add 'sample.txt' to the tar archive
    tar.add('sample.txt')

print('Tar file created successfully.')

Output

Tar file created successfully.

Common Pitfalls

1. Forgetting to close the tar file: Not closing the tar file can cause the archive to be incomplete or corrupted. Use with statement to handle this automatically.

2. Wrong mode: Using mode 'r' instead of 'w' will open the archive for reading, not writing.

3. Adding non-existing files: Trying to add files that do not exist will raise an error.

python

import tarfile

# Wrong way: forgetting to close
# tar = tarfile.open('bad.tar', 'w')
# tar.add('missing.txt')  # Error if file missing

# Right way: using with statement
with tarfile.open('good.tar', 'w') as tar:
    tar.add('existing_file.txt')

Quick Reference

Function	Description
tarfile.open(name, mode)	Open a tar archive; mode 'w' to write/create
add(name, arcname=None)	Add file or folder to archive
close()	Close the tar archive
with statement	Automatically open and close tar archive

Key Takeaways

Use the tarfile module with mode 'w' to create a tar archive.

Always close the tar file or use a with statement to avoid corruption.

Add files with the add() method specifying the file path.

Check that files exist before adding to avoid errors.

Use the quick reference table to remember main functions.