feat: add inflate shortcut

Author: MrIndeciso

libdestruct/__init__.py

@@ -17,7 +17,7 @@
 from libdestruct.common.enum import enum, enum_of
 from libdestruct.common.ptr import ptr
 from libdestruct.common.struct import ptr_to, ptr_to_self, struct
-from libdestruct.libdestruct import inflater
+from libdestruct.libdestruct import inflate, inflater
 
 __all__ = [
     "array",
@@ -30,6 +30,7 @@
     "c_ulong",
     "enum",
     "enum_of",
+    "inflate",
     "inflater",
     "struct",
     "ptr",

libdestruct/libdestruct.py

@@ -6,14 +6,37 @@
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from typing import TYPE_CHECKING
 
+from libdestruct.backing.resolver import Resolver
 from libdestruct.common.inflater import Inflater
 
-if TYPE_CHECKING: # pragma: no cover
-    from collections.abc import MutableSequence
+if TYPE_CHECKING:  # pragma: no cover
 
+    from libdestruct.common.obj import obj
 
-def inflater(memory: MutableSequence) -> Inflater:
+
+def inflater(memory: Sequence) -> Inflater:
     """Return a TypeInflater instance."""
+    if not isinstance(memory, Sequence):
+        raise TypeError(f"memory must be a MutableSequence, not {type(memory).__name__}")
+
     return Inflater(memory)
+
+
+def inflate(item: type, memory: Sequence, address: int | Resolver) -> obj:
+    """Inflate a memory-referencing type.
+
+    Args:
+        item: The type to inflate.
+        memory: The memory view, which can be mutable or immutable.
+        address: The address of the object in the memory view.
+
+    Returns:
+        The inflated object.
+    """
+    if not isinstance(address, int) and not isinstance(address, Resolver):
+        raise TypeError(f"address must be an int or a Resolver, not {type(address).__name__}")
+
+    return inflater(memory).inflate(item, address)