dissect.cstruct 5.0.dev9__tar.gz → 5.0.dev10__tar.gz

{dissect_cstruct-5.0.dev9 → dissect_cstruct-5.0.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 5.0.dev9
+Version: 5.0.dev10
 Summary: A Dissect module implementing a parser for C-like structures: structure parsing in Python made easy
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: Apache-2.0

{dissect_cstruct-5.0.dev9 → dissect_cstruct-5.0.dev10}/dissect.cstruct.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 5.0.dev9
+Version: 5.0.dev10
 Summary: A Dissect module implementing a parser for C-like structures: structure parsing in Python made easy
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: Apache-2.0

{dissect_cstruct-5.0.dev9 → dissect_cstruct-5.0.dev10}/dissect.cstruct.egg-info/scm_file_list.json

@@ -1,78 +1,78 @@
 {
   "files": [
-    "LICENSE",
-    "tox.ini",
-    "CHANGELOG.md",
-    "README.md",
-    ".gitattributes",
     ".git-blame-ignore-revs",
-    "MANIFEST.in",
-    ".gitignore",
-    "COPYRIGHT",
-    "pyproject.toml",
+    ".gitattributes",
     ".github/pull_request_template.md",
     ".github/workflows/dissect-ci.yml",
-    "dissect/cstruct/cstruct.py",
-    "dissect/cstruct/parser.py",
-    "dissect/cstruct/lexer.py",
+    ".gitignore",
+    "CHANGELOG.md",
+    "COPYRIGHT",
+    "LICENSE",
+    "MANIFEST.in",
+    "README.md",
+    "dissect/cstruct/__init__.py",
+    "dissect/cstruct/bitbuffer.py",
     "dissect/cstruct/compiler.py",
+    "dissect/cstruct/cstruct.py",
     "dissect/cstruct/exception.py",
     "dissect/cstruct/expression.py",
-    "dissect/cstruct/__init__.py",
-    "dissect/cstruct/bitbuffer.py",
-    "dissect/cstruct/util.py",
+    "dissect/cstruct/lexer.py",
+    "dissect/cstruct/parser.py",
     "dissect/cstruct/tools/__init__.py",
     "dissect/cstruct/tools/stubgen.py",
+    "dissect/cstruct/types/__init__.py",
     "dissect/cstruct/types/base.py",
-    "dissect/cstruct/types/pointer.py",
+    "dissect/cstruct/types/char.py",
+    "dissect/cstruct/types/enum.py",
     "dissect/cstruct/types/flag.py",
-    "dissect/cstruct/types/wchar.py",
-    "dissect/cstruct/types/leb128.py",
-    "dissect/cstruct/types/structure.py",
     "dissect/cstruct/types/int.py",
-    "dissect/cstruct/types/__init__.py",
-    "dissect/cstruct/types/char.py",
+    "dissect/cstruct/types/leb128.py",
     "dissect/cstruct/types/packed.py",
+    "dissect/cstruct/types/pointer.py",
+    "dissect/cstruct/types/structure.py",
     "dissect/cstruct/types/void.py",
-    "dissect/cstruct/types/enum.py",
+    "dissect/cstruct/types/wchar.py",
+    "dissect/cstruct/util.py",
     "examples/disk.py",
+    "examples/mirai.py",
     "examples/pe.py",
     "examples/protobuf.py",
     "examples/secdesc.py",
-    "examples/mirai.py",
-    "tests/test_utils.py",
-    "tests/test_lexer.py",
+    "pyproject.toml",
+    "tests/__init__.py",
+    "tests/_data/testdef.txt",
+    "tests/_docs/Makefile",
+    "tests/_docs/__init__.py",
+    "tests/_docs/conf.py",
+    "tests/_docs/index.rst",
+    "tests/conftest.py",
+    "tests/test_align.py",
+    "tests/test_annotations.py",
+    "tests/test_basic.py",
     "tests/test_benchmark.py",
+    "tests/test_bitbuffer.py",
+    "tests/test_bitfield.py",
+    "tests/test_compiler.py",
+    "tests/test_ctypes.py",
+    "tests/test_expression.py",
+    "tests/test_lexer.py",
     "tests/test_parser.py",
     "tests/test_tools_stubgen.py",
-    "tests/test_types_enum.py",
-    "tests/test_types_structure.py",
     "tests/test_types_base.py",
-    "tests/test_types_void.py",
-    "tests/test_types_packed.py",
-    "tests/test_types_pointer.py",
-    "tests/__init__.py",
     "tests/test_types_char.py",
-    "tests/test_types_leb128.py",
     "tests/test_types_custom.py",
-    "tests/test_compiler.py",
-    "tests/test_align.py",
-    "tests/test_basic.py",
-    "tests/test_types_wchar.py",
-    "tests/test_bitfield.py",
-    "tests/test_types_union.py",
+    "tests/test_types_enum.py",
     "tests/test_types_flag.py",
-    "tests/conftest.py",
     "tests/test_types_int.py",
-    "tests/test_expression.py",
-    "tests/test_annotations.py",
-    "tests/test_ctypes.py",
-    "tests/test_bitbuffer.py",
+    "tests/test_types_leb128.py",
+    "tests/test_types_packed.py",
+    "tests/test_types_pointer.py",
+    "tests/test_types_structure.py",
+    "tests/test_types_union.py",
+    "tests/test_types_void.py",
+    "tests/test_types_wchar.py",
+    "tests/test_utils.py",
     "tests/utils.py",
-    "tests/_docs/__init__.py",
-    "tests/_docs/conf.py",
-    "tests/_docs/index.rst",
-    "tests/_docs/Makefile",
-    "tests/_data/testdef.txt"
+    "tox.ini"
   ]
 }

dissect_cstruct-5.0.dev10/dissect.cstruct.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "5.0.dev0",
+  "distance": 10,
+  "node": "ge5261d5fa176890243eded2be0a28327fda617b3",
+  "dirty": true,
+  "branch": "main",
+  "node_date": "2026-10-28"
+}

