Compression¶
The rite.filesystem.compress submodule provides helpers for gzip compressing and decompressing files.
Compression helpers for filesystem utilities.
Functions¶
compress_file(input_file: BinaryIO, filename: str) -> tuple[tempfile.SpooledTemporaryFile, str]
¶
Compress a file using gzip and return the compressed output.
input_file: File-like object to compress.
filename: Original filename (used as internal gzip metadata).
Tuple of (compressed file object, new filename with .gz extension).
uncompress_file(input_file: BinaryIO, filename: str) -> tuple[tempfile.SpooledTemporaryFile, str]
¶
Decompress a gzip file and return the uncompressed output.
input_file: Gzip-compressed file-like object.
filename: Original filename (used to derive uncompressed name).
Tuple of (decompressed file object, filename without .gz extension).
Modules¶
gzip_compress
¶
Gzip Compression Module¶
Provides gzip compression functionality for file objects.
Functions¶
compress_file(input_file: BinaryIO, filename: str) -> tuple[tempfile.SpooledTemporaryFile, str]
¶
Compress a file using gzip and return the compressed output.
input_file: File-like object to compress.
filename: Original filename (used as internal gzip metadata).
Tuple of (compressed file object, new filename with .gz extension).
gzip_settings
¶
GZIP Compression Settings Module¶
Provides configurable settings for GZIP compression operations.
Classes¶
GzipCompressionSettings
¶
Configuration settings for GZIP compression operations.
Attributes¶
TMP_FILE_MAX_SIZE : int Maximum size in bytes before spooling to disk (default: 5MB). TMP_FILE_READ_SIZE : int Chunk size in bytes for file I/O operations (default: 1MB). TMP_DIR : None | str Temporary directory path (None uses system default).
gzip_uncompress
¶
Gzip Decompression Module¶
Provides gzip decompression functionality for file objects.
Functions¶
uncompress_file(input_file: BinaryIO, filename: str) -> tuple[tempfile.SpooledTemporaryFile, str]
¶
Decompress a gzip file and return the uncompressed output.
input_file: Gzip-compressed file-like object.
filename: Original filename (used to derive uncompressed name).
Tuple of (decompressed file object, filename without .gz extension).
options: show_root_heading: true show_source: false heading_level: 2