Using new transformers with deserialize

Work in progress

Author: tcalmant

javaobj/api.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+"""
+Definition of the object transformer API
+"""
+
+from typing import Optional
+
+from .deserialize.beans import JavaClassDesc, JavaInstance
+
+
+class JavaStreamParser:
+    pass
+
+
+class ObjectTransformer:
+    """
+    Representation of an object transformer
+    """
+
+    def create(
+        self,
+        classdesc: JavaClassDesc,
+        parser: Optional[JavaStreamParser] = None,
+    ) -> Optional[JavaInstance]:
+        """
+        Transforms a parsed Java object into a Python object
+
+        :param classdesc: The description of a Java class
+        :return: The Python form of the object, or the original JavaObject
+        """
+        raise NotImplementedError

javaobj/core.py

@@ -2000,7 +2000,7 @@ def do_period(self, unmarshaller, data):
     }
 
     def create(self, classdesc, unmarshaller=None):
-        # type: (JavaClass, JavaObjectUnmarshaller) -> JavaObject
+        # type: (JavaClassDesc, JavaObjectUnmarshaller) -> JavaObject
         """
         Transforms a deserialized Java object into a Python object
 

javaobj/deserialize/beans.py

@@ -7,7 +7,8 @@
 from typing import Any, Dict, List, Optional, Set
 import logging
 
-from .constants import *
+from . import constants
+from .stream import DataStreamReader
 from ..modifiedutf8 import decode_modified_utf8
 
 
@@ -40,19 +41,19 @@ class FieldType(IntEnum):
     Types of class fields
     """
 
-    BYTE = TYPE_BYTE
-    CHAR = TYPE_CHAR
-    DOUBLE = TYPE_DOUBLE
-    FLOAT = TYPE_FLOAT
-    INTEGER = TYPE_INTEGER
-    LONG = TYPE_LONG
-    SHORT = TYPE_SHORT
-    BOOLEAN = TYPE_BOOLEAN
-    ARRAY = TYPE_ARRAY
-    OBJECT = TYPE_OBJECT
+    BYTE = constants.TYPE_BYTE
+    CHAR = constants.TYPE_CHAR
+    DOUBLE = constants.TYPE_DOUBLE
+    FLOAT = constants.TYPE_FLOAT
+    INTEGER = constants.TYPE_INTEGER
+    LONG = constants.TYPE_LONG
+    SHORT = constants.TYPE_SHORT
+    BOOLEAN = constants.TYPE_BOOLEAN
+    ARRAY = constants.TYPE_ARRAY
+    OBJECT = constants.TYPE_OBJECT
 
 
-class Content:
+class ParsedJavaContent:
     """
     Generic representation of data parsed from the stream
     """
@@ -69,12 +70,12 @@ def validate(self) -> None:
         pass
 
 
-class ExceptionState(Content):
+class ExceptionState(ParsedJavaContent):
     """
     Representation of a failed parsing
     """
 
-    def __init__(self, exception_object: Content, data: bytes):
+    def __init__(self, exception_object: ParsedJavaContent, data: bytes):
         super().__init__(ContentType.EXCEPTIONSTATE)
         self.exception_object = exception_object
         self.stream_data = data
@@ -86,11 +87,11 @@ class ExceptionRead(Exception):
     Exception used to indicate that an exception object has been parsed
     """
 
-    def __init__(self, content: Content):
+    def __init__(self, content: ParsedJavaContent):
         self.exception_object = content
 
 
-class JavaString(Content):
+class JavaString(ParsedJavaContent):
     """
     Represents a Java string
     """
@@ -141,7 +142,7 @@ def validate(self, java_type: str) -> None:
                 )
 
 
-class JavaClassDesc(Content):
+class JavaClassDesc(ParsedJavaContent):
     """
     Represents the description of a class
     """
@@ -168,7 +169,7 @@ def __init__(self, class_desc_type: ClassDescType):
         self.inner_classes: List[JavaClassDesc] = []
 
         # List of annotations objects
-        self.annotations: List[Content] = []
+        self.annotations: List[ParsedJavaContent] = []
 
         # The super class of this one, if any
         self.super_class: JavaClassDesc = None
@@ -221,7 +222,9 @@ def validate(self):
         """
         Checks the validity of this class description
         """
-        serial_or_extern = SC_SERIALIZABLE | SC_EXTERNALIZABLE
+        serial_or_extern = (
+            constants.SC_SERIALIZABLE | constants.SC_EXTERNALIZABLE
+        )
         if (self.desc_flags & serial_or_extern) == 0 and self.fields:
             raise ValueError(
                 "Non-serializable, non-externalizable class has fields"
@@ -230,7 +233,7 @@ def validate(self):
         if self.desc_flags & serial_or_extern == serial_or_extern:
             raise ValueError("Class is both serializable and externalizable")
 
-        if self.desc_flags & SC_ENUM:
+        if self.desc_flags & constants.SC_ENUM:
             if self.fields or self.interfaces:
                 raise ValueError(
                     "Enums shouldn't implement interfaces "
@@ -243,7 +246,7 @@ def validate(self):
                 )
 
 
-class JavaInstance(Content):
+class JavaInstance(ParsedJavaContent):
     """
     Represents an instance of Java object
     """
@@ -252,7 +255,7 @@ def __init__(self):
         super().__init__(ContentType.INSTANCE)
         self.classdesc: JavaClassDesc = None
         self.field_data: Dict[JavaClassDesc, Dict[JavaField, Any]] = {}
-        self.annotations: Dict[JavaClassDesc, List[Content]] = {}
+        self.annotations: Dict[JavaClassDesc, List[ParsedJavaContent]] = {}
 
     def __str__(self):
         return "[instance 0x{0:x}: type {1}]".format(
@@ -261,8 +264,24 @@ def __str__(self):
 
     __repr__ = __str__
 
+    def load_from_blockdata(
+        self, reader: DataStreamReader, indent: int = 0
+    ) -> bool:
+        """
+        Reads content stored in a block data
+        """
+        return False
+
+    def load_from_instance(
+        self, instance: "JavaInstance", indent: int = 0
+    ) -> bool:
+        """
+        Load content from a parsed instance object
+        """
+        return False
+
 
-class JavaClass(Content):
+class JavaClass(ParsedJavaContent):
     """
     Represents a stored Java class
     """
@@ -278,7 +297,7 @@ def __str__(self):
     __repr__ = __str__
 
 
-class JavaEnum(Content):
+class JavaEnum(ParsedJavaContent):
     """
     Represents an enumeration value
     """
@@ -297,7 +316,7 @@ def __str__(self):
     __repr__ = __str__
 
 
-class JavaArray(Content):
+class JavaArray(ParsedJavaContent):
     """
     Represents a Java array
     """
@@ -323,7 +342,7 @@ def __str__(self):
     __repr__ = __str__
 
 
-class BlockData(Content):
+class BlockData(ParsedJavaContent):
     """
     Represents a data block
     """