Fix imports

* Move type aliases to a separate module

Author: MarkKoz

algorithm_visualizer/__init__.py

@@ -1,23 +1,18 @@
 import atexit
 import json
 import os
-from typing import Union
 
-from algorithm_visualizer import randomize as Randomize
-from algorithm_visualizer.commander import Commander
-from algorithm_visualizer.layouts import *
-from algorithm_visualizer.tracers import *
+from . import randomize as Randomize
+from .commander import Commander
+from .layouts import *
+from .tracers import *
 
 __all__ = (
     "Randomize", "Commander",
     "Array1DTracer", "Array2DTracer", "ChartTracer", "GraphTracer", "LogTracer", "Tracer",
     "HorizontalLayout", "Layout", "VerticalLayout"
 )
 
-# Types which are serializable by the default JSONEncoder
-_Serializable = Union[dict, list, str, int, float, bool, None]
-_Number = Union[int, float]
-
 
 @atexit.register
 def execute():

algorithm_visualizer/commander.py

@@ -1,7 +1,8 @@
 import string
 from typing import Any, Dict, List, Optional
 
-from algorithm_visualizer import Randomize, _Serializable
+from algorithm_visualizer import Randomize
+from algorithm_visualizer.types import Serializable
 
 _MAX_COMMANDS = 1000000
 _MAX_OBJECTS = 100
@@ -18,7 +19,7 @@ def __init__(self, *args):
         self.command(self.__class__.__name__, *args)
 
     @classmethod
