Code review, disabled some pylint warnings, format

Author: tcalmant

javaobj/modifiedutf8.py

@@ -33,7 +33,7 @@
 # ------------------------------------------------------------------------------
 
 if sys.version_info[0] >= 3:
-    unicode_char = chr
+    unicode_char = chr  # pylint:disable=C0103
 
     def byte_to_int(data):
         # type: (bytes) -> int
@@ -42,12 +42,17 @@ def byte_to_int(data):
         """
         if isinstance(data, int):
             return data
-        elif isinstance(data, bytes):
+
+        if isinstance(data, bytes):
             return data[0]
 
+        raise ValueError("Didn't get a byte as input")
+
 
 else:
-    unicode_char = unichr  # pylint:disable=undefined-variable  # noqa: F821
+    unicode_char = (
+        unichr  # pylint:disable=C0103,undefined-variable  # noqa: F821
+    )
 
     def byte_to_int(data):
         # type: (bytes) -> int
@@ -56,14 +61,17 @@ def byte_to_int(data):
         """
         if isinstance(data, int):
             return data
-        elif isinstance(data, str):
+
+        if isinstance(data, str):
             return ord(data[0])
 
+        raise ValueError("Didn't get a byte as input")
+
 
 # ------------------------------------------------------------------------------
 
 
-class DecodeMap(object):
+class DecodeMap(object):  # pylint:disable=R0205
     """
     A utility class which manages masking, comparing and mapping in bits.
     If the mask and compare fails, this will raise UnicodeDecodeError so
@@ -167,14 +175,16 @@ def next_byte(_it, start, count):
             raise UnicodeDecodeError(
                 NAME, data, i, i + 1, "embedded zero-byte not allowed"
             )
-        elif d & 0x80:  # 1xxxxxxx
+
+        if d & 0x80:  # 1xxxxxxx
             if d & 0x40:  # 11xxxxxx
                 if d & 0x20:  # 111xxxxx
                     if d & 0x10:  # 1111xxxx
                         raise UnicodeDecodeError(
                             NAME, data, i, i + 1, "invalid encoding character"
                         )
-                    elif d == 0xED:
+
+                    if d == 0xED:
                         value = 0
                         for i1, dm in enumerate(DECODE_MAP[6]):
                             d1 = next_byte(it, i, i1 + 1)
@@ -221,7 +231,8 @@ def decode_modified_utf8(data, errors="strict"):
         except UnicodeDecodeError as e:
             if errors == "strict":
                 raise e
-            elif errors == "ignore":
+
+            if errors == "ignore":
                 pass
             elif errors == "replace":
                 value += "\uFFFD"
@@ -230,4 +241,7 @@ def decode_modified_utf8(data, errors="strict"):
 
 
 def mutf8_unichr(value):
+    """
+    Mimics Python 2 unichr() and Python 3 chr()
+    """
     return unicode_char(value)

javaobj/utils.py

@@ -30,7 +30,7 @@
 from __future__ import absolute_import
 
 # Standard library
-from typing import Any, Tuple  # noqa: F401
+from typing import Tuple  # noqa: F401
 import logging
 import struct
 import sys
@@ -117,7 +117,7 @@ def hexdump(src, start_offset=0, length=16):
     :param length: Length of a dump line
     :return: A dump string
     """
