Apply TR suggestions

martin-martin · acsany · martin-martin · commit 2bdab7864934 · 2022-09-23T11:27:23.000+02:00
Co-authored-by: Philipp &lt;filip.axani+github@gmail.com&gt;
diff --git a/chatterbot/README.md b/chatterbot/README.md
@@ -1,16 +1,16 @@
-# Build a Chatbot with Python and Chatterbot
+# Build a Chatbot with Python and ChatterBot
 
-This repository contains code related to the tutorial on [building a Python chatbot with chatterbot](https://realpython.com/build-a-chatbot-python-chatterbot/).
+This repository contains code related to the tutorial on [building a Python chatbot with ChatterBot](https://realpython.com/build-a-chatbot-python-chatterbot/).
 
 Create and activate a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/), then install the necessary dependencies:
 
 ```sh
 $ python -m venv venv
 $ source venv/bin/activate
-(venv) $ python -m pip install chatterbot pytz
+(venv) $ python -m pip install -r requirements.txt
 ```
 
-Then you can train and start the interactive CLI bot by running `bot.py`:
+Then you can train and start the interactive command-line interface chatbot by running `bot.py`:
 
 ```sh
 (venv) $ python bot.py
@@ -37,4 +37,4 @@ After training, you'll see an interactive prompt that you can chat with:
 🪴 Ah, gotcha!
 ```
 
-The bot will learn from the replies you give and improve its accuracy. You can quite the interactive prompt by typing any of the `exit_conditions` defined in `bot.py`.
+The bot will learn from the replies you give and improve its accuracy. You can quit the interactive prompt by typing any of the `exit_conditions` defined in `bot.py`.
diff --git a/chatterbot/chat.txt b/chatterbot/chat.txt
@@ -93,7 +93,7 @@
 9/15/22, 15:30 - Martin: I'm sure they chat with the other plants if they can
 9/15/22, 15:31 - Philipp: Yeah, I heard that trees communicate in the woods with their roots
 9/15/22, 15:31 - Philipp: But thinking about that makes me feel bad that my plants are potted 😬
-9/15/22, 15:31 - Martin: ://
+9/15/22, 15:31 - Martin: 😢
 9/15/22, 15:32 - Martin: Yeah...
 9/15/22, 15:32 - Martin: The trees use mushrooms mycelium in the ground that's hooked to their roots to chat
 9/15/22, 15:32 - Martin: Pretty cool 😎
diff --git a/chatterbot/cleaner.py b/chatterbot/cleaner.py
@@ -4,7 +4,7 @@
 def clean_corpus(chat_export_file):
     """Prepare a WhatsApp chat export for training with chatterbot."""
     message_corpus = remove_chat_metadata(chat_export_file)
-    cleaned_corpus = remove_whatsapp_boilerplate(message_corpus)
+    cleaned_corpus = remove_non_message_text(message_corpus)
     return cleaned_corpus
 
 
@@ -25,9 +25,9 @@ def remove_chat_metadata(chat_export_file):
     Returns:
         tuple: The text of each message in the conversation
     """
-    date_time = r"(\d+\/\d+\/\d+,\s\d+:\d+)"  # "8/26/22, 17:47"
+    date_time = r"(\d+\/\d+\/\d+,\s\d+:\d+)"  # e.g. "8/26/22, 17:47"
     dash_whitespace = r"\s-\s"  # " - "
-    username = r"([\w\s]+)"  # "Jane Doe"
+    username = r"([\w\s]+)"  # e.g. "Jane Doe"
     metadata_end = r":\s"  # ": "
     pattern = date_time + dash_whitespace + username + metadata_end
 
@@ -37,20 +37,21 @@ def remove_chat_metadata(chat_export_file):
         return tuple(cleaned_corpus.split("\n"))
 
 
-def remove_whatsapp_boilerplate(message_collection):
+def remove_non_message_text(export_text_lines):
     """Remove conversation-irrelevant text from chat export.
 
-    WhatsApp chat exports come with a boilerplate intro line.
+    WhatsApp chat exports come with a standardized intro line,
+    and an empty line at the end of the file.
     Text exports also replace media messages with text that isn't
-    relevant for the conversation. This function removes both.
+    relevant for the conversation. This function removes all that.
 
     Args:
-        message_collection (tuple): Message texts
+        export_text_lines (tuple): All lines from the export file
 
     Returns:
-        tuple: Messages without WhatsApp boilerplate
+        tuple: Messages that are a relevant part of the conversation
     """
-    messages = message_collection[1:]
+    messages = export_text_lines[1:-1]
 
-    boilerplate = ("<Media omitted>",)
-    return tuple((msg for msg in messages if msg not in boilerplate))
+    filter_out_messages = ("<Media omitted>",)
+    return tuple((msg for msg in messages if msg not in filter_out_messages))
