obstruct 0.2.11__tar.gz → 0.2.13__tar.gz

{obstruct-0.2.11 → obstruct-0.2.13}/.idea/workspace.xml

@@ -4,11 +4,7 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="b482b6b4-48ce-4be1-bf3c-a72ec254fa35" name="更改" comment="fix: 修复 slots 的生成逻辑">
-      <change afterPath="$PROJECT_DIR$/src/obstruct/metadata_marks.py" 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/struct_type.py" beforeDir="false" afterPath="$PROJECT_DIR$/src/obstruct/struct_type.py" afterDir="false" />
-    </list>
+    <list default="true" id="b482b6b4-48ce-4be1-bf3c-a72ec254fa35" name="更改" comment="chore: 更新项目信息和 README 文档" />
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
@@ -232,7 +228,31 @@
       <option name="project" value="LOCAL" />
       <updated>1786966736535</updated>
     </task>
-    <option name="localTasksCounter" value="13" />
+    <task id="LOCAL-00013" summary="feat: 更新版本号（跳过一次版本号更改），添加 NOT_A_FIELD 标记控制一个字段是否该被当作二进制字段解析">
+      <option name="closed" value="true" />
+      <created>1786968425494</created>
+      <option name="number" value="00013" />
+      <option name="presentableId" value="LOCAL-00013" />
+      <option name="project" value="LOCAL" />
+      <updated>1786968425494</updated>
+    </task>
+    <task id="LOCAL-00014" summary="feat: 更新版本号，添加一些更加清晰明确的类型别名">
+      <option name="closed" value="true" />
+      <created>1786969304874</created>
+      <option name="number" value="00014" />
+      <option name="presentableId" value="LOCAL-00014" />
+      <option name="project" value="LOCAL" />
+      <updated>1786969304874</updated>
+    </task>
+    <task id="LOCAL-00015" summary="chore: 更新项目信息和 README 文档">
+      <option name="closed" value="true" />
+      <created>1786969506672</created>
+      <option name="number" value="00015" />
+      <option name="presentableId" value="LOCAL-00015" />
+      <option name="project" value="LOCAL" />
+      <updated>1786969506672</updated>
+    </task>
+    <option name="localTasksCounter" value="16" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -262,6 +282,9 @@
     <MESSAGE value="修复：unpack.py 中没有移除的调试逻辑&#10;更新版本号至 0.2.8" />
     <MESSAGE value="chore: 移除 test_speed.py 中的调试逻辑" />
     <MESSAGE value="fix: 修复 slots 的生成逻辑" />
-    <option name="LAST_COMMIT_MESSAGE" value="fix: 修复 slots 的生成逻辑" />
+    <MESSAGE value="feat: 更新版本号（跳过一次版本号更改），添加 NOT_A_FIELD 标记控制一个字段是否该被当作二进制字段解析" />
+    <MESSAGE value="feat: 更新版本号，添加一些更加清晰明确的类型别名" />
+    <MESSAGE value="chore: 更新项目信息和 README 文档" />
+    <option name="LAST_COMMIT_MESSAGE" value="chore: 更新项目信息和 README 文档" />
   </component>
 </project>

{obstruct-0.2.11 → obstruct-0.2.13}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.5
 Name: obstruct
-Version: 0.2.11
+Version: 0.2.13
 Author-email: LittleNightSong <LittleNightSongYO@outlook.com>
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.12
@@ -16,7 +16,7 @@ _来自已弃坑的 `Hydrogenlib`，重拾起当初的决心_
 
 
 > [!TIP]
