Expose Engine._map as read-only colors property

Author: pronovic

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apologies"
-version = "0.1.14"
+version = "0.1.15"
 description = "Python code to play a game similar to Sorry"
 authors = ["Kenneth J. Pronovici <pronovic@ieee.org>"]
 license = "Apache-2.0"

src/apologies/engine.py

@@ -134,6 +134,10 @@ def completed(self) -> bool:
         """Whether the game is completed."""
         return self._game.completed
 
+    @property
+    def colors(self) -> Dict[PlayerColor, Character]:
+        return self._map.copy()
+
     def winner(self) -> Optional[Tuple[Character, Player]]:
         """Return the winner of the game, as a tuple of (Character, Player)"""
         return (self._map[self._game.winner.color], self._game.winner) if self.completed else None  # type: ignore

tests/test_engine.py

@@ -57,6 +57,7 @@ def test_constructor_not_random(self):
         assert engine._queue.first == engine.first
         assert engine._queue.entries == [PlayerColor.RED, PlayerColor.YELLOW]
         assert engine._rules.mode == GameMode.STANDARD
+        assert engine.colors == engine._map and engine.colors is not engine._map  # it's a copy
         assert engine._map == {PlayerColor.RED: character1, PlayerColor.YELLOW: character2}
 
     def test_constructor_random(self):
@@ -79,6 +80,7 @@ def test_constructor_random(self):
             assert engine._queue.first == engine.first
             assert engine._queue.entries == [PlayerColor.RED, PlayerColor.YELLOW, PlayerColor.GREEN, PlayerColor.BLUE]
             assert engine._rules.mode == GameMode.STANDARD
+            assert engine.colors == engine._map and engine.colors is not engine._map  # it's a copy
             assert engine._map == {
                 PlayerColor.RED: character1,
                 PlayerColor.YELLOW: character2,