{dissect_cstruct-5.0.dev9 → dissect_cstruct-5.0.dev10}/tests/test_benchmark.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import io
 from functools import partial
 from typing import TYPE_CHECKING
 
@@ -48,6 +49,43 @@ def test_benchmark_union(cs: cstruct, compiled: bool, benchmark: BenchmarkFixtur
     benchmark(lambda: cs.test(b"\x01\x02\x03\x04\x05\x06\x07\x08"))
 
 
+@pytest.mark.benchmark
+def test_benchmark_union_nested(cs: cstruct, compiled: bool, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of a union with nested structures with both the compiled and interpreted backends."""
+    cdef = """
+    union test {
+        struct {
+            uint32  offset;
+            uint32  block;
+        } lsn;
+        struct {
+            uint16  low;
+            uint16  mid;
+            uint32  high;
+        } parts;
+        uint64  value;
+    };
+    """
+    cs.load(cdef, compiled=compiled)
+
+    benchmark(lambda: cs.test(b"\x01\x02\x03\x04\x05\x06\x07\x08"))
+
+
+@pytest.mark.benchmark
+def test_benchmark_union_array(cs: cstruct, compiled: bool, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of an array of unions with both the compiled and interpreted backends."""
+    cdef = """
+    union test {
+        uint32  a;
+        char    b[4];
+    };
+    """
+    cs.load(cdef, compiled=compiled)
+
+    buf = bytes(range(64))
+    benchmark(lambda: cs.test[16](buf))
+
+
 @pytest.mark.benchmark
 def test_benchmark_attribute_access(cs: cstruct, benchmark: BenchmarkFixture) -> None:
     """Benchmark the attribute access of a parsed struct."""
@@ -200,3 +238,144 @@ def test_benchmark_lexer_and_parser(cs: cstruct, benchmark: BenchmarkFixture) ->
     cs.add_type = partial(cs.add_type, replace=True)
 
     benchmark(lambda: cs.load(_BENCHMARK_CDEF))
+
+
+@pytest.mark.benchmark
+def test_benchmark_nested_dynamic(cs: cstruct, compiled: bool, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of a realistic struct with nested structs and dynamically sized arrays."""
+    cs.load(_BENCHMARK_CDEF, compiled=compiled)
+
+    buf = (
+        b"\x01\x00\x00\x00"  # Mask
+        b"\x03\x00\x00\x00"  # Flags
+        + bytes(range(16))  # ObjectType
+        + bytes(range(16))  # InheritedObjectType
+        + b"\x01\x04\x00\x00\x00\x00\x00\x05"  # Sid
+        + b"\x15\x00\x00\x00" * 4  # Sid.SubAuthority
+    )
+
+    benchmark(lambda: cs.ACCESS_ALLOWED_OBJECT_ACE(buf))
+
+
+@pytest.mark.benchmark
+def test_benchmark_enum_flag_bits(cs: cstruct, compiled: bool, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of a struct with enums, flags and bit fields."""
+    cdef = """
+    enum Type : uint16 {
+        A = 1,
+        B = 2,
+    };
+
+    flag Flags : uint16 {
+        X = 1,
+        Y = 2,
+        Z = 4,
+    };
+
+    struct test {
+        Type    type;
+        Flags   flags;
+        uint16  a : 4;
+        uint16  b : 12;
+        uint32  c;
+    };
+    """
+    cs.load(cdef, compiled=compiled)
+
+    benchmark(lambda: cs.test(b"\x01\x00\x05\x00\x34\x12\x01\x00\x00\x00"))
+
+
+@pytest.mark.benchmark
+def test_benchmark_flag_operators(cs: cstruct, benchmark: BenchmarkFixture) -> None:
+    """Benchmark bitwise operations on flags."""
+    cdef = """
+    flag Flags : uint16 {
+        X = 1,
+        Y = 2,
+        Z = 4,
+    };
+    """
+    cs.load(cdef)
+    value = cs.Flags.X | cs.Flags.Z
+
+    benchmark(lambda: (value & cs.Flags.X, value | cs.Flags.Y, value & 0x4))
+
+
+@pytest.mark.benchmark
+def test_benchmark_strings(cs: cstruct, compiled: bool, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of a struct with fixed size and null-terminated strings."""
+    cdef = """
+    struct test {
+        wchar   name[8];
+        char    path[];
+        wchar   description[];
+    };
+    """
+    cs.load(cdef, compiled=compiled)
+
+    buf = (
+        "filename".encode("utf-16-le")  # name
+        + b"some/path/to/a/file\x00"  # path
+        + "A description".encode("utf-16-le")  # description
+        + b"\x00\x00"
+    )
+
+    benchmark(lambda: cs.test(buf))
+
+
+@pytest.mark.benchmark
+@pytest.mark.parametrize("kind", ["bytes", "memoryview", "stream"])
+def test_benchmark_primitive(cs: cstruct, kind: str, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of a primitive type from different kinds of input."""
+    buf = b"\x01\x02\x03\x04"
+
+    if kind == "stream":
+        fh = io.BytesIO(buf)
+
+        def read() -> int:
+            fh.seek(0)
+            return cs.uint32(fh)
+
+        benchmark(read)
+    else:
+        obj = memoryview(buf) if kind == "memoryview" else buf
+        benchmark(lambda: cs.uint32(obj))
+
+
+@pytest.mark.benchmark
+def test_benchmark_array(cs: cstruct, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the parsing of an array type created at runtime."""
+    buf = bytes(range(64))
+
+    benchmark(lambda: cs.uint32[16](buf))
+
+
+@pytest.mark.benchmark
+def test_benchmark_dumps(cs: cstruct, benchmark: BenchmarkFixture) -> None:
+    """Benchmark the writing of a simple struct."""
+    cdef = """
+    struct test {
+        uint32  a;
+        uint64  b;
+        uint16  c;
+        uint8   d;
+    };
+    """
+    cs.load(cdef)
+    obj = cs.test(b"\x01\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x03\x00\x04")
+
+    benchmark(lambda: obj.dumps())
+
+
+@pytest.mark.benchmark
+def test_benchmark_load_and_read(cs: cstruct, compiled: bool, benchmark: BenchmarkFixture) -> None:
+    """Benchmark loading struct definitions and reading one struct, which includes any (lazy) compilation."""
+    cs.add_type = partial(cs.add_type, replace=True)
+
+    buf = b"\x02\x01\x00\x00\x00\x00\x00\x05" + b"\x15\x00\x00\x00" * 2
+
+    def load_and_read() -> None:
+        cs.load(_BENCHMARK_CDEF, compiled=compiled)
+        cs.LDAP_SID(buf)
+
+    benchmark(load_and_read)

{dissect_cstruct-5.0.dev9 → dissect_cstruct-5.0.dev10}/tox.ini

@@ -24,6 +24,8 @@ commands =
 
 [testenv:benchmark]
 deps =
+    # Until pytest-codspeed is compatible with 9.2
+    pytest<9.2
     pytest-benchmark
     pytest-codspeed
 dependency_groups = test

dissect_cstruct-5.0.dev9/dissect.cstruct.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "5.0.dev0",
-  "distance": 9,
-  "node": "g46b850fa9cd023a9de583149caa5e9ba31254cf1",
-  "dirty": true,
-  "branch": "main",
-  "node_date": "2026-08-07"
-}