obstruct 0.2.2__tar.gz → 0.2.3__tar.gz

{obstruct-0.2.2 → obstruct-0.2.3}/.idea/workspace.xml

@@ -6,10 +6,12 @@
   <component name="ChangeListManager">
     <list default="true" id="b482b6b4-48ce-4be1-bf3c-a72ec254fa35" name="更改" comment="initial commit">
       <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/obstruct/__version__.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/__version__.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/src/obstruct/aot/base.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/aot/base.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/src/obstruct/aot/unpack.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/aot/unpack.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/src/obstruct/decorator.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/decorator.py" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/src/obstruct/methods.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/methods.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/obstruct/types/types.pyi" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/types/types.pyi" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/uv.lock" beforeDir="false" afterPath="$PROJECT_DIR$/uv.lock" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />

{obstruct-0.2.2 → obstruct-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: obstruct
-Version: 0.2.2
+Version: 0.2.3
 Author-email: LittleNightSong <LittleNightSongYO@outlook.com>
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python
@@ -20,16 +20,31 @@ _来自已弃坑的 `Hydrogenlib`，重拾起当初的决心_
 >
 > 同时，`HydrogenLib`中的 `Objective-Struct` 不再会更新
 
+>[!TIP]
+> 作者的主要开发精力放在了另一些项目上，也许很长时间这个项目都不会再更新
 
 # OBStruct
 _一个简单、纯粹、极速的二进制解析库_
 
 ## 亮点
+- 纯 Python
 - 基于类型注解的字段声明方式
 - 支持 `struct` 标准库中的所有格式，并额外支持 array 类型
 - 基于 AOT 的加速
 - 完整的操作支持（打包、解包、流式处理）
 
+>[!WARNING]
+>使用 `array` 类型将带来严重的性能损失，谨慎使用
+
+## 基准测试
+### 系统环境
+- 12th Gen Intel® Core(TM) i7-12700H
+
+在 12个字段，10000 次操作，8轮取平均值的条件下：
+- 打包：269.639ns 一次操作
+- 解包：582.185ns 一次操作
+
+
 ## 安装
 ```commandline
 pip install obstruct
@@ -67,10 +82,11 @@ if __name__ == '__main__':
 
 ```
 
-在上述示例中，你可能发现 `data != restored`，这是浮点数的精度限制导致的
-一般来说，我们不建议使用浮点数类型
+在上述示例中，你可能发现 `data != restored`，这是浮点数的精度限制导致的。
+因此，我们不建议使用浮点数类型，浮点数在二进制传输中也不常见。
 
 ## 计划
 - 展平装饰器，目前的 API 较为繁琐，需要简化为唯一的 `Struct` 基类
 - 继续优化性能
 - 通过存根文件强制表明类型似乎变得不再有效了
+- 支持 Tag 联合类型，对标 `msgspec`

{obstruct-0.2.2 → obstruct-0.2.3}/README.md

@@ -6,16 +6,31 @@ _来自已弃坑的 `Hydrogenlib`，重拾起当初的决心_
 >
 > 同时，`HydrogenLib`中的 `Objective-Struct` 不再会更新
 
+>[!TIP]
+> 作者的主要开发精力放在了另一些项目上，也许很长时间这个项目都不会再更新
 
 # OBStruct
 _一个简单、纯粹、极速的二进制解析库_
 
 ## 亮点
+- 纯 Python
 - 基于类型注解的字段声明方式
 - 支持 `struct` 标准库中的所有格式，并额外支持 array 类型
 - 基于 AOT 的加速
 - 完整的操作支持（打包、解包、流式处理）
 
+>[!WARNING]
+>使用 `array` 类型将带来严重的性能损失，谨慎使用
+
+## 基准测试
+### 系统环境
+- 12th Gen Intel® Core(TM) i7-12700H
+
+在 12个字段，10000 次操作，8轮取平均值的条件下：
+- 打包：269.639ns 一次操作
+- 解包：582.185ns 一次操作
+
+
 ## 安装
 ```commandline
 pip install obstruct
@@ -53,10 +68,11 @@ if __name__ == '__main__':
 
 ```
 
-在上述示例中，你可能发现 `data != restored`，这是浮点数的精度限制导致的
-一般来说，我们不建议使用浮点数类型
+在上述示例中，你可能发现 `data != restored`，这是浮点数的精度限制导致的。
+因此，我们不建议使用浮点数类型，浮点数在二进制传输中也不常见。
 
 ## 计划
 - 展平装饰器，目前的 API 较为繁琐，需要简化为唯一的 `Struct` 基类
 - 继续优化性能
 - 通过存根文件强制表明类型似乎变得不再有效了
+- 支持 Tag 联合类型，对标 `msgspec`

obstruct-0.2.3/src/obstruct/__version__.py

@@ -0,0 +1 @@
+version = "0.2.3"

{obstruct-0.2.2 → obstruct-0.2.3}/test/test_speed.py

@@ -34,14 +34,15 @@ def test_timeit(name, code):
     import timeit
 
     print("Test: ", name)
-    res = timeit.timeit(
+    res = timeit.repeat(
         code,
         number=NUMBER,
+        repeat=8,
         timer=time.perf_counter_ns,
         globals=globals()
     )
-    print(f'{NUMBER} steps finished in {res:.3f} ns')
-    print(f'Average: {res/NUMBER:.3f} ns per step', '\n\n')
+    print(f'{NUMBER} steps finished in {sum(res)/8:.3f} ns')
+    print(f'Average: {sum(res)/8/NUMBER:.3f} ns per step', '\n\n')
 
 
 NUMBER = 10000

obstruct-0.2.2/src/obstruct/__version__.py

@@ -1 +0,0 @@
-version = "0.2.2"