二进制数据服务模块之codecs – 编解码器注册表和基类(19) – Python语言(必读进阶学习教程)(参考资料)

IncrementalEncoder对象

的IncrementalEncoder类是用于在多个步骤中编码的输入。它定义了以下方法，每个增量编码器必须定义这些方法才能与Python编解码器注册表兼容。

class codecs.IncrementalEncoder(errors=’strict’)

IncrementalEncoder实例的构造函数。

所有增量编码器都必须提供此构造函数接口。他们可以自由添加其他关键字参数，但Python编解码器注册表只使用此处定义的参数。

该IncrementalEncoder可以通过提供实现不同的错误处理方案的错误关键字参数。有关可能的值，请参见错误处理程序

该错误参数将被分配到相同名称的属性。分配给此属性可以在IncrementalEncoder 对象的生命周期内切换不同的错误处理策略。

encode(object[, final])

编码对象（考虑编码器的当前状态）并返回结果编码对象。如果这是对final的最后一次调用 必须为true（默认为false）。encode()

reset()

将编码器重置为初始状态。输出被丢弃：调用 ，必要时传递空字节或文本字符串，以重置编码器并获得输出。.encode(object, final=True)

getstate()

返回编码器的当前状态，该状态必须是整数。实施应该确保这0是最常见的状态。（比整数更复杂的状态可以通过编组/选择状态并将结果字符串的字节编码为整数来转换为整数）。

setstate(state)

将编码器的状态设置为state。state必须是返回的编码器状态getstate()。

IncrementalDecoder对象

的IncrementalDecoder类是用于在多个步骤中进行解码的输入。它定义了以下方法，每个增量解码器必须定义这些方法才能与Python编解码器注册表兼容。

class codecs.IncrementalDecoder(errors=’strict’)

IncrementalDecoder实例的构造函数。

所有增量解码器都必须提供此构造函数接口。他们可以自由添加其他关键字参数，但Python编解码器注册表只使用此处定义的参数。

该IncrementalDecoder可以通过提供实现不同的错误处理方案的错误关键字参数。有关可能的值，请参见错误处理程序

该错误参数将被分配到相同名称的属性。分配给此属性可以在IncrementalDecoder 对象的生命周期内切换不同的错误处理策略。

decode(object[, final])

解码对象（考虑解码器的当前状态）并返回结果解码对象。 如果这是最后一次调用 decode() final 必须为真（默认为假）。 如果 final 为真，则解码器必须完全解码输入并且必须刷新所有缓冲区。 如果这是不可能的（例如，由于输入末尾的字节序列不完整），它必须像在无状态情况下一样启动错误处理（这可能会引发异常）。

reset()

将解码器重置为初始状态。

getstate()

返回解码器的当前状态。这必须是包含两个项的元组，第一个必须是包含仍然未解码的输入的缓冲区。第二个必须是整数，可以是其他状态信息。（实现应该确保这0是最常见的附加状态信息。）如果这个额外的状态信息是0必须可以将解码器设置为没有输入缓冲0的状态和 作为附加状态信息，以便以前提供缓冲输入到解码器将其返回到先前的状态而不产生任何输出。（通过编组/选取信息并将结果字符串的字节编码为整数，可以将比整数更复杂的附加状态信息转换为整数。）

setstate(state)

将编码器的状态设置为state。state必须是返回的解码器状态getstate()。

StreamWriter对象

StreamWriter 和 StreamReader 类提供了通用的工作接口，可以很容易地用于实现新的编码子模块。 有关如何完成此操作的示例，请参见 encodings.utf_8。

class codecs.StreamWriter(stream, errors=’strict’)

StreamWriter实例的构造函数。

所有流编写器都必须提供此构造函数接口。他们可以自由添加其他关键字参数，但Python编解码器注册表只使用此处定义的参数。

该流参数必须是一个类似文件的对象打开用于写入文本或二进制数据，以适合特定的编解码器。

该StreamWriter可以通过提供实现不同的错误处理方案的错误关键字参数。请参见错误处理程序的标准错误处理的基本流编解码器可支持。

该错误参数将被分配到相同名称的属性。分配给此属性可以在StreamWriter对象的生命周期内切换不同的错误处理策略。

write(object)

将对象的内容编码写入流。

writelines(list)

