`gzip.md`

207 строк · 18.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.13/library/gzip.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `gzip` – Поддержка файлов **gzip**89**Исходный код:** [Lib/gzip.py](https://python-all.ru/src/3.13/Lib/gzip.py)1011---1213Этот модуль предоставляет простой интерфейс для сжатия и распаковки файлов, подобно тому, как это делают программы GNU **gzip** и **gunzip**.1415Сжатие данных обеспечивается модулем [`zlib`](https://python-all.ru/3.13/library/zlib.html#module-zlib).1617Модуль `gzip` предоставляет класс [`GzipFile`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile), а также вспомогательные функции [`open()`](https://python-all.ru/3.13/library/gzip.html#gzip.open), [`compress()`](https://python-all.ru/3.13/library/gzip.html#gzip.compress) и [`decompress()`](https://python-all.ru/3.13/library/gzip.html#gzip.decompress). Класс `GzipFile` читает и записывает файлы в формате **gzip**, автоматически сжимая или распаковывая данные, так что он выглядит как обычный [файловый объект](https://python-all.ru/3.13/glossary.html#term-file-object).1819Обратите внимание, что дополнительные форматы файлов, которые могут быть распакованы программами **gzip** и **gunzip**, например, созданные программами **compress** и **pack**, не поддерживаются этим модулем.2021Модуль определяет следующие элементы:2223#### `gzip.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)`2425Открывает файл, сжатый gzip, в двоичном или текстовом режиме и возвращает [файловый объект](https://python-all.ru/3.13/glossary.html#term-file-object).2627Аргумент *filename* может быть фактическим именем файла (объектом [`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes)) или существующим файловым объектом для чтения или записи.2829Аргумент *mode* может быть любым из `'r'`, `'rb'`, `'a'`, `'ab'`, `'w'`, `'wb'`, `'x'` или `'xb'` для бинарного режима, или `'rt'`, `'at'`, `'wt'` или `'xt'` для текстового режима. По умолчанию `'rb'`.3031Аргумент *compresslevel* – целое число от 0 до 9, как для конструктора [`GzipFile`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile).3233В двоичном режиме эта функция эквивалентна конструктору [`GzipFile`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile): `GzipFile(filename, mode, compresslevel)`. В этом случае аргументы *encoding*, *errors* и *newline* не должны быть указаны.3435Для текстового режима создаётся объект [`GzipFile`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile), обёрнутый в экземпляр [`io.TextIOWrapper`](https://python-all.ru/3.13/library/io.html#io.TextIOWrapper) с указанными кодировкой, поведением при ошибках и символами конца строки.3637Изменено в версии 3.3: Добавлена поддержка *filename* в качестве файлового объекта, поддержка текстового режима, и аргументов *encoding*, *errors* и *newline*.3839Изменено в версии 3.4: Добавлена поддержка режимов `'x'`, `'xb'` и `'xt'`.4041Изменено в версии 3.6: Принимает [объект, подобный пути](https://python-all.ru/3.13/glossary.html#term-path-like-object).4243#### `exception gzip.BadGzipFile`4445Исключение, возбуждаемое для недопустимых файлов gzip. Оно наследуется от [`OSError`](https://python-all.ru/3.13/library/exceptions.html#OSError). [`EOFError`](https://python-all.ru/3.13/library/exceptions.html#EOFError) и [`zlib.error`](https://python-all.ru/3.13/library/zlib.html#zlib.error) также могут возбуждаться для недопустимых файлов gzip.4647Добавлено в версии 3.8.4849#### `class gzip.GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)`5051Конструктор класса `GzipFile`, который имитирует большинство методов [файлового объекта](https://python-all.ru/3.13/glossary.html#term-file-object), за исключением метода [`truncate()`](https://python-all.ru/3.13/library/io.html#io.IOBase.truncate). По крайней мере один из *fileobj* и *filename* должен иметь нетривиальное значение.5253Новый экземпляр класса основан на *fileobj*, который может быть обычным файлом, объектом [`io.BytesIO`](https://python-all.ru/3.13/library/io.html#io.BytesIO) или любым другим объектом, имитирующим файл. По умолчанию он равен `None`, и в этом случае *filename* открывается для предоставления файлового объекта.5455Если *fileobj* не равен `None`, аргумент *filename* используется только для включения в заголовок файла **gzip**, который может содержать исходное имя файла несжатого файла. По умолчанию он равен имени файла *fileobj*, если его можно определить; в противном случае по умолчанию используется пустая строка, и в этом случае исходное имя файла не включается в заголовок.5657Аргумент *mode* может быть любым из `'r'`, `'rb'`, `'a'`, `'ab'`, `'w'`, `'wb'`, `'x'` или `'xb'`, в зависимости от того, будет ли файл читаться или записываться. По умолчанию используется режим *fileobj*, если его можно определить; в противном случае по умолчанию используется `'rb'`. В будущих версиях Python режим *fileobj* не будет использоваться. Лучше всегда указывать *mode* для записи.5859Обратите внимание, что файл всегда открывается в двоичном режиме. Чтобы открыть сжатый файл в текстовом режиме, используйте [`open()`](https://python-all.ru/3.13/library/gzip.html#gzip.open) (или оберните свой `GzipFile` с помощью [`io.TextIOWrapper`](https://python-all.ru/3.13/library/io.html#io.TextIOWrapper)).6061Аргумент *compresslevel* – целое число от `0` до `9`, управляющее уровнем сжатия; `1` – самый быстрый и даёт наименьшее сжатие, а `9` – самый медленный и даёт наибольшее сжатие. `0` – это отсутствие сжатия. По умолчанию `9`.6263Необязательный аргумент *mtime* – это временная метка, запрашиваемая gzip. Время представлено в формате Unix, т.е. секунды с 00:00:00 UTC, 1 января 1970 года. Если *mtime* опущен или равен `None`, используется текущее время. Используйте *mtime* = 0, чтобы создать сжатый поток, не зависящий от времени создания.6465Смотрите ниже атрибут [`mtime`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile.mtime), который устанавливается при распаковке.6667Вызов метода `close()` объекта `GzipFile` не закрывает *fileobj*, поскольку может потребоваться добавить ещё данные после сжатых данных. Это также позволяет передать объект [`io.BytesIO`](https://python-all.ru/3.13/library/io.html#io.BytesIO), открытый для записи, в качестве *fileobj*, и получить результирующий буфер в памяти с помощью метода [`getvalue()`](https://python-all.ru/3.13/library/io.html#io.BytesIO.getvalue) объекта `io.BytesIO`.6869`GzipFile` поддерживает интерфейс [`io.BufferedIOBase`](https://python-all.ru/3.13/library/io.html#io.BufferedIOBase), включая итерацию и оператор [`with`](https://python-all.ru/3.13/reference/compound_stmts.html#with). Не реализован только метод [`truncate()`](https://python-all.ru/3.13/library/io.html#io.IOBase.truncate).7071`GzipFile` также предоставляет следующий метод и атрибут:7273#### `peek(n)`7475Читает *n* несжатых байт без изменения позиции файла. Количество возвращаемых байт может быть больше или меньше запрошенного.7677> **Примечание**78>79> Хотя вызов `peek()` не изменяет позицию файла объекта `GzipFile`, он может изменить позицию нижележащего файлового объекта (например, если `GzipFile` был создан с параметром *fileobj*).8081Добавлено в версии 3.2.8283#### `mode`8485`'rb'` для чтения и `'wb'` для записи.8687Изменено в версии 3.13: В предыдущих версиях это было целое число `1` или `2`.8889#### `mtime`9091При распаковке этот атрибут устанавливается в последнюю временную метку из самого последнего прочитанного заголовка. Это целое число, содержащее количество секунд с начала эпохи Unix (00:00:00 UTC, 1 января 1970 г.). Начальное значение до чтения любого заголовка – `None`.9293#### `name`9495Путь к файлу gzip на диске, как [`str`](https://python-all.ru/3.13/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes). Эквивалентен выводу [`os.fspath()`](https://python-all.ru/3.13/library/os.html#os.fspath) для исходного пути ввода, без какой-либо дополнительной нормализации, разрешения или раскрытия.9697Изменено в версии 3.1: Добавлена поддержка оператора [`with`](https://python-all.ru/3.13/reference/compound_stmts.html#with), а также аргумента конструктора *mtime* и атрибута [`mtime`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile.mtime).9899Изменено в версии 3.2: Добавлена поддержка файлов с дополнением нулями и непозиционируемых файлов.100101Изменено в версии 3.3: Теперь реализован метод [`io.BufferedIOBase.read1()`](https://python-all.ru/3.13/library/io.html#io.BufferedIOBase.read1).102103Изменено в версии 3.4: Добавлена поддержка режимов `'x'` и `'xb'`.104105Изменено в версии 3.5: Добавлена поддержка записи произвольных [байтоподобных объектов](https://python-all.ru/3.13/glossary.html#term-bytes-like-object). Метод [`read()`](https://python-all.ru/3.13/library/io.html#io.BufferedIOBase.read) теперь принимает аргумент `None`.106107Изменено в версии 3.6: Принимает [объект, подобный пути](https://python-all.ru/3.13/glossary.html#term-path-like-object).108109Устарело с версии 3.9: Открытие `GzipFile` для записи без указания аргумента *mode* является устаревшим.110111Изменено в версии 3.12: Удалён атрибут `filename`, вместо него используйте атрибут [`name`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile.name).112113#### `gzip.compress(data, compresslevel=9, *, mtime=None)`114115Сжимает *данные* и возвращает объект [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes), содержащий сжатые данные. Параметры *compresslevel* и *mtime* имеют то же значение, что и в конструкторе [`GzipFile`](https://python-all.ru/3.13/library/gzip.html#gzip.GzipFile) выше.116117Добавлено в версии 3.2.118119Изменено в версии 3.8: Добавлен параметр *mtime* для воспроизводимого вывода.120121Изменено в версии 3.11: Скорость улучшена за счёт сжатия всех данных сразу, а не потоковым способом. Вызовы с *mtime*, установленным в `0`, перенаправляются в [`zlib.compress()`](https://python-all.ru/3.13/library/zlib.html#zlib.compress) для лучшей скорости. В этой ситуации вывод может содержать значение байта «ОС» заголовка gzip, отличное от 255 «неизвестно», которое предоставляется базовой реализацией zlib.122123Изменено в версии 3.13: Гарантируется, что байт ОС заголовка gzip будет установлен в 255 при использовании этой функции, как и в версиях 3.10 и более ранних.124125#### `gzip.decompress(data)`126127Распаковывает *data*, возвращая объект [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes), содержащий распакованные данные. Эта функция может распаковывать многокомпонентные данные gzip (несколько блоков gzip, объединённых вместе). Если данные точно содержат только один компонент, функция [`zlib.decompress()`](https://python-all.ru/3.13/library/zlib.html#zlib.decompress) с *wbits*, установленным в 31, работает быстрее.128129Добавлено в версии 3.2.130131Изменено в версии 3.11: Скорость улучшена за счёт распаковки компонентов сразу в памяти, а не потоковым способом.132133## Примеры использования134135Пример чтения сжатого файла:136137```python138import gzip139with gzip.open('/home/joe/file.txt.gz', 'rb') as f:140    file_content = f.read()141```142143Пример создания сжатого файла GZIP:144145```python146import gzip147content = b"Lots of content here"148with gzip.open('/home/joe/file.txt.gz', 'wb') as f:149    f.write(content)150```151152Пример сжатия существующего файла в формате GZIP:153154```python155import gzip156import shutil157with open('/home/joe/file.txt', 'rb') as f_in:158    with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out:159        shutil.copyfileobj(f_in, f_out)160```161162Пример сжатия бинарной строки в формате GZIP:163164```python165import gzip166s_in = b"Lots of content here"167s_out = gzip.compress(s_in)168```169170> **См. также**171>172> **Модуль [`zlib`](https://python-all.ru/3.13/library/zlib.html#module-zlib)**173>174> Базовый модуль сжатия данных, необходимый для поддержки формата файлов **gzip**.175>176> Если сжатие/распаковка gzip является узким местом, пакет [python-isal](https://python-all.ru/3.13/library/gzip.html) ускоряет сжатие/распаковку с помощью почти совместимого API.177178## Интерфейс командной строки179180Модуль `gzip` предоставляет простой интерфейс командной строки для сжатия или распаковки файлов.181182После выполнения модуль `gzip` сохраняет входной файл(ы).183184Изменено в версии 3.8: Добавлен новый интерфейс командной строки с описанием использования. По умолчанию при выполнении CLI уровень сжатия равен 6.185186### Параметры командной строки187188#### `file`189190Если *file* не указан, чтение из [`sys.stdin`](https://python-all.ru/3.13/library/sys.html#sys.stdin).191192#### `--fast`193194Указывает самый быстрый метод сжатия (меньше степень сжатия).195196#### `--best`197198Указывает самый медленный метод сжатия (наилучшее сжатие).199200#### `-d, --decompress`201202Распаковывает указанный файл.203204#### `-h, --help`205206Показывает справочное сообщение.207