dungeoncoder 0.2.2__tar.gz → 0.2.4__tar.gz

{dungeoncoder-0.2.2 → dungeoncoder-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dungeoncoder
-Version: 0.2.2
+Version: 0.2.4
 Summary: Python API for Dungeon Coder: steer the hero from a script, in VS Code or in the built-in simulator
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/mhobelsb/vsc_hm-dungeon-coder

{dungeoncoder-0.2.2 → dungeoncoder-0.2.4}/dungeoncoder/__init__.py

@@ -1,4 +1,4 @@
 from .dungeoncoder import Game, Hero, use_simulator
 
 # The same as "version" in the extension's package.json (`npm run check:version`).
-__version__ = "0.2.2"
+__version__ = "0.2.4"

{dungeoncoder-0.2.2 → dungeoncoder-0.2.4}/dungeoncoder/dungeoncoder.py

@@ -79,6 +79,11 @@ DEFAULT_BASE_URL = _discover_base_url()
 # after 5 s + step time (src/extension.ts), so the client waits a bit longer.
 _STEP_SECONDS = 0.5
 _ACTION_TIMEOUT_SLACK = 6.0
+# Sensors, queries and loading a level: the game answers at once, but a busy machine (or a game tab
+# that is briefly blocked) can delay the answer. With a 1 s limit such a call returned its default
+# (False) and a program's view of the world silently went wrong (B25: a turn too many). Connecting
+# stays quick, so a game that isn't running is reported at once.
+_ANSWER_TIMEOUT = httpx.Timeout(10.0, connect=1.0)
 
 
 def _extract_message(response) -> str:
@@ -125,7 +130,7 @@ def _check_version(base_url):
     _version_checked = True
     from . import __version__
     try:
-        response = _get_version_api.sync_detailed(client=Client(base_url=base_url, timeout=httpx.Timeout(1)))
+        response = _get_version_api.sync_detailed(client=Client(base_url=base_url, timeout=_ANSWER_TIMEOUT))
     except Exception:
         return                  # no game running: loading the level says so
     if response.status_code == 404:
@@ -202,7 +207,7 @@ class Hero:
 
     def __init__(self, base_url: str = BASE_URL, index: int = 0):
         self._base_url = base_url
-        self._client = Client(base_url=base_url, timeout=httpx.Timeout(1))
+        self._client = Client(base_url=base_url, timeout=_ANSWER_TIMEOUT)
         self._pace = 1.0
         self._action_client = self._make_action_client()
         self._index = index                 # which hero in a co-op level (0 = MainCharacter)
@@ -339,18 +344,37 @@ class Game:
     """
 
     BASE_URL = DEFAULT_BASE_URL
-
-    def __init__(self, level_file, seed: int | None = None):
+    SHOW_CALLS = None
+    """True or False: the list of the program's last calls in the game's corner, for every level
+    loaded after this (level property show_calls); None: as the level says (off unless it says on)."""
+    SHOW_SENSING = None
+    """True or False: the frames around the cells a sensor looked at, for every level loaded after
+    this (level property show_sensing); None: as the level says (on unless it says off)."""
+
+    def __init__(self, level_file, seed: int | None = None, show_calls: bool | None = None,
+                 show_sensing: bool | None = None):
         """Loads the level. `seed` picks a variant of a level that has some (objects that may
-        lie anywhere in a region, see variants.py): the same seed, the same variant."""
+        lie anywhere in a region, see variants.py): the same seed, the same variant.
+        `show_calls` and `show_sensing` (True or False) switch the list of the last calls and the
+        sensor frames on or off for this level; without them, Game.SHOW_CALLS and
+        Game.SHOW_SENSING decide, and if those are None, the level does."""
         _check_version(self.BASE_URL)
         if seed is not None and (type(seed) != int):
             print("Error: seed must be a whole number.")
             sys.exit(1)
+        display = {}
+        for name, value, default in (("show_calls", show_calls, self.SHOW_CALLS),
+                                     ("show_sensing", show_sensing, self.SHOW_SENSING)):
+            chosen = value if value is not None else default
+            if chosen is not None and type(chosen) != bool:
+                print(f"Error: {name} must be True or False (or None: as the level says).")
+                sys.exit(1)
+            if chosen is not None:
+                display[name] = chosen
         self.__level = self.Level(self.BASE_URL)
         try:
             trace.loading(level_file)
-            loaded = self.__level.load(level_file, seed)
+            loaded = self.__level.load(level_file, seed, display)
         except FileNotFoundError:
             print(f"Error: Level file '{level_file}' not found. "
                   f"Please check the path and that you opened the right folder in VS Code "
@@ -376,7 +400,8 @@ class Game:
         """The seed of this level (a generated level or a variant), or None."""
 
     @classmethod
-    def generate(cls, seed: int | None = None, kind: str = "maze", **options) -> "Game":
+    def generate(cls, seed: int | None = None, kind: str = "maze", show_calls: bool | None = None,
+                 show_sensing: bool | None = None, **options) -> "Game":
         """Loads a generated level; the same seed always gives the same level.
         Without a seed, a new level each time: its seed is printed and kept in game.seed.
 
@@ -396,7 +421,7 @@ class Game:
         path = os.path.join(tempfile.mkdtemp(prefix="dungeoncoder-"), f"{kind}_{seed}.txt")
         with open(path, "w", encoding="utf-8") as f:
             f.write(text)
-        return cls(path)
+        return cls(path, show_calls=show_calls, show_sensing=show_sensing)
 
     def get_hero(self):
         return self.__hero
@@ -434,10 +459,10 @@ class Game:
         A class to manage game levels.
         """
         def __init__(self, base_url):
-            self._client = Client(base_url=base_url, timeout=httpx.Timeout(1))
+            self._client = Client(base_url=base_url, timeout=_ANSWER_TIMEOUT)
             self.seed = None
 
-        def load(self, filename, seed=None):
+        def load(self, filename, seed=None, display=None):
             """
             Loads a level from a Tiled JSON file, or builds it from an ASCII map
             (a file ending in .txt, see asciimap.py for the format).
@@ -469,6 +494,9 @@ class Game:
             elif chosen:
                 print(f"Level variant {self.seed} (the same again: Game(\"{filename}\", seed={self.seed}))")
 
+            for name, value in (display or {}).items():     # show_calls, show_sensing from the program
+                properties = [p for p in level_data.get("properties", []) or [] if p.get("name") != name]
+                level_data["properties"] = properties + [{"name": name, "type": "bool", "value": value}]
             # a refused level (e.g. a missing asset pack) prints the game's explanation
             return _call(self._client, _load_level_api.sync_detailed, default=False,
                          explain_refusal=True, body=TiledLevel.from_dict(level_data))

{dungeoncoder-0.2.2 → dungeoncoder-0.2.4}/dungeoncoder.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dungeoncoder
-Version: 0.2.2
+Version: 0.2.4
 Summary: Python API for Dungeon Coder: steer the hero from a script, in VS Code or in the built-in simulator
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/mhobelsb/vsc_hm-dungeon-coder