obstruct 0.2.1__tar.gz → 0.2.2__tar.gz

{obstruct-0.2.1 → obstruct-0.2.2}/.idea/Hydrogenlib-Objective-Struct.iml

@@ -5,7 +5,7 @@
       <sourceFolder url="file://$MODULE_DIR$/src" />
       <excludeFolder url="file://$MODULE_DIR$/.venv" />
     </content>
-    <orderEntry type="inheritedJdk" />
+    <orderEntry type="jdk" jdkName="E:\.projects\obstruct\.venv" jdkType="Python SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
   <component name="PackageRequirementsSettings" />

obstruct-0.2.2/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="E:\.projects\obstruct\.venv" project-jdk-type="Python SDK" />
+</project>

obstruct-0.2.2/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

obstruct-0.2.2/.idea/workspace.xml

@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <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/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$/uv.lock" beforeDir="false" afterPath="$PROJECT_DIR$/uv.lock" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Python Script" />
+      </list>
+    </option>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="GitHubPullRequestSearchHistory"><![CDATA[{
+  "lastFilter": {
+    "state": "OPEN",
+    "assignee": "LittleNightSong"
+  }
+}]]></component>
+  <component name="GithubPullRequestsUISettings"><![CDATA[{
+  "selectedUrlAndAccountId": {
+    "url": "https://github.com/LittleNightSong/obstruct.git",
+    "accountId": "c74c50b1-2437-429b-b395-d763b566b8a2"
+  }
+}]]></component>
+  <component name="ProjectColorInfo"><![CDATA[{
+  "associatedIndex": 3,
+  "fromUser": false
+}]]></component>
+  <component name="ProjectId" id="3HzAgHvw3X1T2NidzBlYQSHnZow" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "ModuleVcsDetector.initialDetectionPerformed": "true",
+    "Python.test.executor": "Run",
+    "Python.test_speed.executor": "Run",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "RunOnceActivity.typescript.service.memoryLimit.init": "true",
+    "codeWithMe.voiceChat.enabledByDefault": "false",
+    "git-widget-placeholder": "main",
+    "last_opened_file_path": "E:/.projects/obstruct",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.jshint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.jshint": "",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "npm"
+  }
+}]]></component>
+  <component name="RunManager" selected="Python.test_speed">
+    <configuration name="test" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+      <module name="Hydrogenlib-Objective-Struct" />
+      <option name="ENV_FILES" value="" />
+      <option name="INTERPRETER_OPTIONS" value="" />
+      <option name="PARENT_ENVS" value="true" />
+      <envs>
+        <env name="PYTHONUNBUFFERED" value="1" />
+      </envs>
+      <option name="SDK_HOME" value="" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/test" />
+      <option name="IS_MODULE_SDK" value="true" />
+      <option name="ADD_CONTENT_ROOTS" value="true" />
+      <option name="ADD_SOURCE_ROOTS" value="true" />
+      <option name="DEBUG_JUST_MY_CODE" value="false" />
+      <option name="RUN_TOOL" value="" />
+      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/test/test.py" />
+      <option name="PARAMETERS" value="" />
+      <option name="SHOW_COMMAND_LINE" value="false" />
+      <option name="EMULATE_TERMINAL" value="false" />
+      <option name="MODULE_MODE" value="false" />
+      <option name="REDIRECT_INPUT" value="false" />
+      <option name="INPUT_FILE" value="" />
+      <method v="2" />
+    </configuration>
+    <configuration name="test_speed" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
+      <module name="Hydrogenlib-Objective-Struct" />
+      <option name="ENV_FILES" value="" />
+      <option name="INTERPRETER_OPTIONS" value="" />
+      <option name="PARENT_ENVS" value="true" />
+      <envs>
+        <env name="PYTHONUNBUFFERED" value="1" />
+      </envs>
+      <option name="SDK_HOME" value="" />
+      <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/test" />
+      <option name="IS_MODULE_SDK" value="true" />
+      <option name="ADD_CONTENT_ROOTS" value="true" />
+      <option name="ADD_SOURCE_ROOTS" value="true" />
+      <option name="DEBUG_JUST_MY_CODE" value="false" />
+      <option name="RUN_TOOL" value="" />
+      <option name="SCRIPT_NAME" value="$PROJECT_DIR$/test/test_speed.py" />
+      <option name="PARAMETERS" value="" />
+      <option name="SHOW_COMMAND_LINE" value="false" />
+      <option name="EMULATE_TERMINAL" value="false" />
+      <option name="MODULE_MODE" value="false" />
+      <option name="REDIRECT_INPUT" value="false" />
+      <option name="INPUT_FILE" value="" />
+      <method v="2" />
+    </configuration>
+    <recent_temporary>
+      <list>
+        <item itemvalue="Python.test_speed" />
+        <item itemvalue="Python.test" />
+      </list>
+    </recent_temporary>
+  </component>
+  <component name="SharedIndexes">
+    <attachedChunks>
+      <set>
+        <option value="bundled-python-sdk-821f704e66d9-5bd6d13a2a75-com.jetbrains.pycharm.pro.sharedIndexes.bundled-PY-262.9437.214" />
+      </set>
+    </attachedChunks>
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="默认任务">
+      <changelist id="b482b6b4-48ce-4be1-bf3c-a72ec254fa35" name="更改" comment="" />
+      <created>1786860632989</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1786860632989</updated>
+    </task>
+    <task id="LOCAL-00001" summary="initial commit">
+      <option name="closed" value="true" />
+      <created>1786865208583</created>
+      <option name="number" value="00001" />
+      <option name="presentableId" value="LOCAL-00001" />
+      <option name="project" value="LOCAL" />
+      <updated>1786865208583</updated>
+    </task>
+    <option name="localTasksCounter" value="2" />
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State />
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+  <component name="VcsManagerConfiguration">
+    <MESSAGE value="initial commit" />
+    <option name="LAST_COMMIT_MESSAGE" value="initial commit" />
+  </component>
+</project>

