dissect.cstruct 5.0.dev0__py3-none-any.whl → 5.0.dev7__py3-none-any.whl

dissect/cstruct/types/wchar.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
 import sys
-from typing import Any, BinaryIO, ClassVar
+from typing import TYPE_CHECKING, Any, BinaryIO, ClassVar
 
+from dissect.cstruct.exception import ArraySizeError
 from dissect.cstruct.types.base import EOF, BaseArray, BaseType
 
+if TYPE_CHECKING:
+    from dissect.cstruct.cstruct import Endianness
+
 
 class WcharArray(str, BaseArray):
     """Wide-character array type for reading and writing UTF-16 strings."""
@@ -16,14 +20,20 @@ class WcharArray(str, BaseArray):
         return type.__call__(cls, "\x00" * (0 if cls.dynamic or cls.null_terminated else cls.num_entries))
 
     @classmethod
-    def _read(cls, stream: BinaryIO, context: dict[str, Any] | None = None) -> WcharArray:
-        return type.__call__(cls, super()._read(stream, context))
+    def _read(cls, stream: BinaryIO, *, context: dict[str, Any] | None = None, endian: Endianness) -> WcharArray:
+        return type.__call__(cls, super()._read(stream, context=context, endian=endian))
 
     @classmethod
-    def _write(cls, stream: BinaryIO, data: str) -> int:
+    def _write(cls, stream: BinaryIO, data: str, *, endian: Endianness) -> int:
         if cls.null_terminated:
             data += "\x00"
-        return stream.write(data.encode(Wchar.__encoding_map__[cls.cs.endian]))
+
+        if not cls.dynamic and (remaining := cls.num_entries - (actual_size := len(data))):
+            if remaining < 0:
+                raise ArraySizeError(f"Expected static array size {cls.num_entries}, got {actual_size} instead.")
+            data += "\x00" * remaining
+
+        return stream.write(data.encode(Wchar.__encoding_map__[endian]))
 
 
 class Wchar(str, BaseType):
@@ -32,7 +42,7 @@ class Wchar(str, BaseType):
     ArrayType = WcharArray
 
     __slots__ = ()
