bz2.
How It Works
bz2.open() provides streaming read and write support for bzip2-compressed files. Choose binary or text mode explicitly and recognize that decompression can consume significant memory or CPU for untrusted input.
Step-by-Step Example
import bz2
import tempfile
from pathlib import Path
with tempfile.TemporaryDirectory() as temporary_directory:
compressed_path = Path(temporary_directory) / 'notes.bz2'
with bz2.open(compressed_path, 'wt', encoding='utf-8') as destination:
destination.write('Monthly totals')
with bz2.open(compressed_path, 'rt', encoding='utf-8') as source:
print(source.read())
Understanding the Example
- The with block manages the opened resource and closes it when the block finishes, including when an exception occurs.
- The expression "Path(temporary_directory) / 'notes.bz2'" supplies the value stored as 'compressed_path'. This value is then used or checked by the later statements.
A successful run of this example prints the following output:
Monthly totals
Where This Fits in a Real Program
A practical archive workflow has separate decisions for selection, compression, extraction and verification. When files come from other people, inspect paths, member counts and uncompressed sizes before writing anything; a successful decompression does not establish that its contents are trustworthy.
Practice: Try It Yourself
Compress a text file with bz2 and check the round-trip content.
For this exercise, predict the result before running the changed code. Then explain the difference between the original and modified cases using the actual values, not just whether the program completed.
Further Reading
Read the official Python documentation for complete parameters, return types and exceptions.
Common Beginner Mistakes
- Passing plain text into binary mode or confusing bzip2 streams with multi-file archives.
- Do not mistake successful decoding or parsing for trust in the contents.
Key Takeaways
- bz2.
- bz2.open() provides streaming read and write support for bzip2-compressed files.
- Apply the demonstrated operation to the practice input and verify its result before depending on it in a larger program.