`base64.md`

192 строк · 21.8 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/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.12/Lib/base64.py)1011---1213Этот модуль предоставляет функции для кодирования двоичных данных в печатные символы ASCII и декодирования таких кодировок обратно в двоичные данные. Он предоставляет функции кодирования и декодирования для кодировок, определённых в [**RFC 4648**](https://python-all.ru/3.12/library/base64.html), которая определяет алгоритмы Base16, Base32 и Base64, а также для фактических стандартов Ascii85 и Base85.1415Кодировки [**RFC 4648**](https://python-all.ru/3.12/library/base64.html) подходят для кодирования двоичных данных, чтобы их можно было безопасно отправлять по электронной почте, использовать как части URL или включать в HTTP POST-запросы. Алгоритм кодирования не совпадает с программой **uuencode**.1617Этот модуль предоставляет два интерфейса. Современный интерфейс поддерживает кодирование [байтоподобных объектов](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) в ASCII [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes) и декодирование [байтоподобных объектов](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или строк, содержащих ASCII, в [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Поддерживаются оба алфавита base-64, определённые в [**RFC 4648**](https://python-all.ru/3.12/library/base64.html) (обычный и безопасный для URL и файловых систем).1819Устаревший интерфейс не поддерживает декодирование из строк, но предоставляет функции для кодирования и декодирования с [файловыми объектами](https://python-all.ru/3.12/glossary.html#term-file-object). Он поддерживает только стандартный алфавит Base64 и добавляет символы новой строки каждые 76 символов в соответствии с [**RFC 2045**](https://python-all.ru/3.12/library/base64.html). Обратите внимание: если вам нужна поддержка [**RFC 2045**](https://python-all.ru/3.12/library/base64.html), вероятно, стоит обратить внимание на пакет [`email`](https://python-all.ru/3.12/library/email.html#module-email).2021Изменено в версии 3.3: Теперь функции декодирования современного интерфейса принимают строки Unicode, содержащие только ASCII.2223Изменено в версии 3.4: Теперь все функции кодирования и декодирования в этом модуле принимают любые [байтоподобные объекты](https://python-all.ru/3.12/glossary.html#term-bytes-like-object). Добавлена поддержка Ascii85/Base85.2425Современный интерфейс предоставляет:2627#### `base64.b64encode(s, altchars=None)`2829Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s* с помощью Base64 и возвращает закодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).3031Необязательный *altchars* должен быть [байтоподобным объектом](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) длины 2, который задаёт альтернативный алфавит для символов `+` и `/`. Это позволяет приложению, например, генерировать строки Base64, безопасные для URL или файловых систем. По умолчанию используется `None`, для которого применяется стандартный алфавит Base64.3233Может вызвать утверждение (assert) или возбудить [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError), если длина *altchars* не равна 2. Возбуждает [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError), если *altchars* не является [байтоподобным объектом](https://python-all.ru/3.12/glossary.html#term-bytes-like-object).3435#### `base64.b64decode(s, altchars=None, validate=False)`3637Декодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object), закодированный в Base64, или ASCII-строку *s* и возвращает декодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).3839Необязательный *altchars* должен быть [байтоподобным объектом](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или ASCII-строкой длины 2, которая задаёт альтернативный алфавит, используемый вместо символов `+` и `/`.4041Исключение [`binascii.Error`](https://python-all.ru/3.12/library/binascii.html#binascii.Error) вызывается, если *s* имеет неправильное дополнение.4243Если *validate* равен `False` (по умолчанию), символы, не входящие ни в обычный алфавит base-64, ни в альтернативный, отбрасываются перед проверкой дополнения. Если *validate* равен `True`, такие символы, не являющиеся буквами алфавита, приводят к [`binascii.Error`](https://python-all.ru/3.12/library/binascii.html#binascii.Error).4445Дополнительную информацию о строгой проверке base64 см. в [`binascii.a2b_base64()`](https://python-all.ru/3.12/library/binascii.html#binascii.a2b_base64)4647Может вызвать утверждение или возбудить [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError), если длина *altchars* не равна 2.4849#### `base64.standard_b64encode(s)`5051Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s* с использованием стандартного алфавита Base64 и возвращает закодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).5253#### `base64.standard_b64decode(s)`5455Декодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или ASCII-строку *s* с использованием стандартного алфавита Base64 и возвращает декодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).5657#### `base64.urlsafe_b64encode(s)`5859Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s* с использованием алфавита, безопасного для URL и файловых систем, который подставляет `-` вместо `+` и `_` вместо `/` в стандартном алфавите Base64, и возвращает закодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Результат всё ещё может содержать `=`.6061#### `base64.urlsafe_b64decode(s)`6263Декодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или ASCII-строку *s* с использованием алфавита, безопасного для URL и файловых систем, который подставляет `-` вместо `+` и `_` вместо `/` в стандартном алфавите Base64, и возвращает декодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).6465#### `base64.b32encode(s)`6667Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s* с помощью Base32 и возвращает закодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).6869#### `base64.b32decode(s, casefold=False, map01=None)`7071Декодирует закодированный Base32 [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или ASCII-строку *s* и возвращает декодированные [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).7273Необязательный флаг *casefold* указывает, допускается ли строчный алфавит на входе. Из соображений безопасности по умолчанию используется `False`.7475[**RFC 4648**](https://python-all.ru/3.12/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.12/library/binascii.html#binascii.Error) возникает, если *s* имеет некорректное дополнение или если во входных данных присутствуют неалфавитные символы.7879#### `base64.b32hexencode(s)`8081Аналогично [`b32encode()`](https://python-all.ru/3.12/library/base64.html#base64.b32encode), но использует расширенный шестнадцатеричный алфавит, как определено в [**RFC 4648**](https://python-all.ru/3.12/library/base64.html).8283Добавлено в версии 3.10.8485#### `base64.b32hexdecode(s, casefold=False)`8687Аналогично [`b32decode()`](https://python-all.ru/3.12/library/base64.html#base64.b32decode), но использует расширенный шестнадцатеричный алфавит, как определено в [**RFC 4648**](https://python-all.ru/3.12/library/base64.html).8889Эта версия не допускает отображения цифры 0 (ноль) на букву O (о) и цифры 1 (один) на букву I (ай) или L (эль); все эти символы входят в расширенный шестнадцатеричный алфавит и не являются взаимозаменяемыми.9091Добавлено в версии 3.10.9293#### `base64.b16encode(s)`9495Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s* с помощью Base16 и возвращает закодированные [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).9697#### `base64.b16decode(s, casefold=False)`9899Декодирует закодированный Base16 [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или ASCII-строку *s* и возвращает декодированные [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).100101Необязательный флаг *casefold* указывает, допускается ли строчный алфавит на входе. Из соображений безопасности по умолчанию используется `False`.102103Исключение [`binascii.Error`](https://python-all.ru/3.12/library/binascii.html#binascii.Error) возникает, если *s* имеет некорректное дополнение или если во входных данных присутствуют неалфавитные символы.104105#### `base64.a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)`106107Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *b* с помощью Ascii85 и возвращает закодированные [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).108109*foldspaces* – необязательный флаг, который использует специальную короткую последовательность 'y' вместо 4 последовательных пробелов (ASCII 0x20), как поддерживается в 'btoa'. Эта возможность не поддерживается «стандартной» кодировкой Ascii85.110111*wrapcol* управляет добавлением в выходные данные символов новой строки (`b'\n'`). Если это значение не равно нулю, каждая выходная строка будет длиной не более этого количества символов, не считая завершающей новой строки.112113*pad* управляет тем, дополняются ли входные данные до кратного 4 перед кодированием. Обратите внимание, что реализация `btoa` всегда выполняет дополнение.114115*adobe* управляет тем, обрамляется ли закодированная последовательность байтов `<~` и `~>`, что используется в реализации Adobe.116117Добавлено в версии 3.4.118119#### `base64.a85decode(b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')`120121Декодирует Ascii85-закодированный [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или ASCII-строку *b* и возвращает декодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).122123*foldspaces* – это флаг, указывающий, следует ли принимать короткую последовательность 'y' в качестве сокращения для 4 последовательных пробелов (ASCII 0x20). Эта возможность не поддерживается «стандартной» кодировкой Ascii85.124125*adobe* управляет тем, находится ли входная последовательность в формате Adobe Ascii85 (т.е. обрамляется с помощью \<~ и ~\>).126127*ignorechars* должен быть [байтоподобным объектом](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или строкой ASCII, содержащей символы, которые следует игнорировать во входных данных. Должен содержать только пробельные символы; по умолчанию содержит все пробельные символы ASCII.128129Добавлено в версии 3.4.130131#### `base64.b85encode(b, pad=False)`132133Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *b* с помощью base85 (используется, например, в двоичных diff-файлах в стиле git) и возвращает закодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).134135Если *pad* истинно, входные данные дополняются `b'\0'` так, чтобы их длина была кратна 4 байтам перед кодированием.136137Добавлено в версии 3.4.138139#### `base64.b85decode(b)`140141Декодирует закодированный в base85 [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) или строку ASCII *b* и возвращает декодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Дополнение неявно удаляется при необходимости.142143Добавлено в версии 3.4.144145Устаревший интерфейс:146147#### `base64.decode(input, output)`148149Декодирует содержимое бинарного файла *input* и записывает полученные бинарные данные в файл *output*. *input* и *output* должны быть [файловыми объектами](https://python-all.ru/3.12/glossary.html#term-file-object). *input* будет читаться до тех пор, пока `input.readline()` не вернёт пустой bytes-объект.150151#### `base64.decodebytes(s)`152153Декодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s*, который должен содержать одну или несколько строк данных, закодированных в base64, и возвращает декодированный [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).154155Добавлено в версии 3.1.156157#### `base64.encode(input, output)`158159Кодирует содержимое бинарного файла *input* и записывает полученные данные в кодировке base64 в файл *output*. *input* и *output* должны быть [файловыми объектами](https://python-all.ru/3.12/glossary.html#term-file-object). *input* будет читаться до тех пор, пока `input.read()` не вернёт пустой bytes-объект. [`encode()`](https://python-all.ru/3.12/library/base64.html#base64.encode) вставляет символ новой строки (`b'\n'`) после каждых 76 байт выходных данных, а также гарантирует, что выходные данные всегда заканчиваются новой строкой, в соответствии с [**RFC 2045**](https://python-all.ru/3.12/library/base64.html) (MIME).160161#### `base64.encodebytes(s)`162163Кодирует [байтоподобный объект](https://python-all.ru/3.12/glossary.html#term-bytes-like-object) *s*, который может содержать произвольные бинарные данные, и возвращает [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes), содержащее данные в кодировке base64, с символами новой строки (`b'\n'`), вставляемыми после каждых 76 байт выходных данных, и гарантирует наличие завершающего перевода строки в соответствии с [**RFC 2045**](https://python-all.ru/3.12/library/base64.html) (MIME).164165Добавлено в версии 3.1.166167Пример использования модуля:168169```python170>>> import base64171>>> encoded = base64.b64encode(b'data to be encoded')172>>> encoded173b'ZGF0YSB0byBiZSBlbmNvZGVk'174>>> data = base64.b64decode(encoded)175>>> data176b'data to be encoded'177```178179## Вопросы безопасности180181Новый раздел по вопросам безопасности был добавлен в [**RFC 4648**](https://python-all.ru/3.12/library/base64.html) (раздел 12); рекомендуется ознакомиться с разделом безопасности для любого кода, развёртываемого в рабочей среде.182183> **См. также**184>185> **Модуль [`binascii`](https://python-all.ru/3.12/library/binascii.html#module-binascii)**186>187> Вспомогательный модуль, содержащий преобразования ASCII-в-двоичный и двоичный-в-ASCII.188>189> **[**RFC 1521**](https://python-all.ru/3.12/library/base64.html) – MIME (Многоцелевые расширения интернет-почты) Часть 1: Механизмы указания и описания формата тел интернет-сообщений**190>191> Раздел 5.2, «Base64 Content-Transfer-Encoding», содержит определение кодировки base64.192