Fixed Flake8 issues in v2

Type hinting on non-imported types

Author: tcalmant

javaobj/v2/api.py

@@ -26,11 +26,15 @@
 
 from __future__ import absolute_import
 
-from typing import Optional
+from typing import List, Optional
 
-from .beans import JavaClassDesc, JavaInstance  # pylint:disable=W0611
-from .stream import DataStreamReader  # pylint:disable=W0611
 from ..constants import TypeCode  # pylint:disable=W0611
+from .beans import (  # pylint:disable=W0611
+    JavaClassDesc,
+    JavaInstance,
+    ParsedJavaContent,
+)
+from .stream import DataStreamReader  # pylint:disable=W0611
 
 # ------------------------------------------------------------------------------
 
@@ -44,6 +48,32 @@
 # ------------------------------------------------------------------------------
 
 
+class IJavaStreamParser:
+    """
+    API of the Java stream parser
+    """
+
+    def run(self):
+        # type: () -> List[ParsedJavaContent]
+        """
+        Parses the input stream
+        """
+        raise NotImplementedError
+
+    def dump(self, content):
+        # type: (List[ParsedJavaContent]) -> str
+        """
+        Dumps to a string the given objects
+        """
+        raise NotImplementedError
+
+    def _read_content(self, type_code, block_data, class_desc=None):
+        # type: (int, bool, Optional[JavaClassDesc]) -> ParsedJavaContent
+        """
+        Parses the next content. Use with care (use only in a transformer)
+        """
+
+
 class ObjectTransformer(object):  # pylint:disable=R0205
     """
     Representation of an object transformer
@@ -84,7 +114,7 @@ def load_array(
     def load_custom_writeObject(
         self, parser, reader, name
     ):  # pylint:disable=W0613,R0201
-        # type: (JavaStreamParser, DataStreamReader, str) -> Optional[JavaClassDesc]
+        # type: (IJavaStreamParser, DataStreamReader, str) -> Optional[JavaClassDesc]
         """
         Reads content stored from a custom writeObject.
 

javaobj/v2/beans.py

@@ -26,12 +26,12 @@
 
 from __future__ import absolute_import
 
+import logging
 from enum import IntEnum
 from typing import Any, Dict, List, Optional, Set
-import logging
 
 from ..constants import ClassDescFlags, TypeCode
-from ..modifiedutf8 import decode_modified_utf8, byte_to_int
+from ..modifiedutf8 import byte_to_int, decode_modified_utf8
 from ..utils import UNICODE_TYPE
 
 # ------------------------------------------------------------------------------

javaobj/v2/core.py

@@ -27,46 +27,45 @@
 
 from __future__ import absolute_import
 
-from typing import (
+import logging
+import os
+from typing import (  # pylint:disable=W0611
+    IO,
     Any,
     Callable,
     Dict,
-    IO,
     List,
     Optional,
-)  # pylint:disable=W0611
-import logging
-import os
+)
 
+from ..constants import (
+    PRIMITIVE_TYPES,
+    StreamConstants,
+    TerminalCode,
+    TypeCode,
+)
+from ..modifiedutf8 import (  # pylint:disable=W0611  # noqa: F401
+    decode_modified_utf8,
+)
 from . import api  # pylint:disable=W0611
 from .beans import (
-    ParsedJavaContent,
     BlockData,
-    JavaClassDesc,
-    JavaClass,
+    ClassDataType,
+    ClassDescType,
+    ExceptionRead,
+    ExceptionState,
+    FieldType,
     JavaArray,
+    JavaClass,
+    JavaClassDesc,
     JavaEnum,
     JavaField,
     JavaInstance,
     JavaString,
-    ExceptionState,
-    ExceptionRead,
-    ClassDescType,
-    FieldType,
-    ClassDataType,
+    ParsedJavaContent,
 )
 from .stream import DataStreamReader
 from .transformers import DefaultObjectTransformer
-from ..constants import (
-    StreamConstants,
-    TerminalCode,
-    TypeCode,
-    PRIMITIVE_TYPES,
-)
-
-from ..modifiedutf8 import (
-    decode_modified_utf8,
-)  # pylint:disable=W0611  # noqa: F401
 
 # ------------------------------------------------------------------------------
 
@@ -80,7 +79,7 @@
 # ------------------------------------------------------------------------------
 
 
-class JavaStreamParser:
+class JavaStreamParser(api.IJavaStreamParser):
     """
     Parses a Java stream
     """

javaobj/v2/main.py

@@ -5,7 +5,7 @@
 
 from __future__ import absolute_import
 
-from typing import Any, IO  # pylint:disable=W0611
+from typing import IO, Any  # pylint:disable=W0611
 
 try:
     # Python 2
@@ -14,10 +14,10 @@
     # Python 3+
     from io import BytesIO
 
+from ..utils import java_data_fd
 from .api import ObjectTransformer  # pylint:disable=W0611
 from .core import JavaStreamParser
 from .transformers import DefaultObjectTransformer, NumpyArrayTransformer
-from ..utils import java_data_fd
 
 # ------------------------------------------------------------------------------
 

javaobj/v2/stream.py

@@ -26,11 +26,11 @@
 
 from __future__ import absolute_import
 
-from typing import Any, IO, Tuple  # pylint:disable=W0611
 import struct
+from typing import IO, Any, Tuple  # pylint:disable=W0611
 
 from ..modifiedutf8 import decode_modified_utf8
-from ..utils import unicode_char, UNICODE_TYPE  # pylint:disable=W0611
+from ..utils import UNICODE_TYPE, unicode_char  # pylint:disable=W0611
 
 # ------------------------------------------------------------------------------
 

javaobj/v2/transformers.py

@@ -25,25 +25,25 @@
 """
 
 # Standard library
-from typing import List, Optional, Tuple
 import functools
+from typing import List, Optional, Tuple
 
 # Numpy (optional)
 try:
     import numpy
 except ImportError:
-    numpy = None
-
+    numpy = None  # type: ignore
 
 # Javaobj
-from .api import ObjectTransformer
-from .beans import (
-    JavaInstance,
-    JavaClassDesc,
-    BlockData,
-)  # pylint:disable=W0611
 from ..constants import TerminalCode, TypeCode
-from ..utils import to_bytes, log_error, log_debug, read_struct, read_string
+from ..utils import log_debug, log_error, read_string, read_struct, to_bytes
+from .api import IJavaStreamParser, ObjectTransformer
+from .beans import ( # pylint:disable=W0611
+    BlockData,
+    JavaClassDesc,
+    JavaInstance,
+)
+from .stream import DataStreamReader
 
 # ------------------------------------------------------------------------------
 
@@ -183,7 +183,7 @@ class JavaLinkedHashMap(JavaMap):
     HANDLED_CLASSES = ("java.util.LinkedHashMap",)
 
     def load_from_blockdata(self, parser, reader, indent=0):
-        # type: (JavaStreamParser, DataStreamReader, int) -> bool
+        # type: (IJavaStreamParser, DataStreamReader, int) -> bool
         """
         Loads the content of the map, written with a custom implementation
         """