dissect.cstruct 4.8.dev3__tar.gz → 4.8.dev5__tar.gz

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 4.8.dev3
+Version: 4.8.dev5
 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
@@ -238,6 +238,26 @@ The API to access enum and flag members and their values in the same way as the
 ### Custom types
 You can implement your own types by subclassing `BaseType`, and adding them to your cstruct instance with `add_custom_type(name, type, size, alignment, ...)`
 
+### Dynamic length fields
+To read all remaining data in the provided buffer/stream, you can use the magic `EOF` size variable. This will automatically expand until the end of the stream has been reached and works for any field type. For example:
+
+```python
+from dissect.cstruct import cstruct
+
+eof_def = """
+struct example {
+    uint32 magic;
+    char data[EOF];
+};
+"""
+
+c_eof = cstruct().load(eof_def)
+
+example = c_eof.example(b"9\x05\x00\x00arbitrary length data")
+assert example.magic == 1337
+assert example.data == b"arbitrary length data"
+```
+
 ### Custom definition parsers
 Don't like the C-like definition syntax? Write your own syntax parser!
 

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/README.md

@@ -210,6 +210,26 @@ The API to access enum and flag members and their values in the same way as the
 ### Custom types
 You can implement your own types by subclassing `BaseType`, and adding them to your cstruct instance with `add_custom_type(name, type, size, alignment, ...)`
 
