Better package naming

Author: Norbert Kozlowski

gym_maze/__init__.py

@@ -1,7 +1,7 @@
 from gym.envs.registration import register
 
 # noinspection PyUnresolvedReferences
-from gym_maze.Maze import Maze, PATH_MAPPING, WALL_MAPPING, REWARD_MAPPING
+from .maze import Maze, PATH_MAPPING, WALL_MAPPING, REWARD_MAPPING
 
 ACTION_LOOKUP = {
     0: 'N',

gym_maze/envs/__init__.py

@@ -1,4 +1,4 @@
-from gym_maze.envs.AbstractMaze import AbstractMaze
+from gym_maze.envs.abstract_maze import AbstractMaze
 from gym_maze.envs.MazeF1 import MazeF1
 from gym_maze.envs.MazeF2 import MazeF2
 from gym_maze.envs.MazeF3 import MazeF3

gym_maze/envs/AbstractMaze.py renamed to gym_maze/envs/abstract_maze.py

@@ -6,7 +6,8 @@
 import numpy as np
 from gym import spaces, utils
 
-from gym_maze import Maze, WALL_MAPPING, ACTION_LOOKUP
+from gym_maze import ACTION_LOOKUP
+from gym_maze.maze import Maze, WALL_MAPPING
 from gym_maze.utils import get_all_possible_transitions
 
 ANIMAT_MARKER = 5

gym_maze/Maze.py renamed to gym_maze/maze.py

@@ -1,7 +1,7 @@
 import networkx as nx
 
 from gym_maze import find_action_by_direction
-from gym_maze.Maze import Maze
+from gym_maze.maze import Maze
 
 
 def get_all_possible_transitions(maze):

gym_maze/utils/utils.py

@@ -9,8 +9,8 @@
 class BooleanMultiplexer(gym.Env):
 
     def __init__(self, control_bits=3) -> None:
-        self.metadata = {'render.modes': ['human']}
         self.control_bits = control_bits
+        self.metadata = {'render.modes': ['human']}
         self.observation_space = Discrete(len(self._observation_string_length))
         self.action_space = Discrete(2)
 
@@ -36,12 +36,13 @@ def _render(self, mode='human', close=False):
             return
 
         if mode == 'human':
-            return self.control_bits + self._data_bits
+            return self._observation()
         else:
             super(BooleanMultiplexer, self).render(mode=mode)
 
-    def _observation(self):
-        return self.control_bits + self._data_bits
+    def _observation(self) -> str:
+        bit_array = self._ctrl_bits + self._data_bits
+        return bit_array.bin
 
     @property
     def _observation_string_length(self):

gym_multiplexer/boolean_multiplexer.py

@@ -32,6 +32,7 @@ def test_should_render_state(self):
         # then
         assert state is not None
         assert 3 == len(state)
+        assert type(state) is str
 
     def test_should_execute_step(self):
         # given
@@ -44,6 +45,7 @@ def test_should_execute_step(self):
 
         # then
         assert state is not None
+        assert type(state) is str
         assert reward in [0, 1]
         assert done is True
 

gym_multiplexer/tests/test_multiplexer.py

@@ -0,0 +1,14 @@
+from gym_multiplexer.utils import get_correct_answer
+
+
+class TestUtils:
+
+    def test_should_calculate_correct_answer_for_3bit_multiplexer(self):
+        assert 1 == get_correct_answer('010', 1)
+        assert 0 == get_correct_answer('110', 1)
+
+    def test_should_calculate_correct_answer_for_6bit_multiplexer(self):
+        assert 0 == get_correct_answer('110100', 2)
+
+    def test_should_calculate_correct_answer_for_11bit_multiplexer(self):
+        assert 1 == get_correct_answer('101101101', 3)

gym_multiplexer/tests/test_utils.py

@@ -0,0 +1 @@
+from .utils import get_correct_answer

gym_multiplexer/utils/__init__.py

@@ -0,0 +1,10 @@
+from bitstring import BitString, BitArray
+
+
+def get_correct_answer(bitstring: str, control_bits: int) -> int:
+    bits = BitString(bin=bitstring)
+
+    _ctrl_bits = bits[:control_bits]
+    _data_bits = bits[control_bits:]
+
+    return int(_data_bits[_ctrl_bits.uint])