`base64.md`

232 строк · 26.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.13/library/base64.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `base64` – кодирование данных Base16, Base32, Base64, Base8589**Исходный код:** [Lib/base64.py](https://python-all.ru/src/3.13/Lib/base64.py)1011---1213Этот модуль предоставляет функции для кодирования двоичных данных в печатные символы ASCII и декодирования таких кодировок обратно в двоичные данные. Сюда входят [кодировки, указанные в](https://python-all.ru/3.13/library/base64.html#base64-rfc-4648) [**RFC 4648**](https://python-all.ru/3.13/library/base64.html) (Base64, Base32 и Base16), [кодировка Base85](https://python-all.ru/3.13/library/base64.html#base64-base-85), указанная в [PDF 2.0](https://python-all.ru/3.13/library/base64.html), и нестандартные варианты Base85, используемые в других местах.1415Модуль предоставляет два интерфейса. Современный интерфейс поддерживает кодирование [байтоподобных объектов](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) в ASCII [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes) и декодирование байтоподобных объектов или строк, содержащих ASCII, в `bytes`. Поддерживаются оба алфавита base-64, определённых в [**RFC 4648**](https://python-all.ru/3.13/library/base64.html) (обычный и безопасный для URL и файловых систем).1617[Устаревший интерфейс](https://python-all.ru/3.13/library/base64.html#base64-legacy) не поддерживает декодирование из строк, но предоставляет функции для кодирования и декодирования в [файловые объекты](https://python-all.ru/3.13/glossary.html#term-file-object) и из них. Он поддерживает только стандартный алфавит Base64 и добавляет символы новой строки каждые 76 символов, как указано в [**RFC 2045**](https://python-all.ru/3.13/library/base64.html). Обратите внимание: если вам нужна поддержка [**RFC 2045**](https://python-all.ru/3.13/library/base64.html), возможно, стоит обратить внимание на пакет [`email`](https://python-all.ru/3.13/library/email.html#module-email).1819Изменено в версии 3.3: Теперь функции декодирования современного интерфейса принимают строки Unicode, содержащие только ASCII.2021Изменено в версии 3.4: Теперь все функции кодирования и декодирования в этом модуле принимают любые [байтоподобные объекты](https://python-all.ru/3.13/glossary.html#term-bytes-like-object). Добавлена поддержка Ascii85/Base85.2223## Кодировки RFC 46482425Кодировки [**RFC 4648**](https://python-all.ru/3.13/library/base64.html) подходят для кодирования двоичных данных, чтобы их можно было безопасно отправлять по электронной почте, использовать как части URL или включать в тело HTTP POST-запроса.2627#### `base64.b64encode(s, altchars=None)`2829Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s* с помощью Base64 и возвращает закодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).3031Необязательный *altchars* должен быть [байтоподобным объектом](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) длины 2, который задаёт альтернативный алфавит для символов `+` и `/`. Это позволяет приложению, например, генерировать строки Base64, безопасные для URL или файловых систем. По умолчанию используется `None`, для которого применяется стандартный алфавит Base64.3233Может вызвать утверждение (assert) или возбудить [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError), если длина *altchars* не равна 2. Возбуждает [`TypeError`](https://python-all.ru/3.13/library/exceptions.html#TypeError), если *altchars* не является [байтоподобным объектом](https://python-all.ru/3.13/glossary.html#term-bytes-like-object).3435#### `base64.b64decode(s, altchars=None, validate=False)`3637Декодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object), закодированный в Base64, или ASCII-строку *s* и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).3839Необязательный *altchars* должен быть [байтоподобным объектом](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строкой длины 2, которая задаёт альтернативный алфавит, используемый вместо символов `+` и `/`.4041Исключение [`binascii.Error`](https://python-all.ru/3.13/library/binascii.html#binascii.Error) вызывается, если *s* имеет неправильное дополнение.4243Если *validate* равен `False` (по умолчанию), символы, не входящие ни в обычный алфавит base-64, ни в альтернативный, отбрасываются перед проверкой дополнения. Если *validate* равен `True`, такие символы, не являющиеся буквами алфавита, приводят к [`binascii.Error`](https://python-all.ru/3.13/library/binascii.html#binascii.Error).4445Дополнительную информацию о строгой проверке base64 см. в [`binascii.a2b_base64()`](https://python-all.ru/3.13/library/binascii.html#binascii.a2b_base64)4647Может вызвать утверждение или возбудить [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError), если длина *altchars* не равна 2.4849#### `base64.standard_b64encode(s)`5051Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s* с использованием стандартного алфавита Base64 и возвращает закодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).5253#### `base64.standard_b64decode(s)`5455Декодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *s* с использованием стандартного алфавита Base64 и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).5657#### `base64.urlsafe_b64encode(s)`5859Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s* с использованием алфавита, безопасного для URL и файловых систем, который подставляет `-` вместо `+` и `_` вместо `/` в стандартном алфавите Base64, и возвращает закодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes). Результат всё ещё может содержать `=`.6061#### `base64.urlsafe_b64decode(s)`6263Декодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *s* с использованием алфавита, безопасного для URL и файловых систем, который подставляет `-` вместо `+` и `_` вместо `/` в стандартном алфавите Base64, и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).6465#### `base64.b32encode(s)`6667Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s* с помощью Base32 и возвращает закодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).6869#### `base64.b32decode(s, casefold=False, map01=None)`7071Декодирует закодированный Base32 [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *s* и возвращает декодированные [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).7273Необязательный флаг *casefold* указывает, допускается ли строчный алфавит на входе. Из соображений безопасности по умолчанию используется `False`.7475[**RFC 4648**](https://python-all.ru/3.13/library/base64.html) допускает необязательное отображение цифры 0 (ноль) на букву O (о) и необязательное отображение цифры 1 (один) на букву I (ай) или L (эль). Необязательный аргумент *map01*, если он не равен `None`, указывает, на какую букву должна отображаться цифра 1 (когда *map01* не равен `None`, цифра 0 всегда отображается на букву O). Из соображений безопасности по умолчанию используется `None`, так что 0 и 1 не допускаются на входе.7677Исключение [`binascii.Error`](https://python-all.ru/3.13/library/binascii.html#binascii.Error) возникает, если *s* имеет некорректное дополнение или если во входных данных присутствуют неалфавитные символы.7879#### `base64.b32hexencode(s)`8081Аналогично [`b32encode()`](https://python-all.ru/3.13/library/base64.html#base64.b32encode), но использует расширенный шестнадцатеричный алфавит, как определено в [**RFC 4648**](https://python-all.ru/3.13/library/base64.html).8283Добавлено в версии 3.10.8485#### `base64.b32hexdecode(s, casefold=False)`8687Аналогично [`b32decode()`](https://python-all.ru/3.13/library/base64.html#base64.b32decode), но использует расширенный шестнадцатеричный алфавит, как определено в [**RFC 4648**](https://python-all.ru/3.13/library/base64.html).8889Эта версия не допускает отображения цифры 0 (ноль) на букву O (о) и цифры 1 (один) на букву I (ай) или L (эль); все эти символы входят в расширенный шестнадцатеричный алфавит и не являются взаимозаменяемыми.9091Добавлено в версии 3.10.9293#### `base64.b16encode(s)`9495Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s* с помощью Base16 и возвращает закодированные [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).9697#### `base64.b16decode(s, casefold=False)`9899Декодирует закодированный Base16 [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *s* и возвращает декодированные [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).100101Необязательный флаг *casefold* указывает, допускается ли строчный алфавит на входе. Из соображений безопасности по умолчанию используется `False`.102103Исключение [`binascii.Error`](https://python-all.ru/3.13/library/binascii.html#binascii.Error) возникает, если *s* имеет некорректное дополнение или если во входных данных присутствуют неалфавитные символы.104105## Кодировки Base85106107Кодировка Base85 – это семейство алгоритмов, которые представляют четыре байта с помощью пяти ASCII-символов. Изначально реализованная в утилите Unix `btoa(1)`, её версия позже была принята Adobe в языке PostScript и стандартизирована в PDF 2.0 (ISO 32000-2). Эта версия, как в варианте `btoa`, так и в варианте PDF, реализована в [`a85encode()`](https://python-all.ru/3.13/library/base64.html#base64.a85encode).108109Отдельная версия, использующая другой набор выходных символов, была определена как первоапрельская шутка в [**RFC 1924**](https://python-all.ru/3.13/library/base64.html), но теперь используется Git и другим программным обеспечением. Эта версия реализована в [`b85encode()`](https://python-all.ru/3.13/library/base64.html#base64.b85encode).110111Наконец, третья версия, использующая еще один набор выходных символов, предназначенный для безопасного включения в строки языков программирования, определена ZeroMQ и реализована здесь в [`z85encode()`](https://python-all.ru/3.13/library/base64.html#base64.z85encode).112113Функции, представленные в этом модуле, различаются тем, как они обрабатывают следующее:114115- Нужно ли включать и ожидать обрамляющие маркеры `<~` и `~>`.116- Нужно ли разбивать входные данные на несколько строк.117- Набор ASCII-символов, используемых для кодирования.118- Компактное кодирование последовательностей пробелов и нулевых байтов.119- Кодирование байтов нулевого дополнения, применяемых к входным данным.120121Обратитесь к документации отдельных функций для получения дополнительной информации.122123#### `base64.a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)`124125Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *b* с помощью Ascii85 и возвращает закодированные [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).126127*foldspaces* – необязательный флаг, который использует специальную короткую последовательность 'y' вместо 4 последовательных пробелов (ASCII 0x20), как поддерживается в 'btoa'. Эта возможность не поддерживается стандартным кодированием, используемым в PDF.128129*wrapcol* управляет добавлением в выходные данные символов новой строки (`b'\n'`). Если это значение не равно нулю, каждая выходная строка будет длиной не более этого количества символов, не считая завершающей новой строки.130131*pad* управляет тем, сохраняется ли нулевое дополнение, примененное к концу входных данных, полностью в результирующем кодировании, как это делает `btoa`, создавая выходные данные, кратные 5 байтам. Это не является частью стандартного кодирования, используемого в PDF, поскольку не сохраняет длину данных.132133*adobe* управляет, обрамляется ли закодированная последовательность байтов маркерами `<~` и `~>`, как в строковом литерале PostScript base-85. Обратите внимание: хотя потоки ASCII85Decode в документах PDF *должны* завершаться `~>`, они *не должны* использовать начальный `<~`.134135Добавлено в версии 3.4.136137#### `base64.a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')`138139Декодирует Ascii85-закодированный [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *b* и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).140141*foldspaces* – это флаг, указывающий, следует ли принимать короткую последовательность 'y' как сокращение для 4 последовательных пробелов (ASCII 0x20). Эта возможность не поддерживается стандартным кодированием Ascii85, используемым в PDF и PostScript.142143*adobe* управляет наличием маркеров `<~` и `~>`. Хотя начальный `<~` не требуется, входные данные должны заканчиваться на `~>`, иначе будет вызвано [`ValueError`](https://python-all.ru/3.13/library/exceptions.html#ValueError).144145*ignorechars* должен быть байтовой строкой, содержащей символы, которые следует игнорировать во входных данных. Она должна содержать только пробельные символы и по умолчанию включает все пробельные символы ASCII.146147Добавлено в версии 3.4.148149#### `base64.b85encode(b, pad=False)`150151Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *b* с помощью base85 (используется, например, в двоичных diff-файлах в стиле git) и возвращает закодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).152153Входные данные дополняются `b'\0'`, чтобы их длина была кратна 4 байтам перед кодированием. Если *pad* истинно, все результирующие символы сохраняются в выходных данных, которые всегда будут кратны 5 байтам, и поэтому длина данных может не сохраниться при декодировании.154155Добавлено в версии 3.4.156157#### `base64.b85decode(b)`158159Декодирует base85-закодированный [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *b* и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).160161Добавлено в версии 3.4.162163#### `base64.z85encode(s)`164165Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s* с помощью Z85 (используется в ZeroMQ) и возвращает закодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).166167Спецификация [ZeroMQ](https://python-all.ru/3.13/library/base64.html) требует, чтобы длина данных, закодированных Z85, была кратна 5 байтам. Чтобы получить корректные кадры данных, входные данные, передаваемые этой функции, необходимо дополнить до кратности 4 байтам.168169Добавлено в версии 3.13.170171#### `base64.z85decode(s)`172173Декодирует Z85-закодированный [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) или ASCII-строку *s* и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).174175Добавлено в версии 3.13.176177## Устаревший интерфейс178179#### `base64.decode(input, output)`180181Декодирует содержимое бинарного файла *input* и записывает полученные бинарные данные в файл *output*. *input* и *output* должны быть [файловыми объектами](https://python-all.ru/3.13/glossary.html#term-file-object). *input* будет читаться до тех пор, пока `input.readline()` не вернёт пустой bytes-объект.182183#### `base64.decodebytes(s)`184185Декодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s*, который должен содержать одну или несколько строк данных, закодированных в base64, и возвращает декодированный [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes).186187Добавлено в версии 3.1.188189#### `base64.encode(input, output)`190191Кодирует содержимое бинарного файла *input* и записывает полученные данные в кодировке base64 в файл *output*. *input* и *output* должны быть [файловыми объектами](https://python-all.ru/3.13/glossary.html#term-file-object). *input* будет читаться до тех пор, пока `input.read()` не вернёт пустой bytes-объект. `encode()` вставляет символ новой строки (`b'\n'`) после каждых 76 байт выходных данных, а также гарантирует, что выходные данные всегда заканчиваются новой строкой, в соответствии с [**RFC 2045**](https://python-all.ru/3.13/library/base64.html) (MIME).192193#### `base64.encodebytes(s)`194195Кодирует [байтоподобный объект](https://python-all.ru/3.13/glossary.html#term-bytes-like-object) *s*, который может содержать произвольные бинарные данные, и возвращает [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes), содержащее данные в кодировке base64, с символами новой строки (`b'\n'`), вставляемыми после каждых 76 байт выходных данных, и гарантирует наличие завершающего перевода строки в соответствии с [**RFC 2045**](https://python-all.ru/3.13/library/base64.html) (MIME).196197Добавлено в версии 3.1.198199Пример использования модуля:200201```python202>>> import base64203>>> encoded = base64.b64encode(b'data to be encoded')204>>> encoded205b'ZGF0YSB0byBiZSBlbmNvZGVk'206>>> data = base64.b64decode(encoded)207>>> data208b'data to be encoded'209```210211## Вопросы безопасности212213Новый раздел по вопросам безопасности был добавлен в [**RFC 4648**](https://python-all.ru/3.13/library/base64.html) (раздел 12); рекомендуется ознакомиться с разделом безопасности для любого кода, развёртываемого в рабочей среде.214215> **См. также**216>217> **Модуль [`binascii`](https://python-all.ru/3.13/library/binascii.html#module-binascii)**218>219> Вспомогательный модуль, содержащий преобразования ASCII-в-двоичный и двоичный-в-ASCII.220>221> **[**RFC 1521**](https://python-all.ru/3.13/library/base64.html) – MIME (Многоцелевые расширения интернет-почты) Часть 1: Механизмы указания и описания формата тел интернет-сообщений**222>223> Раздел 5.2, «Base64 Content-Transfer-Encoding», содержит определение кодировки base64.224>225> **[ISO 32000-2 Формат переносимых документов – Часть 2: PDF 2.0](https://python-all.ru/3.13/library/base64.html)**226>227> Раздел 7.4.3, «Фильтр ASCII85Decode», содержит определение кодировки Ascii85, используемой в PDF и PostScript, включая выходной набор символов и подробности сохранения длины данных с помощью нулевого дополнения и частичных выходных групп.228>229> **[ZeroMQ RFC 32/Z85](https://python-all.ru/3.13/library/base64.html)**230>231> Раздел «Формальная спецификация» описывает набор символов, используемый в Z85.232