Merge pull request #146 from kneasle/rename-bot-to-wheatley

Replace remaining instances of 'bot' with 'Wheatley'

Author: kneasle

CONTRIBUTING.md

@@ -3,7 +3,7 @@ Pull requests are welcome, but please
 [make an issue](https://github.com/Kneasle/ringing-room-bot/issues/new) to discuss the changes
 before starting to implement things.
 
-To run the bot **from source code**, `cd` to the repository directory and run:
+To run Wheatley **from source code**, `cd` to the repository directory and run:
 ```bash
 python3 run-wheatley [ARGS]
 ```
@@ -23,15 +23,15 @@ Or, on Unix you can run `./run-wheatley [ARGS]`.
 ├── setup.py                                        => Build script run to generate the PIP package
 ├── wheatley
 │   ├── __init__.py                                 => Empty file
-│   ├── __main__.py                                 => Code to start the bot
+│   ├── __main__.py                                 => Code to start Wheatley
 │   ├── arg_parsing.py                              => Code to parse formatted CLI args e.g. call strings
 │   ├── bell.py                                     => Stores the representation of a bell
-│   ├── bot.py                                      => The main class for the bot
+│   ├── bot.py                                      => The main class for Wheatley
 │   ├── calls.py                                    => Constants for the calls used in Ringing Room
-│   ├── main.py                                     => Entry point of the bot
+│   ├── main.py                                     => Entry point of Wheatley
 │   ├── page_parser.py                              => Code to parse the ringing room HTML
 │   ├── regression.py                               => Code for the weighted linear regression
-│   ├── rhythm.py                                   => Code used to drive the bot's rhythm
+│   ├── rhythm.py                                   => Code used to drive Wheatley's rhythm
 │   ├── tower.py                                    => Code used to interact with ringing room
 │   └── row_generation                              => Modular row generators
 │       ├── __init__.py

wheatley/bot.py

@@ -26,7 +26,7 @@
 
 class Bot:
     """
-    A class to hold all the information that the bot will use to glue together the rhythm,
+    A class to hold all the information that Wheatley will use to glue together the rhythm,
     row_gen and socket-io parts together into a useful program.
     """
 
@@ -176,7 +176,7 @@ def look_to_has_been_called(self, call_time: float) -> None:
         self._should_start_method = False
         self._should_start_ringing_rounds = False
 
-        # Reset the state, so that the bot starts by ringing rounds
+        # Reset the state, so that Wheatley starts by ringing rounds
         self._is_ringing = True
         self._is_ringing_rounds = True
 
@@ -312,8 +312,8 @@ def tick(self) -> None:
 
     def main_loop(self) -> None:
         """
-        The main_loop of the bot.
-        The main thread will get stuck forever in this function whilst the bot rings.
+        Wheatley's main loop.  The main thread will get stuck forever in this function whilst
+        Wheatley rings.
         """
         while True:
             # Log a message to say that Wheatley is waiting for 'Look To!'
@@ -340,10 +340,9 @@ def main_loop(self) -> None:
                 self._tower.set_is_ringing(False)
 
     def _user_assigned_bell(self, bell: Bell) -> bool:
-        """ True when the bell is assigned to a different user name than given to the bot """
+        """ Returns `True` if this bell is not assigned to Wheatley. """
         return not self._bot_assigned_bell(bell)
 
     def _bot_assigned_bell(self, bell: Bell) -> bool:
-        """ True when the bell is assigned to the user name given to the bot
-        or bell is unassigned when user name is not set"""
+        """ Returns `True` if this bell **is** assigned to Wheatley. """
         return self._tower.is_bell_assigned_to(bell, self._user_name)

wheatley/main.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 
 """
-The file containing the main function for the bot, as well as all the command line argument parsing
-required to make the bot easily configurable.
+The file containing the main function for Wheatley, as well as all the command line argument parsing
+required to make Wheatley easily configurable.
 """
 
 import argparse
@@ -216,9 +216,9 @@ def server_main(override_args: Optional[List[str]], stop_on_join_tower: bool) ->
 
 def console_main(override_args: Optional[List[str]], stop_on_join_tower: bool) -> None:
     """
-    The main function of the bot.
+    The main function of Wheatley, when called from the Command Line.
     This parses the CLI arguments, creates the Rhythm, RowGenerator and Bot objects, then starts
-    the bot's mainloop.
+    Wheatley's mainloop.
 
     The two optional arguments are used by the integration tester to give Wheatley artificial argument values
     (override_args) and make Wheatley exit with error code 0 on joining a tower so that hanging forever
@@ -250,8 +250,8 @@ def console_main(override_args: Optional[List[str]], stop_on_join_tower: bool) -
         "--name",
         default=None,
         type=str,
-        help="If set, then the bot will ring bells assigned to the given name. \
-             When not set, the bot rings unassigned bells."
+        help="If set, then Wheatley will ring bells assigned to the given name. \
+             When not set, Wheatley rings unassigned bells."
     )
 
     # Row generation arguments

wheatley/rhythm/regression.py

@@ -290,13 +290,13 @@ def initialise_line(self, stage: int, user_controls_treble: bool, start_time: fl
         self._real_start_time = start_time
 
         if not user_controls_treble:
-            # If the bot is ringing the first bell, then add it as a datapoint anyway, so that after
+            # If Wheatley is ringing the first bell, then add it as a datapoint anyway, so that after
             # the 2nd bell is rung, a regression line can be made
             self._add_data_point(0, 0, start_time, 1)
             self._start_time = start_time
         else:
-            # If the bot isn't ringing the first bell, then set the expected time of the first bell
-            # to infinity so that the bot will wait indefinitely for the first bell to ring, and
+            # If Wheatley isn't ringing the first bell, then set the expected time of the first bell
+            # to infinity so that Wheatley will wait indefinitely for the first bell to ring, and
             # then it will extrapolate from that time
             self._start_time = float('inf')
 

wheatley/row_generation/__init__.py

@@ -1,4 +1,4 @@
-""" Module to handle generation of rows for the bot to ring. """
+""" Module to handle generation of rows for Wheatley to ring. """
 
 from .complib_composition_generator import ComplibCompositionGenerator
 from .dixonoids_generator import DixonoidsGenerator