pycdlib

1.14.0 · active · verified Thu Apr 09

PyCdlib is a pure Python library designed to parse, create, and manipulate ISO9660 files, suitable for writing to a CD or USB. It supports various extensions including El Torito, Joliet, Rock Ridge, and UDF. The current stable version available on PyPI is 1.14.0, and it maintains a relatively active development and release cadence.

Warnings

breaking Python 2.7 compatibility has been removed. PyCdlib versions 1.14.0 and later are strictly Python 3 compatible.
Fix: Ensure your project runs on Python 3.x.
gotcha PyCdlib employs a 'lazy' approach to updating ISO metadata for performance. This means that direct inspection of the `PyCdlib` object's internal metadata state might not always reflect the absolute latest changes until `force_consistency()` is explicitly called.
Fix: Call `iso.force_consistency()` if you need to ensure all internal metadata is up-to-date before inspection or complex operations.
gotcha The library may throw `PyCdlibInvalidISO` or `PyCdlibInternalError` exceptions when encountering ISO files that do not strictly adhere to relevant standards.
Fix: For problematic non-standard ISOs, consider reporting an issue to the project's GitHub, ideally with a link to the ISO for analysis.
gotcha Version 1.15.0 has been released on GitHub but is not yet available on PyPI (as of current date). Users wishing to access the absolute latest features or fixes must install directly from the GitHub repository rather than via `pip install pycdlib`.
Fix: Install from GitHub if 1.15.0+ features are required: `pip install git+https://github.com/clalancette/pycdlib.git`

Install

pip install pycdlib Install stable version from PyPI

Imports

PyCdlib
```
from pycdlib import PyCdlib
```

Quickstart

This quickstart demonstrates how to create a new ISO image, add a directory and a file to it, and then write the ISO to a local file. It includes support for Joliet and Rock Ridge extensions during creation and file addition.

from pycdlib import PyCdlib
from io import BytesIO
import os

# Create a new, empty ISO
iso = PyCdlib()
iso.new(interchange_level=3, joliet=True, rock_ridge='1.09')

# Add a directory
iso.add_directory('/TESTDIR;1')

# Add a file from a BytesIO object
file_content = b"Hello, pycdlib!\n"
iso.add_fp(BytesIO(file_content), len(file_content), '/TESTFILE.TXT;1',
           joliet_path='/testfile.txt', rock_ridge_path='testfile.txt')

# Define output path (using a temporary file for quickstart example)
output_path = 'my_new_iso.iso'

# Write the ISO to a file
try:
    iso.write(output_path)
    print(f"Successfully created ISO image: {output_path}")
except Exception as e:
    print(f"Error creating ISO: {e}")
finally:
    iso.close()
    # Clean up the created file for the quickstart example
    if os.path.exists(output_path):
        # os.remove(output_path) # Uncomment to clean up automatically
        pass

view raw JSON →