将串联的字符串列表写入流（可能通过重用该write()方法）。标准的字节到字节编解码器不支持此方法。

reset()

刷新并重置用于保持状态的编解码器缓冲区。

调用此方法应确保输出上的数据处于干净状态，允许附加新的新数据，而无需重新扫描整个流以恢复状态。

除了上述方法之外，StreamWriter还必须从基础流继承所有其他方法和属性。

StreamReader对象

StreamReader 类是 Codec 的子类，它定义了每个流读取器必须定义的以下方法，以便与 Python 编解码器注册表兼容。

class codecs.StreamReader(stream, errors=’strict’)

StreamReader实例的构造函数。

所有流读取器都必须提供此构造函数接口。他们可以自由添加其他关键字参数，但Python编解码器注册表只使用此处定义的参数。

的流参数必须是一个类文件对象开放阅读文本或二进制数据，以适合特定的编解码器。

该StreamReader可以通过提供实现不同的错误处理方案的错误关键字参数。请参见错误处理程序的标准错误处理的基本流编解码器可支持。

该错误参数将被分配到相同名称的属性。分配给此属性可以在StreamReader对象的生命周期内切换不同的错误处理策略。

可以使用扩展errors参数 的允许值集register_error()。

read([size[, chars[, firstline]]])

解码流中的数据并返回结果对象。

该字符参数指示解码码点或字节返回的数量。该read()方法永远不会返回比请求数据更多的数据，但如果没有足够的可用数据，它可能会返回更少的数据。

所述尺寸参数指示来读取用于解码编码的字节或码点的近似最大数量。解码器可以适当地修改该设置。默认值-1表示尽可能读取和解码。此参数旨在防止必须一步解码大文件。

该FIRSTLINE标志表示，这将是足以只返回第一线，如果有对后世行解码错误。

该方法应该使用贪婪的读取策略，这意味着它应该读取编码定义和给定大小内允许的数据，例如，如果流上有可选的编码结尾或状态标记，则也应该读取这些数据。

readline([size[, keepends]])

从输入流中读取一行并返回解码数据。

size，如果给定，则作为size参数传递给stream的 read()方法。

如果keepends为false，则会从返回的行中删除行结尾。

readlines([sizehint[, keepends]])

读取输入流上的所有可用行并将其作为行列表返回。

行尾使用编解码器的解码器方法实现，如果keepends为true ，则包含在列表条目中。

sizehint，如果给定，则作为size参数传递给流的 read()方法。

reset()

重置用于保持状态的编解码器缓冲区。

请注意，不应进行流重新定位。该方法主要用于从解码错误中恢复。

除了上述方法之外，StreamReader还必须从基础流继承所有其他方法和属性。

StreamReaderWriter对象

这StreamReaderWriter是一个便利类，它允许包装在读写模式下工作的流。

设计是这样的，可以使用函数返回的工厂 lookup()函数来构造实例。

class codecs.StreamReaderWriter（stream，Reader，Writer，errors =’strict’ ）

创建一个StreamReaderWriter实例。stream必须是类文件对象。Reader和Writer必须是工厂函数或提供StreamReader和StreamWriter接口的类 。错误处理的方式与为流读取器和编写器定义的方式相同。

StreamReaderWriter实例定义StreamReader和StreamWriter类的组合接口 。它们从基础流继承所有其他方法和属性。

StreamRecoder对象

StreamReaderWriter 是一个便利类，它允许包装在读写模式下工作的流。

这种设计使得人们可以使用 lookup() 函数返回的工厂函数来构造实例。

class codecs.StreamRecoder(stream, Reader, Writer, errors=’strict’)

创建StreamRecoder一个实现双向转换的实例： 编码和解码工作，对前端-可见的代码调用数据read()和write()，而读者和作家 在后台工作-数据流。

您可以使用这些对象进行透明转码，例如Latin-1到UTF-8和返回。

该流参数必须是一个类似文件的对象。

该编码和解码参数必须坚持Codec接口。Reader和 Writer必须是工厂函数或分别提供StreamReader和StreamWriter接口对象的类 。

错误处理的方式与为流读取器和编写器定义的方式相同。

StreamRecoder实例定义StreamReader和StreamWriter类的组合接口 。它们从基础流继承所有其他方法和属性。