`bz2.md`

290 строк · 21.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.14/library/bz2.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `bz2` – Поддержка сжатия **bzip2**89**Исходный код:** [Lib/bz2.py](https://python-all.ru/src/3.14/Lib/bz2.py)1011---1213Этот модуль предоставляет полный интерфейс для сжатия и распаковки данных с использованием алгоритма сжатия bzip2.1415Модуль `bz2` содержит:1617- Функция [`open()`](https://python-all.ru/3.14/library/bz2.html#bz2.open) и класс [`BZ2File`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2File) для чтения и записи сжатых файлов.18- Классы [`BZ2Compressor`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Compressor) и [`BZ2Decompressor`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Decompressor) для инкрементального сжатия и распаковки.19- Функции [`compress()`](https://python-all.ru/3.14/library/bz2.html#bz2.compress) и [`decompress()`](https://python-all.ru/3.14/library/bz2.html#bz2.decompress) для одноразового сжатия и распаковки.2021Это [опциональный модуль](https://python-all.ru/3.14/glossary.html#term-optional-module). Если его нет в вашей копии CPython, обратитесь к документации от вашего дистрибьютора (то есть того, кто предоставил вам Python). Если вы дистрибьютор, обратитесь к [требованиям к опциональным модулям](https://python-all.ru/3.14/using/configure.html#optional-module-requirements).2223## Сжатие и распаковка файлов2425#### `bz2.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)`2627Открывает сжатый bzip2 файл в бинарном или текстовом режиме, возвращая [файловый объект](https://python-all.ru/3.14/glossary.html#term-file-object).2829Как и в случае с конструктором [`BZ2File`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2File), аргумент *filename* может быть фактическим именем файла (объектом [`str`](https://python-all.ru/3.14/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.14/library/stdtypes.html#bytes)) или существующим файловым объектом для чтения или записи.3031Аргумент *mode* может быть любым из `'r'`, `'rb'`, `'w'`, `'wb'`, `'x'`, `'xb'`, `'a'` или `'ab'` для бинарного режима, или `'rt'`, `'wt'`, `'xt'` или `'at'` для текстового режима. По умолчанию `'rb'`.3233Аргумент *compresslevel* – целое число от 1 до 9, как и у конструктора [`BZ2File`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2File).3435В бинарном режиме эта функция эквивалентна конструктору [`BZ2File`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2File): `BZ2File(filename, mode, compresslevel=compresslevel)`. В этом случае аргументы *encoding*, *errors* и *newline* не должны передаваться.3637Для текстового режима создаётся объект [`BZ2File`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2File), обёрнутый в экземпляр [`io.TextIOWrapper`](https://python-all.ru/3.14/library/io.html#io.TextIOWrapper) с указанными кодировкой, поведением при ошибках и символами конца строки.3839Добавлено в версии 3.3.4041Изменено в версии 3.4: Добавлен режим `'x'` (эксклюзивное создание).4243Изменено в версии 3.6: Принимает [объект, подобный пути](https://python-all.ru/3.14/glossary.html#term-path-like-object).4445#### `class bz2.BZ2File(filename, mode='r', *, compresslevel=9)`4647Открывает сжатый bzip2 файл в бинарном режиме.4849Если *filename* – объект [`str`](https://python-all.ru/3.14/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.14/library/stdtypes.html#bytes), открыть указанный файл напрямую. В противном случае *filename* должен быть [файловым объектом](https://python-all.ru/3.14/glossary.html#term-file-object), который будет использоваться для чтения или записи сжатых данных.5051Аргумент *mode* может быть `'r'` для чтения (по умолчанию), `'w'` для перезаписи, `'x'` для исключительного создания или `'a'` для добавления. Им эквивалентно соответствуют `'rb'`, `'wb'`, `'xb'` и `'ab'` соответственно.5253Если *filename* – файловый объект (а не фактическое имя файла), режим `'w'` не усекает файл, а вместо этого эквивалентен `'a'`.5455Если *mode* – `'w'` или `'a'`, *compresslevel* может быть целым числом от `1` до `9`, задающим уровень сжатия: `1` даёт наименьшее сжатие, а `9` (по умолчанию) – наибольшее.5657Если *mode* – `'r'`, входной файл может быть объединением нескольких сжатых потоков.5859`BZ2File` предоставляет все члены, указанные в [`io.BufferedIOBase`](https://python-all.ru/3.14/library/io.html#io.BufferedIOBase), за исключением [`detach()`](https://python-all.ru/3.14/library/io.html#io.BufferedIOBase.detach) и [`truncate()`](https://python-all.ru/3.14/library/io.html#io.IOBase.truncate). Поддерживаются итерация и оператор [`with`](https://python-all.ru/3.14/reference/compound_stmts.html#with).6061`BZ2File` также предоставляет следующие методы и атрибуты:6263#### `peek([n])`6465Возвращает буферизованные данные без продвижения файловой позиции. Будет возвращён как минимум один байт данных (если не достигнут конец файла). Точное количество возвращаемых байт не указано.6667> **Примечание**68>69> Хотя вызов `peek()` не меняет файловую позицию `BZ2File`, он может изменить позицию нижележащего файлового объекта (например, если `BZ2File` был создан путём передачи файлового объекта в качестве *filename*).7071Добавлено в версии 3.3.7273#### `fileno()`7475Возвращает файловый дескриптор базового файла.7677Добавлено в версии 3.3.7879#### `readable()`8081Возвращает, был ли файл открыт для чтения.8283Добавлено в версии 3.3.8485#### `seekable()`8687Возвращает, поддерживает ли файл позиционирование.8889Добавлено в версии 3.3.9091#### `writable()`9293Возвращает, был ли файл открыт для записи.9495Добавлено в версии 3.3.9697#### `read1(size=-1)`9899Читает не более *size* несжатых байт, стараясь не выполнять несколько операций чтения из нижележащего потока. Если size отрицателен, читает данные объёмом до одного буфера.100101Возвращает `b''`, если достигнут конец файла (EOF).102103Добавлено в версии 3.3.104105#### `readinto(b)`106107Читает байты в *b*.108109Возвращает количество прочитанных байт (0 – конец файла).110111Добавлено в версии 3.3.112113#### `mode`114115`'rb'` для чтения и `'wb'` для записи.116117Добавлено в версии 3.13.118119#### `name`120121Имя bzip2-файла. Эквивалентно атрибуту [`name`](https://python-all.ru/3.14/library/io.html#io.FileIO.name) базового [файлового объекта](https://python-all.ru/3.14/glossary.html#term-file-object).122123Добавлено в версии 3.13.124125Изменено в версии 3.1: Добавлена поддержка оператора [`with`](https://python-all.ru/3.14/reference/compound_stmts.html#with).126127Изменено в версии 3.3: Добавлена поддержка передачи *filename* в качестве [файлового объекта](https://python-all.ru/3.14/glossary.html#term-file-object) вместо реального имени файла.128129Добавлен режим `'a'` (добавление) и поддержка чтения файлов с несколькими потоками.130131Изменено в версии 3.4: Добавлен режим `'x'` (эксклюзивное создание).132133Изменено в версии 3.5: Метод [`read()`](https://python-all.ru/3.14/library/io.html#io.BufferedIOBase.read) теперь принимает аргумент типа `None`.134135Изменено в версии 3.6: Принимает [объект, подобный пути](https://python-all.ru/3.14/glossary.html#term-path-like-object).136137Изменено в версии 3.9: Параметр *buffering* был удалён. Он игнорировался и считался устаревшим начиная с Python 3.0. Для управления открытием файла передавайте открытый файловый объект.138139Параметр *compresslevel* стал строго именованным аргументом.140141Изменено в версии 3.10: Этот класс не является потокобезопасным при одновременном чтении или записи из нескольких потоков – как и его аналоги в модулях [`gzip`](https://python-all.ru/3.14/library/gzip.html#module-gzip) и [`lzma`](https://python-all.ru/3.14/library/lzma.html#module-lzma).142143## Инкрементальное (де)сжатие144145#### `class bz2.BZ2Compressor(compresslevel=9)`146147Создаёт новый объект компрессора. Этот объект можно использовать для инкрементального сжатия данных. Для однократного сжатия используйте функцию [`compress()`](https://python-all.ru/3.14/library/bz2.html#bz2.compress).148149*compresslevel*, если указан, должен быть целым числом между `1` и `9`. По умолчанию `9`.150151#### `compress(data)`152153Передаёт данные объекту компрессора. Возвращает сжатый фрагмент данных, если возможно, или пустую байтовую строку в противном случае.154155После завершения передачи данных компрессору следует вызвать метод [`flush()`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Compressor.flush) для завершения процесса сжатия.156157#### `flush()`158159Завершает процесс сжатия. Возвращает сжатые данные, оставшиеся во внутренних буферах.160161Объект компрессора нельзя использовать после вызова этого метода.162163#### `class bz2.BZ2Decompressor`164165Создаёт новый объект декомпрессора. Этот объект можно использовать для инкрементальной декомпрессии данных. Для одноразового сжатия используйте функцию [`decompress()`](https://python-all.ru/3.14/library/bz2.html#bz2.decompress) вместо этого.166167> **Примечание**168>169> Этот класс не обрабатывает прозрачно входные данные, содержащие несколько сжатых потоков, в отличие от [`decompress()`](https://python-all.ru/3.14/library/bz2.html#bz2.decompress) и [`BZ2File`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2File). Если необходимо декомпрессировать многопоточный вход с помощью `BZ2Decompressor`, нужно использовать новый декомпрессор для каждого потока.170171#### `decompress(data, max_length=-1)`172173Декомпрессирует *data* ([байтоподобный объект](https://python-all.ru/3.14/glossary.html#term-bytes-like-object)), возвращая несжатые данные в виде байтов. Часть *data* может буферизироваться внутренне для использования в последующих вызовах `decompress()`. Возвращаемые данные следует объединять с результатом любых предыдущих вызовов `decompress()`.174175Если *max\_length* неотрицательно, возвращает не более *max\_length* байтов декомпрессированных данных. Если этот лимит достигнут и может быть сгенерирован дальнейший вывод, атрибут [`needs_input`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Decompressor.needs_input) будет установлен в `False`. В этом случае следующий вызов `decompress()` может передать *data* как `b''` для получения ещё вывода.176177Если все входные данные были декомпрессированы и возвращены (либо потому что это было меньше *max\_length* байтов, либо потому что *max\_length* было отрицательным), атрибут [`needs_input`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Decompressor.needs_input) будет установлен в `True`.178179Попытка декомпрессировать данные после достижения конца потока вызывает [`EOFError`](https://python-all.ru/3.14/library/exceptions.html#EOFError). Любые данные, обнаруженные после конца потока, игнорируются и сохраняются в атрибуте [`unused_data`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Decompressor.unused_data).180181Изменено в версии 3.5: Добавлен параметр *max\_length*.182183#### `eof`184185`True`, если достигнут маркер конца потока.186187Добавлено в версии 3.3.188189#### `unused_data`190191Данные, обнаруженные после конца сжатого потока.192193Если к этому атрибуту обратиться до достижения конца потока, его значение будет `b''`.194195#### `needs_input`196197`False`, если метод [`decompress()`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Decompressor.decompress) может предоставить больше декомпрессированных данных до запроса нового несжатого входа.198199Добавлено в версии 3.5.200201## Одноразовое (де)сжатие202203#### `bz2.compress(data, compresslevel=9)`204205Сжимает *data*, [байтоподобный объект](https://python-all.ru/3.14/glossary.html#term-bytes-like-object).206207*compresslevel*, если указан, должен быть целым числом между `1` и `9`. По умолчанию `9`.208209Для инкрементального сжатия используйте [`BZ2Compressor`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Compressor).210211#### `bz2.decompress(data)`212213Декомпрессирует *data*, [байтоподобный объект](https://python-all.ru/3.14/glossary.html#term-bytes-like-object).214215Если *data* является объединением нескольких сжатых потоков, декомпрессирует все потоки.216217Для инкрементальной декомпрессии используйте [`BZ2Decompressor`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Decompressor).218219Изменено в версии 3.3: Добавлена поддержка многопоточных входных данных.220221## Примеры использования222223Ниже приведены несколько примеров типичного использования модуля `bz2`.224225Использование [`compress()`](https://python-all.ru/3.14/library/bz2.html#bz2.compress) и [`decompress()`](https://python-all.ru/3.14/library/bz2.html#bz2.decompress) для демонстрации двустороннего сжатия:226227```python228>>> import bz2229>>> data = b"""\230... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue231... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,232... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus233... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.234... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo235... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum236... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""237>>> c = bz2.compress(data)238>>> len(data) / len(c)  # Коэффициент сжатия данных2391.513595166163142240>>> d = bz2.decompress(c)241>>> data == d  # Проверка равенства исходному объекту после полного цикла сжатия-распаковки242True243```244245Использование [`BZ2Compressor`](https://python-all.ru/3.14/library/bz2.html#bz2.BZ2Compressor) для инкрементального сжатия:246247```python248>>> import bz2249>>> def gen_data(chunks=10, chunksize=1000):250...     """Выдаёт инкрементальные блоки по chunksize байт."""251...     for _ in range(chunks):252...         yield b"z" * chunksize253...254>>> comp = bz2.BZ2Compressor()255>>> out = b""256>>> for chunk in gen_data():257...     # Передаёт данные объекту сжатия258...     out = out + comp.compress(chunk)259...260>>> # Завершает процесс сжатия. Вызывайте этот метод после того, как261>>> # завершена передача данных компрессору.262>>> out = out + comp.flush()263```264265В приведённом примере используется очень «неслучайный» поток данных (поток фрагментов `b"z"`). Случайные данные обычно сжимаются плохо, тогда как упорядоченные повторяющиеся данные обычно дают высокую степень сжатия.266267Запись и чтение сжатого bzip2 файла в двоичном режиме:268269```python270>>> import bz2271>>> data = b"""\272... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue273... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,274... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus275... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.276... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo277... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum278... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""279>>> with bz2.open("myfile.bz2", "wb") as f:280...     # Записать сжатые данные в файл281...     unused = f.write(data)282...283>>> with bz2.open("myfile.bz2", "rb") as f:284...     # Распаковать данные из файла285...     content = f.read()286...287>>> content == data  # Проверка равенства исходному объекту после полного цикла сжатия-распаковки288True289```290