How to Extract RAR Files in Python Using Patool

This guide demonstrates how to use the patool Python library as a wrapper for the unrar command-line utility to extract RAR archives. You will learn about the required system dependencies, how to install the Python package, and how to execute core archive operations like extraction and listing archive contents directly within your code.

1. System Requirements

patool acts as a portable archive manager that interfaces with external command-line tools installed on your operating system. To process RAR files, an external tool like unrar must be installed and accessible in your system's PATH.

  • Debian / Ubuntu: 
    sudo apt-get install unrar
  • macOS (via Homebrew): 
    brew install carlocab/personal/unrar
  • Windows: Download the UnRAR utility from the official WinRAR website and add the folder containing unrar.exe to your Windows System PATH environment variable.

2. Installing patool

Install patool inside your Python environment using pip:

pip install patool

3. Extracting RAR Archives

Once unrar and patool are installed, import patoolib in your Python script. Use the extract_archive function to unpack your RAR files.

import patoolib

# Path to the RAR archive
archive_path = "data.rar"

# Destination directory
output_directory = "./extracted_files"

# Extract archive using the available RAR utility
patoolib.extract_archive(archive_path, outdir=output_directory)

By default, patool searches the system for an appropriate helper program (such as unrar) and executes the extraction command silently or with standard output depending on your configuration.

4. Listing Archive Contents

You can inspect the contents of a RAR file without writing files to disk using the list_archive method:

import patoolib

patoolib.list_archive("data.rar")

5. Error Handling and Configuration

Handle potential extraction issues, such as missing files or corrupted archives, by catching PatoolError:

import patoolib
from patoolib.util import PatoolError

try:
    patoolib.extract_archive("data.rar", outdir="./output", interactive=False)
except PatoolError as e:
    print(f"Extraction failed: {e}")

Setting interactive=False ensures that the script runs headlessly and does not pause for user confirmation in command-line environments if a file collision occurs.