Python 标准类库-因特网数据处理之Base64数据编码

2023-05-28 10:28 由授客发表于 #后端开发

该模块提供将二进制数据编码为可打印ASCII字符并将这种编码解码回二进制数据的功能。它为RFC 3548中指定的编码提供编码和解码功能。定义了Base16、Base32和Base64算法，以及事实上的标准Ascii85和Base85编码。

RFC 3548 编码适用于对二进制数据进行编码，以便可以安全地通过电子邮件发送，用作URL的一部分，或作为HTTP POST请求的一部分。编码算法与uuencode程序不同。

该模块提供了两个接口。现代接口支持将字节类对象(bytes-like-objects)编码为ASCII字节，并将字节类对象或者包含ASCII的字符串转为字节。支持 RFC 3548 中定义的所有base64字母表。

遗留接口不支持从字符串解码，但它提供了与文件类对象之间的编码和解码功能。它只支持Base64标准字母表，并根据RFC 2045每76个字符添加换行符。

Python 3.3版本中变更：现代接口的解码功能所接受只有ASCII的Unicode字符串。

Python 3.4版本中变更：该模块中的所有编码和解码功能所接受任何字节类对象。增加了Ascii85/Base85支持。

现代接口

base64.b64encode(s, altchars=None)

使用Base64对字节类对象 s进行编码，并返回编码后的字节。

altchars 可选参数，必须是长度至少为2的字节类对象（多余的字符会被忽略），参数中给定字符按序分别用于替换编码后的字符集中的+和/，等价于使用base64.urlsafe_b64encode(s) 。这允许应用程序生成例如URL或文件系统安全的Base64字符串。默认值为None，使用标准的Base64字母表。
base64.b64decode(s, altchars=None, validate=False)

解码Base64编码的字节类对象或ASCII字符串 s，并返回解码后的字节。

altchars 可选参数，必须是字节类对象或长度至少为2的ASCII字符串（多余的字符会被忽略），按序分别用于替换解码前s中与+, /的替代字符为+和/，等价于base64.urlsafe_b64decode(s) 。如果未正确提供 s 值，将引发binascii.Error异常。

validate 如果为False（默认值），则在填充检查前，将丢弃既不在标准 Base64 字母表之中也不在备用字母表中的字符。如果为True，这些非base64字符将导致binascii.Error。
base64.standard_b64encode(s)

使用标准Base64字母表对字节类对象 s 进行编码，并返回编码后的字节
base64.standard_b64decode(s)

使用标准Base64字母表对字节类对象 s 进行解码，并返回解码后的字节
base64.urlsafe_b64encode(s)

使用 URL 与文件系统安全的字母表编码字节类对象s，使用 - 以及 _ 分别代替标准 Base64 字母表中的 + 和 /。返回编码后的字节。结果中可能包含 =。
base64.urlsafe_b64decode(s)

使用 URL 与文件系统安全的字母表解码字节类对象 s，使用 - 以及 _ 分别代替标准 Base64 字母表中的 + 和 /。返回解码后的字节。
查看参考官方文档，获取更多现代接口

示例

#!/usr/bin/env python
# -*- coding:utf-8 -*-

import base64

str = 'param1=a>2&url=http://www.example.com/?type=1'
byte_obj = str.encode()
# print(byte_obj) # 输出：b'param1=a>2&url=http://www.example.com/?type=1'
print(base64.b64encode(byte_obj))
#输出：b'cGFyYW0xPWE+MiZ1cmw9aHR0cDovL3d3dy5leGFtcGxlLmNvbS8/dHlwZT0x'

encoded_obj = base64.b64encode(byte_obj, altchars=b'-_')
print(encoded_obj)
#输出：b'cGFyYW0xPWE-MiZ1cmw9aHR0cDovL3d3dy5leGFtcGxlLmNvbS8_dHlwZT0x'

print(base64.b64decode(encoded_obj, altchars=b'-_'))
#输出：b'param1=a>2&url=http://www.example.com/?type=1'
#print(base64.b64decode(encoded_obj))
#报错 binascii.Error: Incorrect padding

print(base64.b64decode(str)) # 输出：b'\xa5\xaa\xda\x9bV\xb6\xba\xb9'


str2 = 'hello Mr授客'
byte_obj2 = str2.encode('utf-8')
encoded_obj2 = base64.standard_b64encode(byte_obj2)
print(encoded_obj2) # 输出：b'aGVsbG8gTXLmjojlrqI='
print(base64.standard_b64decode(encoded_obj2).decode('utf-8')) # 输出：hello Mr授客


encoded_obj3 = base64.urlsafe_b64encode(byte_obj)
print(encoded_obj3)
#输出：b'cGFyYW0xPWE-MiZ1cmw9aHR0cDovL3d3dy5leGFtcGxlLmNvbS8_dHlwZT0x'

print(base64.urlsafe_b64decode(encoded_obj3))
#输出：b'param1=a>2&url=http://www.example.com/?type=1'

历史接口

base64.decode(input, output)

解码二进制input文件的内容，并将生成的二进制数据写入output文件。input和output必须是文件类对象。input将被读取，直到input.readline()”返回一个空字节对象。
base64.decodebytes(s)

解码字节类型对象s，s必须包含一行或多行base64编码的数据，并返回解码后的字节。3.1版新增。
base64.decodestring(s)

decodebytes()的别名，3.1版本中废弃。
base64.encode(input, output)

对二进制input文件的内容进行编码，并将生成的base64编码数据写入output文件。input和output必须是文件类对象。input将被读取，直到input.read()返回一个空字节对象。base64.encode()在output的每76个字节后插入一个换行符（b'\n'），并确保output始终以换行结束，如RFC 2045 所示（MIME）。
base64.encodebytes(s)

对可以包含任意二进制数据的字节类对象 s 进行编码，并返回包含base64编码的字节数据。base64.encode()在输出的每76个字节后插入一个换行符(b'\n')，并确保输出始终以换行结束。

版本3.1中新增
base64.encodestring(s)

encodebytes()别名，版本3.1中废弃。

示例

#!/usr/bin/env python
# -*- coding:utf-8 -*-

import base64

# 注意：必须以二进制文件打开、写文件，否则会报错
with open('./input.txt', 'rb') as input:
    with open('output.txt', 'wb') as output:
        base64.encode(input, output)
        
base64_byte_data = b'cGFyYW0xPWE+MiZ1cmw9aHR0cDovL3d3dy5leGFtcGxlLmNvbS8/dHlwZT0x'
print(base64.decodebytes(base64_byte_data))
#输出：b'param1=a>2&url=http://www.example.com/?type=1'

print(base64.encodebytes(b'param1=a>2&url=http://www.example.com/?type=1'))
#输出：b'cGFyYW0xPWE+MiZ1cmw9aHR0cDovL3d3dy5leGFtcGxlLmNvbS8/dHlwZT0x\n'