obstruct-0.2.2/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.5
+Name: obstruct
+Version: 0.2.2
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+_来自已弃坑的 `Hydrogenlib`，重拾起当初的决心_
+
+
+>[!TIP]
+> 这个项目来自 [`HydrogenLib`](https://github.com/LittleNightSong/HydrogenLib)的 `Objective-Struct` 模块，脱离大项目的版本
+>
+> 同时，`HydrogenLib`中的 `Objective-Struct` 不再会更新
+
+
+# OBStruct
+_一个简单、纯粹、极速的二进制解析库_
+
+## 亮点
+- 基于类型注解的字段声明方式
+- 支持 `struct` 标准库中的所有格式，并额外支持 array 类型
+- 基于 AOT 的加速
+- 完整的操作支持（打包、解包、流式处理）
+
+## 安装
+```commandline
+pip install obstruct
+```
+如果使用 `uv` 等包管理器，则按照工具的方法安装即可
+
+
+## 用法
+
+首先声明一个 `Struct` 类型，它是一个 `dataclass`，也是一个 `struct`
+
+```python
+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` 基类
+- 继续优化性能
+- 通过存根文件强制表明类型似乎变得不再有效了

obstruct-0.2.2/README.md

@@ -0,0 +1,62 @@
+_来自已弃坑的 `Hydrogenlib`，重拾起当初的决心_
+
+
+>[!TIP]
+> 这个项目来自 [`HydrogenLib`](https://github.com/LittleNightSong/HydrogenLib)的 `Objective-Struct` 模块，脱离大项目的版本
+>
+> 同时，`HydrogenLib`中的 `Objective-Struct` 不再会更新
+
+
+# OBStruct
+_一个简单、纯粹、极速的二进制解析库_
+
+## 亮点
+- 基于类型注解的字段声明方式
+- 支持 `struct` 标准库中的所有格式，并额外支持 array 类型
+- 基于 AOT 的加速
+- 完整的操作支持（打包、解包、流式处理）
+
+## 安装
+```commandline
+pip install obstruct
+```
+如果使用 `uv` 等包管理器，则按照工具的方法安装即可
+
+
+## 用法
+
+首先声明一个 `Struct` 类型，它是一个 `dataclass`，也是一个 `struct`
+
+```python
+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` 基类
+- 继续优化性能
+- 通过存根文件强制表明类型似乎变得不再有效了

obstruct-0.2.2/src/obstruct/__version__.py

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

{obstruct-0.2.1 → obstruct-0.2.2}/src/obstruct/aot/base.py

@@ -5,9 +5,6 @@ import itertools
 import typing
 from typing import Any
 
-import typing_inspection.typing_objects
-
-from _hydrogenlib_core.typefunc import enhanced_generator
 from obstruct.methods import get_ctype
 
 
@@ -113,7 +110,6 @@ available_characters = tuple(
 )
 
 
-@enhanced_generator(history=True)
 def unique_name_generator():
     cnt = 0
     while True:
@@ -127,7 +123,7 @@ def is_struct(tp):
 
 
 def is_array(tp):
-    if typing_inspection.typing_objects.is_annotated(typing.get_origin(tp)):
+    if typing.get_origin(tp) is typing.Annotated:
         return True
     return False
 

{obstruct-0.2.1 → obstruct-0.2.2}/src/obstruct/aot/unpack.py

@@ -112,7 +112,7 @@ def create_unpack_methods(cls: type[struct_type.Struct]):
         # print(unpack_from.generate_code())
         # print(update_from.generate_code())
         # print(iter_unpack.generate_code())
-        print(iter_update.generate_code())
+        # print(iter_update.generate_code())
 
         globals = {
             v: k for k, v in inner_classes.items()  # 翻转字典

{obstruct-0.2.1 → obstruct-0.2.2}/src/obstruct/decorator.py

@@ -9,24 +9,17 @@ endian_control_characters = tuple('<@=!>')
 
 
 def struct(maybe_cls=None, *, endian='@'):
-    def decorator[T](cls: T) -> type[struct_type.Struct]:
+    def decorator[T](cls: T) -> T:
         import struct
-
-        # module = sys.modules[cls.__module__]
-
         fields = dataclasses.fields(cls)
-        # namesp = module.__dict__
-        # print(namesp)
         real_annotations = typing.get_type_hints(cls)
-        # print(cls, real_annotations)
 
         for field in fields:
-            print(cls, field.name, repr(field.type))
+            # print(cls, field.name, repr(field.type))
             if isinstance(field.type, str):
                 field.type = real_annotations[field.name]
 
         cls.__ctype__ = to_format_string([field.type for field in fields])
-        # print(cls.__ctype__)
         cls.__cfields__ = tuple(fields)  # type: tuple[dataclasses.Field, ...]
         cls.__cstruct__ = struct.Struct(endian + cls.__ctype__)  # 构造 Struct 类型
         cls.__cendian__ = endian

{obstruct-0.2.1 → obstruct-0.2.2}/src/obstruct/methods.py

@@ -1,8 +1,6 @@
 import struct
 from collections.abc import Buffer
-from typing import Any, Sequence, Iterator, get_args, get_origin
-
-from typing_inspection.typing_objects import is_annotated
+from typing import Any, Sequence, Iterator, get_args, get_origin, Annotated, cast
 
 from .struct_type import CType
 
@@ -13,14 +11,14 @@ mapping = {
 CTypesFields = Sequence[str | CType | type] | Iterator[str | CType | type]
 
 
-def get_ctype(tp):
+def get_ctype(tp) -> str:
     if isinstance(tp, str):
         return tp
     elif _ := getattr(tp, '__ctype__', None):
-        return _
+        return cast(str, _)
     elif _ := mapping.get(tp):
         return _
-    elif is_annotated(get_origin(tp)):
+    elif get_origin(tp) is Annotated:
         # 目前需要 Annotated 的类型只有 array
         tp_args = get_args(tp)
         dtype = get_args(tp_args[0])[0]

obstruct-0.2.2/src/obstruct/types/types.pyi

@@ -0,0 +1,33 @@
+import sys
+
+
+def pad(size: int) -> type: ...
+
+
+char = bytes
+signed_char = int
+unsigned_char = int
+long = int
+unsigned_long = int
+short = int
+unsigned_short = int
+unsigned_int = int
+long_long = int
+unsigned_long_long = int
+double = float
+short_float = float
+size_t = int
+ssize_t = int
+
+
+def string(length: int) -> type[bytes]: ...
+
+
+def pascal_string(length: int) -> type[bytes]: ...
+
+
+pointer = int
+
+if sys.version_info >= (3, 14, 0):
+    float_complex = complex
+    double_complex = complex

obstruct-0.2.2/test/test.py

@@ -0,0 +1,28 @@
+import dataclasses
+
+import obstruct as obs
+from obstruct import Struct
+
+
+@obs.struct()
+@dataclasses.dataclass(slots=True)
+class MyStruct(Struct):
+    a: int
+    b: int
+    c: float
+    d: obs.double_complex
+
+
+
+if __name__ == '__main__':
+    data = MyStruct(15, 20, 1.2, 8 + 7j)
+    print(data)
+
+    packed_data = data.pack()
+
+    print(packed_data)
+
+    restored = MyStruct.unpack(packed_data)
+    print(restored)
+
+    print(data == restored)

obstruct-0.2.2/test/test_speed.py

@@ -0,0 +1,59 @@
+import dataclasses
+import time
+
+import obstruct as obs
+
+
+@obs.struct()
+@dataclasses.dataclass(slots=True)
+class MyStruct(obs.Struct):
+    a: int
+    b: int
+    c: float
+    d: int
+    e: obs.short
+    f: obs.unsigned_short
+    g: obs.long
+    h: obs.unsigned_long
+    i: obs.unsigned_long
+    j: obs.char
+    k: obs.unsigned_char
+    l: obs.long_long
+
+
+
+data = MyStruct(
+    1,2,1.0,4,5,6,7,8,9,b'8',1,2
+)
+
+
+packed_data = data.pack()
+
+
+def test_timeit(name, code):
+    import timeit
+
+    print("Test: ", name)
+    res = timeit.timeit(
+        code,
+        number=NUMBER,
+        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')
+
+
+NUMBER = 10000
+
+test_timeit(
+    name='Pack',
+    code="""data.pack()""",
+)
+
+test_timeit(
+    name='Unpack',
+    code="""MyStruct.unpack(packed_data)""",
+)
+
+

{obstruct-0.2.1 → obstruct-0.2.2}/uv.lock

@@ -303,20 +303,6 @@ wheels = [
     { url = "https://mirrors.aliyun.com/pypi/packages/9b/43/832f631d32e4f1211caa2ba368317739fe71f0b8530e4c9d15dc454bac2a/httpx2_jsfetch-1.0-py3-none-any.whl", hash = "sha256:cb916b707601e69a07721aabc8f3f6659be3a6893bc1ff5c6f9e02241df2da32" },
 ]
 
-[[package]]
-name = "hydrogenlib-objective-struct"
-source = { editable = "." }
-
-[package.dev-dependencies]
-dev = [
-    { name = "hatch" },
-]
-
-[package.metadata]
-
-[package.metadata.requires-dev]
-dev = [{ name = "hatch", specifier = ">=1.18.0" }]
-
 [[package]]
 name = "hyperlink"
 version = "21.0.0"
@@ -427,6 +413,20 @@ wheels = [
     { url = "https://mirrors.aliyun.com/pypi/packages/e8/3d/1087453384dbde46a8c7f9356eead2c58be8a7bf156bca40243377c85715/more_itertools-11.1.0-py3-none-any.whl", hash = "sha256:4b65538ae22f6fed0ce4874efd317463a7489796a0939fa66824dd542125a192" },
 ]
 
+[[package]]
+name = "obstruct"
+source = { editable = "." }
+
+[package.dev-dependencies]
+dev = [
+    { name = "hatch" },
+]
+
+[package.metadata]
+
+[package.metadata.requires-dev]
+dev = [{ name = "hatch", specifier = ">=1.18.0" }]
+
 [[package]]
 name = "packaging"
 version = "26.3"

obstruct-0.2.1/.idea/workspace.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="PropertiesComponent">{}</component>
-</project>

obstruct-0.2.1/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.5
-Name: obstruct
-Version: 0.2.1
-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 :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.12

obstruct-0.2.1/src/obstruct/__version__.py

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

obstruct-0.2.1/src/obstruct/types/types.pyi

@@ -1,67 +0,0 @@
-import sys
-from typing import Literal, Sequence
-
-
-class _ctype:
-    __ctype__: str
-
-
-def pad(size: int) -> type: ...
-
-
-class char(bytes, _ctype): ...
-
-
-class signed_char(int, _ctype): ...
-
-
-class unsigned_char(int, _ctype): ...
-
-
-class long(int, _ctype): ...
-
-
-class unsigned_long(int, _ctype): ...
-
-
-class short(int, _ctype): ...
-
-
-class unsigned_short(int, _ctype): ...
-
-
-class unsigned_int(int, _ctype): ...
-
-
-class long_long(int, _ctype): ...
-
-
-class unsigned_long_long(int, _ctype): ...
-
-
-class double(float, _ctype): ...
-
-
-class short_float(float, _ctype): ...
-
-
-class size_t(int, _ctype): ...
-
-
-class ssize_t(int, _ctype): ...
-
-
-def string(length: int) -> type[bytes]: ...
-
-
-def pascal_string(length: int) -> type[bytes]: ...
-
-
-class pointer(int, _ctype): ...
-
-
-if sys.version_info >= (3, 14, 0):
-    class float_complex(complex, _ctype): ...
-
-
-    class double_complex(complex, _ctype): ...