-> 这个项目来自 [`HydrogenLib`](https://github.com/LittleNightSong/HydrogenLib)的 `Objective-Struct` 模块，脱离大项目的版本
+> 这个项目来自 [`HydrogenLib`](https://github.com/LittleNightSong/HydrogenLib)的 `Objective-Struct` 模块，是一个脱离大项目的版本
 >
 > 同时，`HydrogenLib`中的 `Objective-Struct` 不再会更新
 
@@ -36,7 +36,7 @@ _一个简单、纯粹、极速的二进制解析库_
 - 完整的操作支持（打包、解包、流式处理）
 
 > [!WARNING]
->使用 `array` 类型时，建议不要传入 list 类型或其它 Python 序列，
+> 使用 `array` 类型时，建议不要传入 list 类型或其它 Python 序列，
 > 可能会带来极大的性能影响
 
 ## 基准测试
@@ -67,7 +67,6 @@ import obstruct as obs
 from dataclasses import dataclass
 
 
-@obs.struct()
 @dataclass()
 class MyStruct(obs.Struct):
     a: int
@@ -89,6 +88,9 @@ if __name__ == '__main__':
 
 ```
 
+> [!WARNING]
+> 不要在 dataclass 装饰器中使用 `slots=True`，`Struct` 元类已为类型添加了 `__slots__`
+
 在上述示例中，你可能发现 `data != restored`，这是浮点数的精度限制导致的。 因此，我们不建议使用浮点数类型，浮点数在二进制传输中也不常见。
 
 ## 计划

{obstruct-0.2.11 → obstruct-0.2.13}/README.md

@@ -2,7 +2,7 @@ _来自已弃坑的 `Hydrogenlib`，重拾起当初的决心_
 
 
 > [!TIP]
-> 这个项目来自 [`HydrogenLib`](https://github.com/LittleNightSong/HydrogenLib)的 `Objective-Struct` 模块，脱离大项目的版本
+> 这个项目来自 [`HydrogenLib`](https://github.com/LittleNightSong/HydrogenLib)的 `Objective-Struct` 模块，是一个脱离大项目的版本
 >
 > 同时，`HydrogenLib`中的 `Objective-Struct` 不再会更新
 
@@ -22,7 +22,7 @@ _一个简单、纯粹、极速的二进制解析库_
 - 完整的操作支持（打包、解包、流式处理）
 
 > [!WARNING]
->使用 `array` 类型时，建议不要传入 list 类型或其它 Python 序列，
+> 使用 `array` 类型时，建议不要传入 list 类型或其它 Python 序列，
 > 可能会带来极大的性能影响
 
 ## 基准测试
@@ -53,7 +53,6 @@ import obstruct as obs
 from dataclasses import dataclass
 
 
-@obs.struct()
 @dataclass()
 class MyStruct(obs.Struct):
     a: int
@@ -75,6 +74,9 @@ if __name__ == '__main__':
 
 ```
 
+> [!WARNING]
+> 不要在 dataclass 装饰器中使用 `slots=True`，`Struct` 元类已为类型添加了 `__slots__`
+
 在上述示例中，你可能发现 `data != restored`，这是浮点数的精度限制导致的。 因此，我们不建议使用浮点数类型，浮点数在二进制传输中也不常见。
 
 ## 计划

{obstruct-0.2.11 → obstruct-0.2.13}/pyproject.toml

@@ -9,7 +9,15 @@ description = ''
 readme = "README.md"
 requires-python = ">=3.12"
 keywords = []
-classifiers = ["Development Status :: 3 - Alpha", "Programming Language :: Python", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy"
+]
 dependencies = []
 
 [[project.authors]]

obstruct-0.2.13/src/obstruct/__init__.py

@@ -0,0 +1,19 @@
+from .methods import pack, unpack
+from .struct_type import Struct
+from .types import *
+from .metadata_marks import Marks
+
+# 定义一些清晰的类型别名
+
+byte = signed_char
+ubyte = unsigned_char
+
+i8 = signed_char
+i16 = short
+i32 = int
+i64 = long
+
+u8 = unsigned_char
+u16 = unsigned_short
+u32 = unsigned_int
+u64 = unsigned_long

obstruct-0.2.13/src/obstruct/__version__.py

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

{obstruct-0.2.11 → obstruct-0.2.13}/src/obstruct/struct_type.py

@@ -46,6 +46,7 @@ class StructMeta(type):
             )
 
         slots |= {k for k in annotations.keys()}
+        slots -= cls.__struct_methods__
 
         attrs['__slots__'] = slots
         attrs['__cendian__'] = endian

obstruct-0.2.11/src/obstruct/__init__.py

@@ -1,4 +0,0 @@
-from .methods import pack, unpack
-from .struct_type import Struct
-from .types import *
-from .metadata_marks import Marks

obstruct-0.2.11/src/obstruct/__version__.py

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