cobs 1.2.0

介绍

提供了cobs包，其中包含包含根据 COBS 方法进行编码和解码的功能的模块。

提供的模块

“ Consistent Overhead Byte Stuffing–Reduced ” ( COBS/R ) 是我自己的发明，是对基本 COBS 编码的修改，下面将更详细地描述。

以下内容未实施：

提供了一个纯 Python 实现和一个 C 扩展实现。如果 C 扩展由于某种原因不可用，将使用纯 Python 版本。

用法

这些模块提供编码和解码功能。

输入应该是字节字符串，而不是 Unicode 字符串。基本用法：

>>> from cobs import cobs
>>> encoded = cobs.encode(b'Hello world\x00This is a test')
>>> encoded
b'\x0cHello world\x0fThis is a test'
>>> cobs.decode(encoded)
b'Hello world\x00This is a test'

COBS/R用法几乎相同：

>>> from cobs import cobsr
>>> encoded = cobsr.encode(b'Hello world\x00This is a test')
>>> encoded
b'\x0cHello worldtThis is a tes'
>>> cobsr.decode(encoded)
b'Hello world\x00This is a test'

任何实现缓冲区协议的类型，提供单个字节块，也可以作为输入：

>>> from cobs import cobs
>>> encoded = cobs.encode(bytearray(b'Hello world\x00This is a test'))
>>> encoded
b'\x0cHello world\x0fThis is a test'
>>> cobs.decode(encoded)
b'Hello world\x00This is a test'

支持的 Python 版本

支持 Python >= 3.6，并且具有 C 扩展和纯 Python 实现。

Python 版本 < 3.6 可能有效，但尚未经过测试。

安装

cob 包是使用distutils安装的。如果您安装了构建 Python 扩展模块的工具，请运行以下命令：

python setup.py install

如果您无法构建 C 扩展，您可以使用以下命令仅安装纯 Python 实现：

python setup.py build_py install --skip-build

单元测试

基本单元测试在测试子模块中，例如cob.cobs.test。要运行它：

python -m cobs.cobs.test
python -m cobs.cobsr.test

文档

文档是用 Sphinx 编写的。源文件在doc 目录中提供。它可以使用 Sphinx 0.6.5 构建。它使用pngmath Sphinx 扩展，需要安装 Latex 和dvipng。

该文档可在线获取：http ://packages.python.org/cobs/

执照

该代码是在 MIT 许可下发布的。有关详细信息，请参阅 LICENSE.txt。

一致的开销字节填充 - 减少 (COBS/R)

cobs.cobr模块中提供了对 COBS 的修改，我称之为“一致的开销字节填充减少”（COBS/R） 。它的目的是在某些情况下从编码形式中保存一个字节。普通 COBS 编码总是有 +1 字节的编码开销。有关详细信息，请参阅参考资料[ 1 ]。COBS/R 通常可以避免 +1 字节，如果它主要是被编码的小消息，这可能是一个有用的节省。

在普通 COBS 中，消息中的最后一个长度代码字节具有一些固有的冗余：如果它大于剩余字节数，则将其检测为错误。

在 COBS/R 中，每当最终数据字节的值大于或等于最终长度值通常的值时，我们机会主义地将最终长度代码字节替换为最终数据字节。这种变化可以被明确解码：解码器注意到长度代码大于剩余字节数。