-    FILTER = "".join(
+    hex_filter = "".join(
         (len(repr(chr(x))) == 3) and chr(x) or "." for x in range(256)
     )
     pattern = "{{0:04X}}   {{1:<{0}}}  {{2}}\n".format(length * 3)
@@ -129,7 +129,7 @@ def hexdump(src, start_offset=0, length=16):
     for i in range(0, len(src), length):
         s = src[i : i + length]
         hexa = " ".join("{0:02X}".format(ord(x)) for x in s)
-        printable = s.translate(FILTER)
+        printable = s.translate(hex_filter)
         result.append(pattern.format(i + start_offset, hexa, printable))
 
     return "".join(result)
@@ -139,11 +139,14 @@ def hexdump(src, start_offset=0, length=16):
 
 
 if sys.version_info[0] >= 3:
-    BYTES_TYPE = bytes
-    UNICODE_TYPE = str
-    unicode_char = chr
+    BYTES_TYPE = bytes  # pylint:disable=C0103
+    UNICODE_TYPE = str  # pylint:disable=C0103
+    unicode_char = chr  # pylint:disable=C0103
 
     def bytes_char(c):
+        """
+        Converts the given character to a bytes string
+        """
         return bytes((c,))
 
     # Python 3 interpreter : bytes & str
@@ -156,7 +159,7 @@ def to_bytes(data, encoding="UTF-8"):
         :param encoding: The encoding of data
         :return: The corresponding array of bytes
         """
-        if type(data) is bytes:
+        if type(data) is bytes:  # pylint:disable=C0123
             # Nothing to do
             return data
         return data.encode(encoding)
@@ -170,7 +173,7 @@ def to_str(data, encoding="UTF-8"):
         :param encoding: The encoding of data
         :return: The corresponding string
         """
-        if type(data) is str:
+        if type(data) is str:  # pylint:disable=C0123
             # Nothing to do
             return data
         try:
@@ -179,7 +182,7 @@ def to_str(data, encoding="UTF-8"):
             return decode_modified_utf8(data)[0]
 
     # Same operation
-    to_unicode = to_str
+    to_unicode = to_str  # pylint:disable=C0103
 
     def read_to_str(data):
         """
@@ -189,10 +192,14 @@ def read_to_str(data):
 
 
 else:
-    BYTES_TYPE = str
-    UNICODE_TYPE = unicode  # pylint:disable=undefined-variable  # noqa: F821
-    unicode_char = unichr  # pylint:disable=undefined-variable  # noqa: F821
-    bytes_char = chr
+    BYTES_TYPE = str  # pylint:disable=C0103
+    UNICODE_TYPE = (
+        unicode  # pylint:disable=C0103,undefined-variable  # noqa: F821
+    )
+    unicode_char = (
+        unichr  # pylint:disable=C0103,undefined-variable  # noqa: F821
+    )
+    bytes_char = chr  # pylint:disable=C0103
 
     # Python 2 interpreter : str & unicode
     def to_str(data, encoding="UTF-8"):
@@ -204,13 +211,13 @@ def to_str(data, encoding="UTF-8"):
         :param encoding: The encoding of data
         :return: The corresponding string
         """
-        if type(data) is str:
+        if type(data) is str:  # pylint:disable=C0123
             # Nothing to do
             return data
         return data.encode(encoding)
 
     # Same operation
-    to_bytes = to_str
+    to_bytes = to_str  # pylint:disable=C0103
 
     # Python 2 interpreter : str & unicode
     def to_unicode(data, encoding="UTF-8"):
@@ -222,7 +229,7 @@ def to_unicode(data, encoding="UTF-8"):
         :param encoding: The encoding of data
         :return: The corresponding string
         """
-        if type(data) is UNICODE_TYPE:
+        if type(data) is UNICODE_TYPE:  # pylint:disable=C0123
             # Nothing to do
             return data
         try:

javaobj/v1/beans.py

@@ -53,7 +53,7 @@
 # ------------------------------------------------------------------------------
 
 
-class JavaClass(object):
+class JavaClass(object):  # pylint:disable=R0205
     """
     Represents a class in the Java world
     """
@@ -63,7 +63,7 @@ def __init__(self):
         Sets up members
         """
         self.name = None  # type: str
-        self.serialVersionUID = None  # type: int
+        self.serialVersionUID = None  # type: int  # pylint:disable=C0103
         self.flags = None  # type: int
         self.fields_names = []  # type: List[str]
         self.fields_types = []  # type: List[JavaString]
@@ -101,7 +101,7 @@ def __eq__(self, other):
         )
 
 
-class JavaObject(object):
+class JavaObject(object):  # pylint:disable=R0205
     """
     Represents a deserialized non-primitive Java object
     """

javaobj/v1/marshaller.py

@@ -120,7 +120,7 @@ def dump(self, obj):
         self.writeObject(obj)
         return self.object_stream.getvalue()
 
-    def _writeStreamHeader(self):
+    def _writeStreamHeader(self):  # pylint:disable=C0103
         """
         Writes the Java serialization magic header in the serialization stream
         """
@@ -130,7 +130,7 @@ def _writeStreamHeader(self):
             (StreamConstants.STREAM_MAGIC, StreamConstants.STREAM_VERSION),
         )
 
-    def writeObject(self, obj):
+    def writeObject(self, obj):  # pylint:disable=C0103
         """
         Appends an object to the serialization stream
 
@@ -156,7 +156,7 @@ def writeObject(self, obj):
         elif obj is None:
             # Null
             self.write_null()
-        elif type(obj) is str:
+        elif type(obj) is str:  # pylint:disable=C0123
             # String value
             self.write_blockdata(obj)
         else:
@@ -166,7 +166,7 @@ def writeObject(self, obj):
                 "supported.".format(type(obj))
             )
 
-    def _writeStruct(self, unpack, length, args):
+    def _writeStruct(self, unpack, length, args):  # pylint:disable=C0103
         """
         Appends data to the serialization stream
 