-    __encoding_map__: ClassVar[dict[str, str]] = {
+    __encoding_map__: ClassVar[dict[Endianness, str]] = {
         "@": f"utf-16-{sys.byteorder[0]}e",
         "=": f"utf-16-{sys.byteorder[0]}e",
         "<": "utf-16-le",
@@ -45,11 +55,13 @@ class Wchar(str, BaseType):
         return type.__call__(cls, "\x00")
 
     @classmethod
-    def _read(cls, stream: BinaryIO, context: dict[str, Any] | None = None) -> Wchar:
-        return cls._read_array(stream, 1, context)
+    def _read(cls, stream: BinaryIO, *, context: dict[str, Any] | None = None, endian: Endianness) -> Wchar:
+        return cls._read_array(stream, 1, context=context, endian=endian)
 
     @classmethod
-    def _read_array(cls, stream: BinaryIO, count: int, context: dict[str, Any] | None = None) -> Wchar:
+    def _read_array(
+        cls, stream: BinaryIO, count: int, *, context: dict[str, Any] | None = None, endian: Endianness
+    ) -> Wchar:
         if count == 0:
             return type.__call__(cls, "")
 
@@ -60,10 +72,10 @@ class Wchar(str, BaseType):
         if count != EOF and len(data) != count:
             raise EOFError(f"Read {len(data)} bytes, but expected {count}")
 
-        return type.__call__(cls, data.decode(cls.__encoding_map__[cls.cs.endian]))
+        return type.__call__(cls, data.decode(cls.__encoding_map__[endian]))
 
     @classmethod
-    def _read_0(cls, stream: BinaryIO, context: dict[str, Any] | None = None) -> Wchar:
+    def _read_0(cls, stream: BinaryIO, *, context: dict[str, Any] | None = None, endian: Endianness) -> Wchar:
         buf = []
         while True:
             point = stream.read(2)
@@ -75,8 +87,8 @@ class Wchar(str, BaseType):
 
             buf.append(point)
 
-        return type.__call__(cls, b"".join(buf).decode(cls.__encoding_map__[cls.cs.endian]))
+        return type.__call__(cls, b"".join(buf).decode(cls.__encoding_map__[endian]))
 
     @classmethod
-    def _write(cls, stream: BinaryIO, data: str) -> int:
-        return stream.write(data.encode(cls.__encoding_map__[cls.cs.endian]))
+    def _write(cls, stream: BinaryIO, data: str, *, endian: Endianness) -> int:
+        return stream.write(data.encode(cls.__encoding_map__[endian]))

dissect/cstruct/{utils.py → util.py}

@@ -11,6 +11,7 @@ if TYPE_CHECKING:
     from collections.abc import Iterator
     from typing import Literal
 
+    from dissect.cstruct.cstruct import AllowedEndianness
     from dissect.cstruct.types.base import BaseType
     from dissect.cstruct.types.structure import Structure
 
@@ -51,13 +52,16 @@ COLOR_CLEAR_BOLD = "\033[1;0m"
 
 PRINTABLE = string.digits + string.ascii_letters + string.punctuation + " "
 
-ENDIANNESS_MAP: dict[str, Literal["big", "little"]] = {
-    "@": sys.byteorder,
-    "=": sys.byteorder,
+
+ENDIANNESS_TO_BYTEORDER_MAP: dict[AllowedEndianness, Literal["big", "little"]] = {
     "<": "little",
     ">": "big",
     "!": "big",
+    "@": sys.byteorder,
+    "=": sys.byteorder,
     "network": "big",
+    "little": "little",
+    "big": "big",
 }
 
 Palette = list[tuple[int, str]]
@@ -323,111 +327,118 @@ def dumpstruct(
     return _dumpstruct(obj, obj.dumps(), offset, color, output, autoskip)
 
 
-def pack(value: int, size: int | None = None, endian: str = "little") -> bytes:
+def pack(value: int, size: int | None = None, endian: AllowedEndianness = "little") -> bytes:
     """Pack an integer value to a given bit size, endianness.
 
     Arguments:
         value: Value to pack.
         size: Integer size in bits.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
+    if endian not in ENDIANNESS_TO_BYTEORDER_MAP:
+        raise ValueError(f"Invalid endianness: {endian!r} (should be little, big, network, <, >, !, @ or =)")
+
     size = ((size or value.bit_length()) + 7) // 8
-    return value.to_bytes(size, ENDIANNESS_MAP.get(endian, endian), signed=value < 0)
+    return value.to_bytes(size, ENDIANNESS_TO_BYTEORDER_MAP[endian], signed=value < 0)
 
 
-def unpack(value: bytes, size: int | None = None, endian: str = "little", sign: bool = False) -> int:
+def unpack(value: bytes, size: int | None = None, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack an integer value from a given bit size, endianness and sign.
 
     Arguments:
         value: Value to unpack.
         size: Integer size in bits.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     if size and len(value) != size // 8:
         raise ValueError(f"Invalid byte value, expected {size // 8} bytes, got {len(value)} bytes")
-    return int.from_bytes(value, ENDIANNESS_MAP.get(endian, endian), signed=sign)
+
+    if endian not in ENDIANNESS_TO_BYTEORDER_MAP:
+        raise ValueError(f"Invalid endianness: {endian!r} (should be little, big, network, <, >, !, @ or =)")
+
+    return int.from_bytes(value, ENDIANNESS_TO_BYTEORDER_MAP[endian], signed=sign)
 
 
-def p8(value: int, endian: str = "little") -> bytes:
+def p8(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack an 8 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 8, endian)
 
 
-def p16(value: int, endian: str = "little") -> bytes:
+def p16(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack a 16 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 16, endian)
 
 
-def p32(value: int, endian: str = "little") -> bytes:
+def p32(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack a 32 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 32, endian)
 
 
-def p64(value: int, endian: str = "little") -> bytes:
+def p64(value: int, endian: AllowedEndianness = "little") -> bytes:
     """Pack a 64 bit integer.
 
     Arguments:
         value: Value to pack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
     """
     return pack(value, 64, endian)
 
 
-def u8(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u8(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack an 8 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 8, endian, sign)
 
 
-def u16(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u16(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack a 16 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 16, endian, sign)
 
 
-def u32(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u32(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack a 32 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 32, endian, sign)
 
 
-def u64(value: bytes, endian: str = "little", sign: bool = False) -> int:
+def u64(value: bytes, endian: AllowedEndianness = "little", sign: bool = False) -> int:
     """Unpack a 64 bit integer.
 
     Arguments:
         value: Value to unpack.
-        endian: Endianness to use (little, big, network, <, > or !)
+        endian: Endianness to use (little, big, network, <, >, !, @ or =).
         sign: Signedness of the integer.
     """
     return unpack(value, 64, endian, sign)

{dissect_cstruct-5.0.dev0.dist-info → dissect_cstruct-5.0.dev7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 5.0.dev0
+Version: 5.0.dev7
 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.dev7.dist-info/RECORD

@@ -0,0 +1,32 @@
+dissect/cstruct/__init__.py,sha256=8VNVQfPH4aH5V_kD-jvtLPwQ-ag9ppKHTy3dbxIR6ik,1378
+dissect/cstruct/bitbuffer.py,sha256=lZuLUOluHx4mzFGRp62_FO45_iJwXayyzv9-v8b0Q08,2687
+dissect/cstruct/compiler.py,sha256=vVg2H-pi9ugQ8Xvhs1JQ--4BjA5gtO2tW-1W8jr36V4,14283
+dissect/cstruct/cstruct.py,sha256=bsCesSpbE0H4MUsHwb2iEbeadOBlOSAVENwyoP-UkP8,24929
+dissect/cstruct/exception.py,sha256=RqD08LuBkbMqa3iQ1A05DNN8XgEmQR_SUnguwe9LGo8,316
+dissect/cstruct/expression.py,sha256=MEwqHGgqA2fUk4kYk4lRLDWNTAMhB4-saJ5BgTxl7OA,7956
+dissect/cstruct/lexer.py,sha256=NDUfAWgyxgRNRuVO8ExXQ51LqQXS2mv9bywVa_M7tFQ,19665
+dissect/cstruct/parser.py,sha256=xCK-1O8c86sVFvjaXXSRgTsJWWd0ncKM6KJf2wbyGG8,21348
+dissect/cstruct/util.py,sha256=S__kLEb9HKZg_WZR4CGtXDxkIkERLKbzFTHoU8FT8tU,15313
+dissect/cstruct/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dissect/cstruct/tools/stubgen.py,sha256=FLQieYE-MeKK31DcrDzwNUropUYHPjwdfcDb1X2L6j4,7651
+dissect/cstruct/types/__init__.py,sha256=6P71Pu94Dv7RNjZpDZ19pqzx-G0QzmQw4q0-3zWALso,911
+dissect/cstruct/types/base.py,sha256=rU1S2FQllx7X7BQG7qMOwNa7waxAJyuTHTNwtkiAz0g,12763
+dissect/cstruct/types/char.py,sha256=s4zDmnbuOjwHgcsnEihjSqgC6H3t1jsfBTYH2ykwvHU,2997
+dissect/cstruct/types/enum.py,sha256=YIWyP3H0tdxmuSI82enoULiN0YevpnU0UaY5ioBCYfI,8518
+dissect/cstruct/types/flag.py,sha256=7xxQjFEDPHSQOxBHgcc75WzPiAxflOquwr7Z7c3erLE,2347
+dissect/cstruct/types/int.py,sha256=Ewejng5pBYnQHPtzL5W0wQMJVUPYyrY8ALES8mFaabI,1324
+dissect/cstruct/types/leb128.py,sha256=V97XTJT_Xbw1LpTwTN1OkjPHuQQAQUxd8OGuA6yEDmE,2387
+dissect/cstruct/types/packed.py,sha256=78nQWm-yylgfK3858nN-XZhO5jiqyO-piGNEyPD2ps4,2458
+dissect/cstruct/types/pointer.py,sha256=eGMrB_tTnKXKmYrcqyA_12IdukXcxRG3WOeQ1dgt7lk,3927
+dissect/cstruct/types/structure.py,sha256=7pBg0moZbszeRomFEp5CbAHZcd1J8IVTmEG9Mo2eKS0,37571
+dissect/cstruct/types/void.py,sha256=LCYnTcxsFPaxln36QEUxWuCZVioHRRckMuqtlm6tH54,1218
+dissect/cstruct/types/wchar.py,sha256=YCYlu91D9AMVpWOLbVMdpvDDURH-EqyppM5UMDU5UQw,3200
+dissect_cstruct-5.0.dev7.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
+dissect_cstruct-5.0.dev7.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
+dissect_cstruct-5.0.dev7.dist-info/METADATA,sha256=IUF-_jFf7_GABYqAww23JWUTr-f73OKwmaICtDcOGc8,9255
+dissect_cstruct-5.0.dev7.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+dissect_cstruct-5.0.dev7.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
+dissect_cstruct-5.0.dev7.dist-info/scm_file_list.json,sha256=nuFWhDGL6VmjcwOB94CSfjNBblnsa9imUy8X4BLyvhw,2306
+dissect_cstruct-5.0.dev7.dist-info/scm_version.json,sha256=wMGNV4ui6dgAUOW0hK23797wTuOlVvhVvvLFz_dXXFk,162
+dissect_cstruct-5.0.dev7.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
+dissect_cstruct-5.0.dev7.dist-info/RECORD,,

{dissect_cstruct-5.0.dev0.dist-info → dissect_cstruct-5.0.dev7.dist-info}/scm_file_list.json

@@ -14,10 +14,10 @@
     ".github/workflows/dissect-ci.yml",
     "dissect/cstruct/parser.py",
     "dissect/cstruct/compiler.py",
+    "dissect/cstruct/exception.py",
+    "dissect/cstruct/util.py",
     "dissect/cstruct/cstruct.py",
     "dissect/cstruct/bitbuffer.py",
-    "dissect/cstruct/utils.py",
-    "dissect/cstruct/exceptions.py",
     "dissect/cstruct/lexer.py",
     "dissect/cstruct/expression.py",
     "dissect/cstruct/__init__.py",

dissect_cstruct-5.0.dev7.dist-info/scm_version.json

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

dissect_cstruct-5.0.dev0.dist-info/RECORD

@@ -1,32 +0,0 @@
-dissect/cstruct/__init__.py,sha256=Z47dU_PpbZyc2ZSyu-ww-ncX6igaTw0ItVHzVgiaiKI,1380
-dissect/cstruct/bitbuffer.py,sha256=bid_N4ZsaTeC3x5Fzs8viUrldT863dMPtEDih20Nt6k,2644
-dissect/cstruct/compiler.py,sha256=uOjteLdoUIVNSX71TsBAusW8U085RRH9dXkbK3dp1vY,14203
-dissect/cstruct/cstruct.py,sha256=Rq7RodLtegSbJzB0fYtSnbdBcx39Oxwm6rKZoKZVIeY,20129
-dissect/cstruct/exceptions.py,sha256=RqD08LuBkbMqa3iQ1A05DNN8XgEmQR_SUnguwe9LGo8,316
-dissect/cstruct/expression.py,sha256=BIqSs-xvCb4WvUb0_xjg2A4hclH8cs_W0lIGydzluIE,8027
-dissect/cstruct/lexer.py,sha256=NEU1Ww29jWjOfhODNXMGhsBR9b-_ITnz5J-4A3kf688,19178
-dissect/cstruct/parser.py,sha256=7F_QmlY7SZRXq-SOnbu7C6M2D8FKN63zvNNfE0D4bvQ,20545
-dissect/cstruct/utils.py,sha256=3ZEeZ_bAZRm7IcyeB6i9h7qrcYB42LW9GJR9BtKTUDg,14650
-dissect/cstruct/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dissect/cstruct/tools/stubgen.py,sha256=wvl07h3VnJZWe9ygX4QMxjEH1ZcWaI_6_pSdAJoOEXk,7820
-dissect/cstruct/types/__init__.py,sha256=6P71Pu94Dv7RNjZpDZ19pqzx-G0QzmQw4q0-3zWALso,911
-dissect/cstruct/types/base.py,sha256=-NYmoX4vEfaFsnAIwQ0nZCz8X2qKEomgpnef2jB4klQ,9708
-dissect/cstruct/types/char.py,sha256=9XYCjCF0D_5o3EYnmIcjev-5GI2NzxOhd1ct1xF6SAM,2457
-dissect/cstruct/types/enum.py,sha256=vOsD99P7VLhj6vcH_ow1jmyipLP63FmqUQ9GLZ1L8Pc,7565
-dissect/cstruct/types/flag.py,sha256=7xxQjFEDPHSQOxBHgcc75WzPiAxflOquwr7Z7c3erLE,2347
-dissect/cstruct/types/int.py,sha256=MGsdUxJt-lj3nl9wzAgGX8cb_vJOtGLiCHwYZs1j_IA,1156
-dissect/cstruct/types/leb128.py,sha256=kDmsWGXX6vr1bm4uJcilsrQ7JABdQRio16rBZV21pno,2243
-dissect/cstruct/types/packed.py,sha256=tpZpb8tiSMXr1np6p0-nZqT4sY7zieO-4E16lmMmqJA,2128
-dissect/cstruct/types/pointer.py,sha256=PqeJOoNBUfMd5uO2kpF6OHeW7Q6R1N1W1V4q1MakN4I,3912
-dissect/cstruct/types/structure.py,sha256=I9LVeZ81rNE5GDT6wxpUL-PqMO31Ae6TVLLzTGyd6mM,33012
-dissect/cstruct/types/void.py,sha256=Gvh0HqI6jQSj2uesdo3J8-G41brWCz8pmP16l8xTBxE,1074
-dissect/cstruct/types/wchar.py,sha256=N9Y_XX2_hZEe2DwepJjxsB6xuRJ6zINRalcUofR59kY,2608
-dissect_cstruct-5.0.dev0.dist-info/licenses/COPYRIGHT,sha256=H-18RXfshdH9AdHwW2eO1Xa-5s6tY5eipHh5c0whDu4,316
-dissect_cstruct-5.0.dev0.dist-info/licenses/LICENSE,sha256=PhUqiw6jAh2KbBdVRPBq_hfAvfcTBin7nZ3CK7NQbTM,11341
-dissect_cstruct-5.0.dev0.dist-info/METADATA,sha256=ujB3Cdxy5Yc--uXeWI4IIE24zn_t5r70jW_xmC7OBzc,9255
-dissect_cstruct-5.0.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-dissect_cstruct-5.0.dev0.dist-info/entry_points.txt,sha256=z53zqZqwD2OLrAkRwrP4wTeiU9CQe7xrMly0T2c0_wQ,71
-dissect_cstruct-5.0.dev0.dist-info/scm_file_list.json,sha256=K27Mlh84EZbq__O4ajx8gV0dOE5BF81hxo0Hvtrzz1U,2308
-dissect_cstruct-5.0.dev0.dist-info/scm_version.json,sha256=He7zR_9aI3hjUAyokmxGFi-iCH_17nbqSm6K2gebcEo,163
-dissect_cstruct-5.0.dev0.dist-info/top_level.txt,sha256=Mn-CQzEYsAbkxrUI0TnplHuXnGVKzxpDw_po_sXpvv4,8
-dissect_cstruct-5.0.dev0.dist-info/RECORD,,

dissect_cstruct-5.0.dev0.dist-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "5.0.dev0",
-  "distance": 0,
-  "node": "g7678a8f531377054d12afef5c69107e1e08b49a8",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-07-07"
-}