+### Dynamic length fields
+To read all remaining data in the provided buffer/stream, you can use the magic `EOF` size variable. This will automatically expand until the end of the stream has been reached and works for any field type. For example:
+
+```python
+from dissect.cstruct import cstruct
+
+eof_def = """
+struct example {
+    uint32 magic;
+    char data[EOF];
+};
+"""
+
+c_eof = cstruct().load(eof_def)
+
+example = c_eof.example(b"9\x05\x00\x00arbitrary length data")
+assert example.magic == 1337
+assert example.data == b"arbitrary length data"
+```
+
 ### Custom definition parsers
 Don't like the C-like definition syntax? Write your own syntax parser!
 

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.cstruct.bitbuffer import BitBuffer
 from dissect.cstruct.cstruct import cstruct, ctypes, ctypes_type
 from dissect.cstruct.exceptions import (

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/compiler.py

@@ -11,7 +11,6 @@ from typing import TYPE_CHECKING
 from dissect.cstruct.bitbuffer import BitBuffer
 from dissect.cstruct.types import (
     Array,
-    BaseType,
     Char,
     CharArray,
     Flag,
@@ -34,6 +33,9 @@ if TYPE_CHECKING:
     from types import MethodType
 
     from dissect.cstruct.cstruct import cstruct
+    from dissect.cstruct.types import (
+        BaseType,
+    )
     from dissect.cstruct.types.structure import Field
 
 SUPPORTED_TYPES = (

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/cstruct.py

@@ -12,12 +12,10 @@ from dissect.cstruct.expression import Expression
 from dissect.cstruct.parser import CStyleParser, TokenParser
 from dissect.cstruct.types import (
     LEB128,
-    Array,
     BaseArray,
     BaseType,
     Char,
     Enum,
-    Field,
     Flag,
     Int,
     Packed,
@@ -32,6 +30,11 @@ if TYPE_CHECKING:
     from collections.abc import Iterable
     from typing import TypeAlias
 
+    from dissect.cstruct.types import (
+        Array,
+        Field,
+    )
+
 
 T = TypeVar("T", bound=BaseType)
 

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/exceptions.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+
 class Error(Exception):
     pass
 

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/expression.py

@@ -225,7 +225,6 @@ class Expression:
 
     def evaluate(self, cs: cstruct, context: dict[str, int] | None = None) -> int:
         """Evaluates an expression using a Shunting-Yard implementation."""
-
         self.stack = []
         self.queue = []
         operators = set(self.binary_operators.keys()) | set(self.unary_operators.keys())

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/parser.py

@@ -11,10 +11,11 @@ from dissect.cstruct.exceptions import (
     ParserError,
 )
 from dissect.cstruct.expression import Expression
-from dissect.cstruct.types import BaseArray, BaseType, Field, Structure
+from dissect.cstruct.types import BaseArray, Field, Structure
 
 if TYPE_CHECKING:
     from dissect.cstruct import cstruct
+    from dissect.cstruct.types import BaseType
 
 
 class Parser:
@@ -37,7 +38,8 @@ class Parser:
 
 
 class TokenParser(Parser):
-    """
+    """Definition parser for C-like structure syntax.
+
     Args:
         cs: An instance of cstruct.
         compiled: Whether structs should be compiled or not.
@@ -421,8 +423,7 @@ class TokenParser(Parser):
 
     @staticmethod
     def _lineno(tok: Token) -> int:
-        """Quick and dirty line number calculator"""
-
+        """Quick and dirty line number calculator."""
         match = tok.match
         return match.string.count("\n", 0, match.start()) + 1
 
@@ -474,7 +475,7 @@ class TokenParser(Parser):
 
 
 class CStyleParser(Parser):
-    """Definition parser for C-like structure syntax.
+    """Definition parser for C-like structure syntax (legacy parser).
 
     Args:
         cs: An instance of cstruct

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/types/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from dissect.cstruct.types.base import Array, BaseArray, BaseType, MetaType
 from dissect.cstruct.types.char import Char, CharArray
 from dissect.cstruct.types.enum import Enum

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/types/enum.py

@@ -5,12 +5,13 @@ from enum import Enum as _Enum
 from enum import EnumMeta, IntEnum, IntFlag
 from typing import TYPE_CHECKING, Any, BinaryIO, TypeVar, overload
 
-from dissect.cstruct.types.base import Array, BaseType, MetaType
+from dissect.cstruct.types.base import BaseType, MetaType
 
 if TYPE_CHECKING:
     from typing_extensions import Self
 
     from dissect.cstruct.cstruct import cstruct
+    from dissect.cstruct.types.base import Array
 
 
 PY_311 = sys.version_info >= (3, 11, 0)

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect/cstruct/types/structure.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import io
 from collections import ChainMap
-from collections.abc import Callable, MutableMapping
+from collections.abc import MutableMapping
 from contextlib import contextmanager
 from enum import Enum
 from functools import lru_cache
@@ -23,7 +23,7 @@ from dissect.cstruct.types.enum import EnumMetaType
 from dissect.cstruct.types.pointer import Pointer
 
 if TYPE_CHECKING:
-    from collections.abc import Iterator, Mapping
+    from collections.abc import Callable, Iterator, Mapping
     from types import FunctionType
 
     from typing_extensions import Self
@@ -139,7 +139,7 @@ class StructureMetaType(MetaType):
 
         if cls.__compiled__:
             # If the previous class was compiled try to compile this too
-            from dissect.cstruct import compiler  # noqa: PLC0415
+            from dissect.cstruct import compiler
 
             try:
                 classdict["_read"] = compiler.Compiler(cls.cs).compile_read(fields, cls.__name__, align=cls.__align__)

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/dissect.cstruct.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dissect.cstruct
-Version: 4.8.dev3
+Version: 4.8.dev5
 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
@@ -238,6 +238,26 @@ The API to access enum and flag members and their values in the same way as the
 ### Custom types
 You can implement your own types by subclassing `BaseType`, and adding them to your cstruct instance with `add_custom_type(name, type, size, alignment, ...)`
 
+### Dynamic length fields
+To read all remaining data in the provided buffer/stream, you can use the magic `EOF` size variable. This will automatically expand until the end of the stream has been reached and works for any field type. For example:
+
+```python
+from dissect.cstruct import cstruct
+
+eof_def = """
+struct example {
+    uint32 magic;
+    char data[EOF];
+};
+"""
+
+c_eof = cstruct().load(eof_def)
+
+example = c_eof.example(b"9\x05\x00\x00arbitrary length data")
+assert example.magic == 1337
+assert example.data == b"arbitrary length data"
+```
+
 ### Custom definition parsers
 Don't like the C-like definition syntax? Write your own syntax parser!
 

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/pyproject.toml

@@ -94,7 +94,7 @@ select = [
   "SLOT",
   "SIM",
   "TID",
-  "TCH",
+  "TC",
   "PTH",
   "PLC",
   "TRY",
@@ -102,16 +102,35 @@ select = [
   "PERF",
   "FURB",
   "RUF",
+  "D"
 ]
-ignore = ["E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003"]
+
+ignore = [
+    "E203", "B904", "UP024", "ANN002", "ANN003", "ANN204", "ANN401", "SIM105", "TRY003", "PLC0415",
+    # Ignore some pydocstyle rules for now as they require a larger cleanup
+    "D1",
+    "D205",
+    "D301",
+    "D417",
+    # Seems bugged: https://github.com/astral-sh/ruff/issues/16824
+    "D402",
+]
+future-annotations = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.flake8-type-checking]
+strict = true
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**" = ["S101", "PLC0415"]
+"tests/**" = ["S101"]
 "tests/_docs/**" = ["INP001"]
 
 [tool.ruff.lint.isort]
 known-first-party = ["dissect.cstruct"]
 known-third-party = ["dissect"]
+required-imports = ["from __future__ import annotations"]
 
 [tool.setuptools.packages.find]
 include = ["dissect.*"]

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/tests/_docs/conf.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 project = "dissect.cstruct"
 
 extensions = [

{dissect_cstruct-4.8.dev3 → dissect_cstruct-4.8.dev5}/tests/test_types_union.py

@@ -444,7 +444,7 @@ def test_union_default(cs: cstruct) -> None:
 
 
 def test_union_default_dynamic(cs: cstruct) -> None:
-    """initialization of a dynamic union is not yet supported"""
+    """Initialization of a dynamic union is not yet supported."""
     cdef = """
     union test {
         uint8  x;
@@ -472,7 +472,7 @@ def test_union_default_dynamic(cs: cstruct) -> None:
 
 
 def test_union_partial_initialization(cs: cstruct) -> None:
-    """partial initialization of a union should fill in the rest with appropriate values"""
+    """Partial initialization of a union should fill in the rest with appropriate values."""
     cdef = """
     union test {
         uint8 a;
@@ -518,7 +518,7 @@ def test_union_partial_initialization(cs: cstruct) -> None:
 
 
 def test_union_partial_initialization_dynamic(cs: cstruct) -> None:
-    """partial initialization of a dynamic union should fill in the rest with appropriate values"""
+    """Partial initialization of a dynamic union should fill in the rest with appropriate values."""
     cdef = """
     union test {
         uint8  x;