@@ -177,7 +177,7 @@ def _writeStruct(self, unpack, length, args):
         ba = struct.pack(unpack, *args)
         self.object_stream.write(ba)
 
-    def _writeString(self, obj, use_reference=True):
+    def _writeString(self, obj, use_reference=True):  # pylint:disable=C0103
         """
         Appends a string to the serialization stream
 
@@ -270,7 +270,7 @@ def write_enum(self, obj):
 
         self.write_string(obj.constant)
 
-    def write_blockdata(self, obj, parent=None):
+    def write_blockdata(self, obj, parent=None):  # pylint:disable=W0613
         """
         Appends a block of data to the serialization stream
 
@@ -374,7 +374,7 @@ def write_object(self, obj, parent=None):
                     self.writeObject(annotation)
             self._writeStruct(">B", 1, (TerminalCode.TC_ENDBLOCKDATA,))
 
-    def write_class(self, obj, parent=None):
+    def write_class(self, obj, parent=None):  # pylint:disable=W0613
         """
         Writes a class to the stream
 
@@ -384,7 +384,7 @@ def write_class(self, obj, parent=None):
         self._writeStruct(">B", 1, (TerminalCode.TC_CLASS,))
         self.write_classdesc(obj)
 
-    def write_classdesc(self, obj, parent=None):
+    def write_classdesc(self, obj, parent=None):  # pylint:disable=W0613
         """
         Writes a class description
 
@@ -553,9 +553,11 @@ def _convert_type_to_char(type_char):
         """
         if isinstance(type_char, TypeCode):
             return type_char.value
-        elif isinstance(type_char, int):
+
+        if isinstance(type_char, int):
             return type_char
-        elif isinstance(type_char, (BYTES_TYPE, UNICODE_TYPE)):
+
+        if isinstance(type_char, (BYTES_TYPE, UNICODE_TYPE)):
             # Conversion to TypeCode will raise an error if the type
             # is invalid
             return TypeCode(ord(type_char[0])).value

javaobj/v1/transformers.py

@@ -45,7 +45,7 @@
 __all__ = ("DefaultObjectTransformer",)
 
 
-class DefaultObjectTransformer(object):
+class DefaultObjectTransformer(object):  # pylint:disable=R0205
     """
     Default transformer for the deserialized objects.
     Converts JavaObject objects to Python types (maps, lists, ...)

javaobj/v1/unmarshaller.py

@@ -329,7 +329,7 @@ def do_classdesc(self, parent=None, ident=0):
                     expect=(TerminalCode.TC_STRING, TerminalCode.TC_REFERENCE),
                 )
 
-                if type(field_type) is not JavaString:
+                if type(field_type) is not JavaString:  # pylint:disable=C0123
                     raise AssertionError(
                         "Field type must be a JavaString, "
                         "not {0}".format(type(field_type))
@@ -345,7 +345,7 @@ def do_classdesc(self, parent=None, ident=0):
                     # FIXME: ugly trick
                     field_type = JavaString(field_type.name)
 
-                if type(field_type) is not JavaString:
+                if type(field_type) is not JavaString:  # pylint:disable=C0123
                     raise AssertionError(
                         "Field type must be a JavaString, "
                         "not {0}".format(type(field_type))
@@ -367,8 +367,8 @@ def do_classdesc(self, parent=None, ident=0):
             clazz.fields_types.append(field_type)
 
         if parent:
-            parent.__fields = clazz.fields_names
-            parent.__types = clazz.fields_types
+            parent.__fields = clazz.fields_names  # pylint:disable=W0212
+            parent.__types = clazz.fields_types  # pylint:disable=W0212
 
         # classAnnotation
         (opid,) = self._readStruct(">B")
@@ -714,7 +714,10 @@ def do_enum(self, parent=None, ident=0):
         )
         enum.classdesc = classdesc
         self._add_reference(enum, ident)
-        _, enumConstantName = self._read_and_exec_opcode(
+        (
+            _,
+            enumConstantName,
+        ) = self._read_and_exec_opcode(  # pylint:disable=C0103
             ident=ident + 1,
             expect=(TerminalCode.TC_STRING, TerminalCode.TC_REFERENCE),
         )