Removed unncessary parameter in transformer

The "instance" argument in JavaInstance.load_from_instance()
is unncessary: it is self.

Author: tcalmant

README.rst

@@ -183,17 +183,36 @@ the ``javaobj.v2.transformer`` module to see the whole implementation.
            dict.__init__(self)
            JavaInstance.__init__(self)
 
-       def load_from_instance(self, instance, indent=0):
-           # type: (JavaInstance, int) -> bool
+      def load_from_blockdata(self, parser, reader, indent=0):
+        """
+        Reads content stored in a block data.
+
+        This method is called only if the class description has both the
+        ``SC_EXTERNALIZABLE`` and ``SC_BLOCK_DATA`` flags set.
+
+        The stream parsing will stop and fail if this method returns False.
+
+        :param parser: The JavaStreamParser in use
+        :param reader: The underlying data stream reader
+        :param indent: Indentation to use in logs
+        :return: True on success, False on error
+        """
+        # This kind of class is not supposed to have the SC_BLOCK_DATA flag set
+        return False
+
+       def load_from_instance(self, indent=0):
+           # type: (int) -> bool
            """
-           Load content from a parsed instance object
+           Load content from the parsed instance object.
+
+           This method is called after the block data (if any), the fields and
+           the annotations have been loaded.
 
-           :param instance: The currently loaded instance
            :param indent: Indentation to use while logging
-           :return: True on success
+           :return: True on success (currently ignored)
            """
            # Maps have their content in their annotations
-           for cd, annotations in instance.annotations.items():
+           for cd, annotations in self.annotations.items():
                # Annotations are associated to their definition class
                if cd.name == "java.util.HashMap":
                    # We are in the annotation created by the handled class
@@ -210,6 +229,10 @@ the ``javaobj.v2.transformer`` module to see the whole implementation.
            return False
 
    class MapObjectTransformer(javaobj.v2.api.ObjectTransformer):
+       """
+       Creates a JavaInstance object with custom loading methods for the
+       classes it can handle
+       """
        def create_instance(self, classdesc):
            # type: (JavaClassDesc) -> Optional[JavaInstance]
            """
@@ -219,8 +242,8 @@ the ``javaobj.v2.transformer`` module to see the whole implementation.
            :return: The Python form of the object, or the original JavaObject
            """
            if classdesc.name == "java.util.HashMap":
-               # We can handle it
+               # We can handle this class description
                return JavaMap()
            else:
-               # Return None if not handled
+               # Return None if the class is not handled
                return None

javaobj/v2/beans.py

@@ -430,13 +430,28 @@ def get_class(self):
 
     def load_from_blockdata(self, parser, reader, indent=0):
         """
-        Reads content stored in a block data
+        Reads content stored in a block data.
+
+        This method is called only if the class description has both the
+        ``SC_EXTERNALIZABLE`` and ``SC_BLOCK_DATA`` flags set.
+
+        The stream parsing will stop and fail if this method returns False.
+
+        :param parser: The JavaStreamParser in use
+        :param reader: The underlying data stream reader
+        :param indent: Indentation to use in logs
+        :return: True on success, False on error
         """
         return False
 
-    def load_from_instance(self, instance, indent=0):
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
-        Load content from a parsed instance object
+        Updates the content of this instance from its parsed fields and
+        annotations
+
+        :param indent: Indentation to use in logs
+        :return: True on success, False on error (currently ignored)
         """
         return False
 

javaobj/v2/core.py

@@ -532,7 +532,7 @@ def _read_class_data(self, instance):
         instance.field_data = all_data
 
         # Load transformation from the fields and annotations
-        instance.load_from_instance(instance)
+        instance.load_from_instance()
 
     def _read_field_value(self, field_type):
         # type: (FieldType) -> Any

javaobj/v2/transformers.py

@@ -55,13 +55,13 @@ def __init__(self):
         list.__init__(self)
         JavaInstance.__init__(self)
 
-    def load_from_instance(self, instance, indent=0):
-        # type: (JavaInstance, int) -> bool
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
         Load content from a parsed instance object
         """
         # Lists have their content in there annotations
-        for cd, annotations in instance.annotations.items():
+        for cd, annotations in self.annotations.items():
             if cd.name in self.HANDLED_CLASSES:
                 self.extend(ann for ann in annotations[1:])
                 return True
@@ -94,12 +94,12 @@ def __eq__(self, other):
     def __lt__(self, other):
         return self.value < other
 
-    def load_from_instance(self, instance, indent=0):
-        # type: (JavaInstance, int) -> bool
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
         Load content from a parsed instance object
         """
-        for fields in instance.field_data.values():
+        for fields in self.field_data.values():
             for field, value in fields.items():
                 if field.name == "value":
                     self.value = value
@@ -134,13 +134,13 @@ def __init__(self):
         dict.__init__(self)
         JavaInstance.__init__(self)
 
-    def load_from_instance(self, instance, indent=0):
-        # type: (JavaInstance, int) -> bool
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
         Load content from a parsed instance object
         """
         # Maps have their content in there annotations
-        for cd, annotations in instance.annotations.items():
+        for cd, annotations in self.annotations.items():
             if cd.name in JavaMap.HANDLED_CLASSES:
                 # Group annotation elements 2 by 2
                 args = [iter(annotations[1:])] * 2
@@ -201,13 +201,13 @@ def __init__(self):
         set.__init__(self)
         JavaInstance.__init__(self)
 
-    def load_from_instance(self, instance, indent=0):
-        # type: (JavaInstance, int) -> bool
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
         Load content from a parsed instance object
         """
         # Lists have their content in there annotations
-        for cd, annotations in instance.annotations.items():
+        for cd, annotations in self.annotations.items():
             if cd.name in self.HANDLED_CLASSES:
                 self.update(x for x in annotations[1:])
                 return True
@@ -222,13 +222,13 @@ class JavaTreeSet(JavaSet):
 
     HANDLED_CLASSES = "java.util.TreeSet"
 
-    def load_from_instance(self, instance, indent=0):
-        # type: (JavaInstance, int) -> bool
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
         Load content from a parsed instance object
         """
         # Lists have their content in there annotations
-        for cd, annotations in instance.annotations.items():
+        for cd, annotations in self.annotations.items():
             if cd.name == self.HANDLED_CLASSES:
                 # Annotation[1] == size of the set
                 self.update(x for x in annotations[2:])
@@ -300,19 +300,19 @@ def __str__(self):
             "nano={s.nano}, offset={s.offset}, zone={s.zone})"
         ).format(s=self)
 
-    def load_from_blockdata(self, reader, indent=0):
+    def load_from_blockdata(self, parser, reader, indent=0):
         """
         Ignore the SC_BLOCK_DATA flag
         """
         return True
 
-    def load_from_instance(self, instance, indent=0):
-        # type: (JavaInstance, int) -> bool
+    def load_from_instance(self, indent=0):
+        # type: (int) -> bool
         """
         Load content from a parsed instance object
         """
         # Lists have their content in there annotations
-        for cd, annotations in instance.annotations.items():
+        for cd, annotations in self.annotations.items():
             if cd.name == self.HANDLED_CLASSES:
                 # Convert back annotations to bytes
                 # latin-1 is used to ensure that bytes are kept as is