来自已弃坑的 Hydrogenlib,重拾起当初的决心
[!TIP] 这个项目来自
HydrogenLib的Objective-Struct模块,脱离大项目的版本同时,
HydrogenLib中的Objective-Struct不再会更新
[!TIP] 作者的主要开发精力放在了另一些项目上,也许很长时间这个项目都不会再更新
OBStruct
一个简单、纯粹、极速的二进制解析库
亮点
- 纯 Python
- 基于类型注解的字段声明方式
- 支持
struct标准库中的所有格式,并额外支持 array 类型 - 基于 AOT 的加速
- 完整的操作支持(打包、解包、流式处理)
[!WARNING] 使用
array类型时,建议不要传入 list 类型或其它 Python 序列, 可能会带来极大的性能影响
基准测试
系统环境
- 12th Gen Intel® Core (TM) i7-12700H
在 12个字段,10000 次操作,8轮取平均值的条件下:
- 打包:269.639ns 一次操作
- 解包:582.185ns 一次操作
安装
pip install obstruct
如果使用 uv 等包管理器,则按照工具的方法安装即可
用法
首先声明一个 Struct 类型,它是一个 dataclass,也是一个 struct
import obstruct as obs
from dataclasses import dataclass
@obs.struct()
@dataclass()
class MyStruct(obs.Struct):
a: int
b: float
c: obs.long
d: obs.unsigned_short
if __name__ == '__main__':
data = MyStruct(a=0, b=2.0, c=10000, d=14545)
packed_data = data.pack()
print(packed_data)
restored = MyStruct.unpack(packed_data)
print(restored)
print(data == restored)
在上述示例中,你可能发现 data != restored,这是浮点数的精度限制导致的。 因此,我们不建议使用浮点数类型,浮点数在二进制传输中也不常见。
计划
- 展平装饰器,目前的 API 较为繁琐,需要简化为唯一的
Struct基类 - 继续优化性能
- 通过存根文件强制表明类型似乎变得不再有效了
- 支持 Tag 联合类型,对标
msgspec
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file obstruct-0.2.10.tar.gz.
File metadata
- Download URL: obstruct-0.2.10.tar.gz
- Upload date:
- Size: 40.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
40737d61d74f832fb16664323e66535d9ea43c8c00db74951bad4b3a33e2caa4
|
|
| MD5 |
908498e215d6d5aef41583dbe5c331d1
|
|
| BLAKE2b-256 |
bbb46257b313263bce672d2bfb8062940a182b4cdf19d2a437c76ca7e5505e26
|
File details
Details for the file obstruct-0.2.10-py3-none-any.whl.
File metadata
- Download URL: obstruct-0.2.10-py3-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
90f01aa96600b3cd0d2827c892af0aed0af9cb70cd01088eabfbde67400dc57b
|
|
| MD5 |
aff3a821c1c1c7326a8403496570360c
|
|
| BLAKE2b-256 |
a5ccb6a4dce1622830ce721f4c1c21c8311b55522e58abd9498df724b27e4039
|