13.3. bz2 – Поддержка сжатия bzip2¶bz2 – Support for bzip2 compression

Открывает сжатый bzip2 файл в бинарном режиме.

Если filename – объект str или bytes, открыть указанный файл напрямую. В противном случае filename должен быть файловым объектом, который будет использоваться для чтения или записи сжатых данных.

Аргумент mode может быть 'r' для чтения (по умолчанию), 'w' для перезаписи, 'x' для исключительного создания или 'a' для добавления. Им эквивалентно соответствуют 'rb', 'wb', 'xb' и 'ab' соответственно.

Если filename – файловый объект (а не фактическое имя файла), режим 'w' не усекает файл, а вместо этого эквивалентен 'a'.

Аргумент buffering игнорируется. Его использование устарело.

Если mode равен 'w' или 'a', то compresslevel может быть числом между 1 и 9, задающим степень сжатия: 1 дает наименьшее сжатие, а 9 (по умолчанию) – наибольшее.

Если mode – 'r', входной файл может быть объединением нескольких сжатых потоков.

BZ2File предоставляет все члены, определённые в io.BufferedIOBase, за исключением detach() и truncate(). Поддерживаются итерация и оператор with.

BZ2File также предоставляет следующий метод:

peek([n])¶

Возвращает буферизованные данные без продвижения файловой позиции. Будет возвращён как минимум один байт данных (если не достигнут конец файла). Точное количество возвращаемых байт не указано.

Примечание

Хотя вызов peek() не меняет файловую позицию BZ2File, он может изменить позицию нижележащего файлового объекта (например, если BZ2File был создан путём передачи файлового объекта в качестве filename).

Новое в версии 3.3.

Создаёт новый объект компрессора. Этот объект можно использовать для инкрементального сжатия данных. Для однократного сжатия используйте функцию compress().

compresslevel, если указан, должен быть числом от 1 до 9. По умолчанию 9.

compress(data)¶

Передаёт данные объекту компрессора. Возвращает сжатый фрагмент данных, если возможно, или пустую байтовую строку в противном случае.

После завершения передачи данных компрессору следует вызвать метод flush() для завершения процесса сжатия.

flush()¶

Завершает процесс сжатия. Возвращает сжатые данные, оставшиеся во внутренних буферах.

Объект компрессора нельзя использовать после вызова этого метода.

Создаёт новый объект декомпрессора. Этот объект можно использовать для инкрементальной декомпрессии данных. Для одноразового сжатия используйте функцию decompress() вместо этого.

decompress(data, max_length=-1)¶

Декомпрессирует data (байтоподобный объект), возвращая несжатые данные в виде байтов. Часть data может буферизироваться внутренне для использования в последующих вызовах decompress(). Возвращаемые данные следует объединять с результатом любых предыдущих вызовов decompress().

Если max_length неотрицательно, возвращает не более max_length байтов декомпрессированных данных. Если этот лимит достигнут и может быть сгенерирован дальнейший вывод, атрибут needs_input будет установлен в False. В этом случае следующий вызов decompress() может передать data как b'' для получения ещё вывода.

Если все входные данные были декомпрессированы и возвращены (либо потому что это было меньше max_length байтов, либо потому что max_length было отрицательным), атрибут needs_input будет установлен в True.

Попытка распаковать данные после достижения конца потока вызывает исключение EOFError. Любые данные, обнаруженные после конца потока, игнорируются и сохраняются в атрибуте unused_data.

Изменено в версии 3.5: Добавлен параметр max_length.

eof¶

True, если достигнут маркер конца потока.

Новое в версии 3.3.

unused_data¶

Данные, обнаруженные после конца сжатого потока.

Если к этому атрибуту обратиться до достижения конца потока, его значение будет b''.

needs_input¶

False, если метод decompress() может предоставить больше декомпрессированных данных до запроса нового несжатого входа.

Новое в версии 3.5.