-    def _command(cls, key: Optional[str], method: str, *args: _Serializable):
+    def _command(cls, key: Optional[str], method: str, *args: Serializable):
         cmd = {
             "key": key,
             "method": method,

algorithm_visualizer/layouts.py

@@ -2,6 +2,7 @@
 
 from algorithm_visualizer import Commander
 
+
 class Layout(Commander):
     def __init__(self, children: List[Commander]):
         super().__init__([c.key for c in children])

algorithm_visualizer/randomize.py

@@ -3,16 +3,16 @@
 import string
 from typing import List, NoReturn, Sequence
 
-from algorithm_visualizer import _Number
+from algorithm_visualizer.types import Number
 
 
-class Randomizer(metaclass=abc.ABCMeta):
+class _Randomizer(metaclass=abc.ABCMeta):
     @abc.abstractmethod
     def create(self) -> NoReturn:
         raise NotImplementedError
 
 
-class Integer(Randomizer):
+class Integer(_Randomizer):
     def __init__(self, min: int = 1, max: int = 9):
         self._min = min
         self._max = max
@@ -21,16 +21,16 @@ def create(self) -> int:
         return random.randint(self._min, self._max)
 
 
-class Double(Randomizer):
-    def __init__(self, min: _Number = 0, max: _Number = 1):
+class Double(_Randomizer):
+    def __init__(self, min: Number = 0, max: Number = 1):
         self._min = min
         self._max = max
 
     def create(self) -> float:
         return random.uniform(self._min, self._max)
 
 
-class String(Randomizer):
+class String(_Randomizer):
     def __init__(self, length: int = 16, letters: Sequence[str] = string.ascii_lowercase):
         self._length = length
         self._letters = letters
@@ -40,8 +40,8 @@ def create(self) -> str:
         return "".join(text)
 
 
-class Array1D(Randomizer):
-    def __init__(self, N: int = 10, randomizer: Randomizer = Integer()):
+class Array1D(_Randomizer):
+    def __init__(self, N: int = 10, randomizer: _Randomizer = Integer()):
         self._N = N
         self._randomizer = randomizer
         self._sorted = False
@@ -59,7 +59,7 @@ def create(self) -> List:
 
 
 class Array2D(Array1D):
-    def __init__(self, N: int = 10, M: int = 10, randomizer: Randomizer = Integer()):
+    def __init__(self, N: int = 10, M: int = 10, randomizer: _Randomizer = Integer()):
         super().__init__(N, randomizer)
         self._M = M
 
@@ -71,8 +71,8 @@ def create(self) -> List[List]:
         return [super().create() for _ in range(self._N)]
 
 
-class Graph(Randomizer):
-    def __init__(self, N: int = 5, ratio: _Number = 0.3, randomizer: Randomizer = Integer()):
+class Graph(_Randomizer):
+    def __init__(self, N: int = 5, ratio: Number = 0.3, randomizer: _Randomizer = Integer()):
         self._N = N
         self._ratio = ratio
         self._randomizer = randomizer

algorithm_visualizer/tracers/array1d.py

@@ -1,13 +1,15 @@
 from typing import List
 
-import algorithm_visualizer
-from algorithm_visualizer import Array2DTracer, _Serializable
+from . import chart
+from .array2d import Array2DTracer
+from algorithm_visualizer.types import Serializable
+
 
 class Array1DTracer(Array2DTracer):
-    def set(self, array1d: List[_Serializable] = None):
+    def set(self, array1d: List[Serializable] = None):
         super().set(array1d)
 
-    def patch(self, x: int, v: _Serializable = None):
+    def patch(self, x: int, v: Serializable = None):
         self.command("patch", x, v)
 
     def depatch(self, x: int):
@@ -19,5 +21,5 @@ def select(self, sx: int, ex: int = None):
     def deselect(self, sx: int, ex: int = None):
         super().deselect(0, sx, 0, ex)
 
-    def chart(self, chartTracer: "algorithm_visualizer.ChartTracer"):
+    def chart(self, chartTracer: "chart.ChartTracer"):
         self.command("chart", chartTracer.key)

algorithm_visualizer/tracers/array2d.py

@@ -1,14 +1,16 @@
 from typing import List
 
-from algorithm_visualizer import Tracer, _Serializable
+from .tracer import Tracer
+from algorithm_visualizer.types import Serializable
+
 
 class Array2DTracer(Tracer):
-    def set(self, array2d: List[List[_Serializable]] = None):
+    def set(self, array2d: List[List[Serializable]] = None):
         if array2d is None:
             array2d = []
         self.command("set", array2d)
 
-    def patch(self, x: int, y: int, v: _Serializable = None):
+    def patch(self, x: int, y: int, v: Serializable = None):
         self.command("patch", x, y, v)
 
     def depatch(self, x: int, y: int):

algorithm_visualizer/tracers/chart.py

@@ -1,4 +1,5 @@
-from algorithm_visualizer import Array1DTracer
+from .array1d import Array1DTracer
+
 
 class ChartTracer(Array1DTracer):
     pass

algorithm_visualizer/tracers/graph.py

@@ -1,9 +1,11 @@
-from typing import Any, List, Optional
+from typing import List, Optional
+
+from .log import LogTracer, Tracer
+from algorithm_visualizer.types import Number, Serializable
 
-from algorithm_visualizer import LogTracer, Tracer, _Number, _Serializable
 
 class GraphTracer(Tracer):
-    def set(self, array2d: List[List[_Serializable]] = None):
+    def set(self, array2d: List[List[Serializable]] = None):
         if array2d is None:
             array2d = []
         self.command("set", array2d)
@@ -29,8 +31,8 @@ def layoutRandom(self):
 
     def addNode(
         self,
-        id: _Serializable,
-        weight: Optional[_Number] = None,
+        id: Serializable,
+        weight: Optional[Number] = None,
         x: int = 0,
         y: int = 0,
         visitedCount: int = 0,
@@ -40,61 +42,61 @@ def addNode(
 
     def updateNode(
         self,
-        id: _Serializable,
-        weight: Optional[_Number] = None,
+        id: Serializable,
+        weight: Optional[Number] = None,
         x: int = 0,
         y: int = 0,
         visitedCount: int = 0,
         selectedCount: int = 0
     ):
         self.command("updateNode", id, weight, x, y, visitedCount, selectedCount)
 
-    def removeNode(self, id: _Serializable):
+    def removeNode(self, id: Serializable):
         self.command("removeNode", id)
 
     def addEdge(
         self,
-        source: _Serializable,
-        target: _Serializable,
-        weight: Optional[_Number] = None,
+        source: Serializable,
+        target: Serializable,
+        weight: Optional[Number] = None,
         visitedCount: int = 0,
         selectedCount: int = 0
     ):
         self.command("addEdge", source, target, weight, visitedCount, selectedCount)
 
     def updateEdge(
         self,
-        source: _Serializable,
-        target: _Serializable,
-        weight: Optional[_Number] = None,
+        source: Serializable,
+        target: Serializable,
+        weight: Optional[Number] = None,
         visitedCount: int = 0,
         selectedCount: int = 0
     ):
         self.command("updateEdge", source, target, weight, visitedCount, selectedCount)
 
-    def removeEdge(self, source: _Serializable, target: _Serializable):
+    def removeEdge(self, source: Serializable, target: Serializable):
         self.command("removeEdge", source, target)
 
     def visit(
         self,
-        target: _Serializable,
-        source: _Serializable = None,
-        weight: Optional[_Number] = None
+        target: Serializable,
+        source: Serializable = None,
+        weight: Optional[Number] = None
     ):
         self.command("visit", target, source, weight)
 
     def leave(
         self,
-        target: _Serializable,
-        source: _Serializable = None,
-        weight: Optional[_Number] = None
+        target: Serializable,
+        source: Serializable = None,
+        weight: Optional[Number] = None
     ):
         self.command("leave", target, source, weight)
 
-    def select(self, target: _Serializable, source: _Serializable = None):
+    def select(self, target: Serializable, source: Serializable = None):
         self.command("select", target, source)
 
-    def deselect(self, target: _Serializable, source: _Serializable = None):
+    def deselect(self, target: Serializable, source: Serializable = None):
         self.command("deselect", target, source)
 
     def log(self, log: LogTracer):

algorithm_visualizer/tracers/log.py

@@ -1,14 +1,16 @@
-from algorithm_visualizer import Tracer, _Serializable
+from .tracer import Tracer
+from algorithm_visualizer.types import Serializable
+
 
 class LogTracer(Tracer):
-    def set(self, log: _Serializable):
+    def set(self, log: Serializable):
         self.command("set", log)
 
-    def print(self, message: _Serializable):
+    def print(self, message: Serializable):
         self.command("print", message)
 
-    def println(self, message: _Serializable):
+    def println(self, message: Serializable):
         self.command("println", message)
 
-    def printf(self, format: str, *args: _Serializable):
+    def printf(self, format: str, *args: Serializable):
         self.command("printf", format, *args)

algorithm_visualizer/types.py

@@ -0,0 +1,5 @@
+from typing import Union
+
+# Types which are serializable by the default JSONEncoder
+Serializable = Union[dict, list, str, int, float, bool, None]
+Number = Union[int, float]