Merge pull request #137 from kneasle/rr-integration

Reimplement RR integration

Author: kneasle

CHANGE_LOG.md

@@ -10,6 +10,7 @@
   - Moved some overly verbose `INFO` messages into `DEBUG`.
   - Capped all numbers to 3 decimal places.
   - Made debug 'wait' logging slightly less verbose.
+- Fix broken version string (`Wheatley vv0.6.0` will now be `Wheatley v0.6.0`)
 
 ## Technical changes
 
@@ -18,6 +19,8 @@
 - Change place notation parsing to comply with CompLib and the XML specification.
 - Add full static typing, and fix some `None`-related bugs.
 - Prevent installing the wrong version of socketio to work with RingingRoom.
+- Reimplement the Ringing Rom integration code, and fix buggy expansion of PN when running on the
+  server.
 
 # 0.5.2
 - Bump numpy version to exactly `1.19.3` on Windows to fix

wheatley/bot.py

@@ -34,9 +34,10 @@ class Bot:
 
     def __init__(self, tower: RingingRoomTower, row_generator: RowGenerator, do_up_down_in: bool,
                  stop_at_rounds: bool, rhythm: Rhythm, user_name: Optional[str] = None,
-                 server_mode: bool = False) -> None:
+                 server_instance_id: Optional[int] = None) -> None:
         """ Initialise a Bot with all the parts it needs to run. """
-        self._server_mode = server_mode
+        # If this is None then Wheatley is in client mode, otherwise Wheatley is in server mode
+        self._server_instance_id = server_instance_id
         self._last_activity_time = time.time()
 
         self._rhythm = rhythm
@@ -91,6 +92,10 @@ def number_of_bells(self) -> int:
         """ Convenient property to find the number of bells in the current tower. """
         return self._tower.number_of_bells
 
+    @property
+    def _server_mode(self) -> bool:
+        return self._server_instance_id is not None
+
     # Callbacks
     def _on_setting_change(self, key: str, value: Any) -> None:
         def log_invalid_key(message: str) -> None:
@@ -144,6 +149,9 @@ def _check_number_of_bells(self) -> bool:
     def _on_look_to(self) -> None:
         if self._check_number_of_bells():
             self.look_to_has_been_called(time.time())
+        # All Wheatley instances should return a 'Roll Call' message after `Look To` is called.
+        if self._server_instance_id is not None:
+            self._tower.emit_roll_call(self._server_instance_id)
 
     # This has to be made public, because the server's main function might have to call it
     def look_to_has_been_called(self, call_time: float) -> None:

wheatley/main.py

@@ -156,6 +156,11 @@ def server_main(override_args: Optional[List[str]], stop_on_join_tower: bool) ->
         help="Set to the time when 'Look to' was called if Wheatley was spawned because 'look to' was \
               called and Wheatley is needed."
     )
+    parser.add_argument(
+        "-i", "--id",
+        type=int,
+        help="The instance ID of this Wheatley process."
+    )
     parser.add_argument(
         "-v", "--verbose",
         action="count",
@@ -179,14 +184,14 @@ def server_main(override_args: Optional[List[str]], stop_on_join_tower: bool) ->
     configure_logging(args.verbose, args.quiet)
 
     # Log the version string to 'DEBUG'
-    logging.debug(f"Running Wheatley v{__version__}")
+    logging.debug(f"Running Wheatley {__version__}")
 
     # Args that we are currently 'missing'
     use_up_down_in = True
     stop_at_rounds = True
     peal_speed = 180
     inertia = 1
-    initial_inertia = 1
+    initial_inertia = 0
     max_bells_in_dataset = 15
     handstroke_gap = 1
     use_wait = True
@@ -197,7 +202,7 @@ def server_main(override_args: Optional[List[str]], stop_on_join_tower: bool) ->
     rhythm = create_rhythm(peal_speed, inertia, max_bells_in_dataset, handstroke_gap, use_wait,
                            initial_inertia)
     bot = Bot(tower, PlaceHolderGenerator(), use_up_down_in, stop_at_rounds, rhythm, user_name="Wheatley",
-              server_mode=True)
+              server_instance_id=args.id)
 
     with tower:
         tower.wait_loaded()
@@ -371,7 +376,7 @@ def console_main(override_args: Optional[List[str]], stop_on_join_tower: bool) -
     parser.add_argument(
         "--version",
         action="version",
-        version=f"Wheatley v{__version__}"
+        version=f"Wheatley {__version__}"
     )
     parser.add_argument(
         "-v", "--verbose",

wheatley/parsing.py

@@ -209,7 +209,7 @@ def json_to_call(name: str) -> Optional[CallDef]:
             raise_error('stage', "'stage' is not defined", e)
         except ValueError as e:
             raise_error('stage', f"'{json['stage']}' is not a valid integer", e)
-        return PlaceNotationGenerator(stage, "&" + json['notation'], json_to_call('bob'),
+        return PlaceNotationGenerator(stage, json['notation'], json_to_call('bob'),
                                       json_to_call('single'))
 
     if json['type'] == "composition":

wheatley/tower.py

@@ -127,6 +127,11 @@ def set_is_ringing(self, value: bool) -> None:
         self.logger.info(f"(EMIT): Telling RR clients to set is_ringing to {value}")
         self._emit("c_wheatley_is_ringing", {"is_ringing": value, "tower_id": self.tower_id})
 
+    def emit_roll_call(self, instance_id: int) -> None:
+        """ Broadcasts a 'roll call' reply to the Ringing Room server. """
+        self.logger.info("(EMIT): Replying to roll call")
+        self._emit("c_roll_call", {"tower_id": self.tower_id, "instance_id": instance_id})
+
     def wait_loaded(self) -> None:
         """ Pause the thread until the socket-io connection is open and stable. """
         if self._socket_io_client is None or not self._socket_io_client.connected: