Add annotations for return types

Author: gunthercox

README.md

@@ -23,7 +23,7 @@ An example of typical input would be something like this:
 
 ## How it works
 
-An untrained instance of ChatterBot starts off with no knowledge of how to communicate. Each time a user enters a statement, the library saves the text that they entered and the text that the statement was in response to. As ChatterBot receives more input the number of responses that it can reply and the accuracy of each response in relation to the input statement increase. The program selects the closest matching response by searching for the closest matching known statement that matches the input, it then returns the most likely response to that statement based on how frequently each response is issued by the people the bot communicates with.
+An untrained instance of ChatterBot starts off with no knowledge of how to communicate. Each time a user enters a statement, the library saves the text that they entered and the text that the statement was in response to. As ChatterBot receives more input the number of responses that it can reply to, and the accuracy of each response in relation to the input statement increases. The program selects the closest matching response by searching for the closest matching known statement that matches the input, it then returns the most likely response to that statement based on how frequently each response is issued by the people the bot communicates with.
 
 # [Documentation](https://docs.chatterbot.us)
 

chatterbot/chatterbot.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Union
 from chatterbot.storage import StorageAdapter
 from chatterbot.logic import LogicAdapter
 from chatterbot.search import TextSearch, IndexedTextSearch
@@ -130,7 +131,7 @@ def __init__(self, name, stream=False, **kwargs):
         # Allow the bot to save input it receives so that it can learn
         self.read_only = kwargs.get('read_only', False)
 
-    def get_response(self, statement=None, **kwargs) -> Statement:
+    def get_response(self, statement: Union[Statement, str, dict] = None, **kwargs) -> Statement:
         """
         Return the bot's response based on the input.
 

chatterbot/conversation.py

@@ -22,13 +22,13 @@ class StatementMixin(object):
 
     extra_statement_field_names = []
 
-    def get_statement_field_names(self):
+    def get_statement_field_names(self) -> list[str]:
         """
         Return the list of field names for the statement.
         """
         return self.statement_field_names + self.extra_statement_field_names
 
-    def get_tags(self):
+    def get_tags(self) -> list[str]:
         """
         Return the list of tags for this statement.
         """
@@ -79,7 +79,7 @@ class Statement(StatementMixin):
         'storage',
     )
 
-    def __init__(self, text, in_response_to=None, **kwargs):
+    def __init__(self, text: str, in_response_to=None, **kwargs):
 
         self.id = kwargs.get('id')
         self.text = str(text)

chatterbot/corpus.py

@@ -18,7 +18,7 @@
 CORPUS_EXTENSION = 'yml'
 
 
-def get_file_path(dotted_path, extension='json'):
+def get_file_path(dotted_path, extension='json') -> str:
     """
     Reads a dotted file path and returns the file path.
     """
@@ -41,7 +41,7 @@ def get_file_path(dotted_path, extension='json'):
     return corpus_path
 
 
-def read_corpus(file_name):
+def read_corpus(file_name) -> dict:
     """
     Read and return the data from a corpus json file.
     """
@@ -59,7 +59,7 @@ def read_corpus(file_name):
         return yaml.safe_load(data_file)
 
 
-def list_corpus_files(dotted_path):
+def list_corpus_files(dotted_path) -> list[str]:
     """
     Return a list of file paths to each data file in the specified corpus.
     """

chatterbot/ext/django_chatterbot/abstract_models.py

@@ -117,7 +117,7 @@ def __str__(self):
             return self.text
         return '<empty>'
 
-    def get_tags(self):
+    def get_tags(self) -> list[str]:
         """
         Return the list of tags for this statement.
         (Overrides the method from StatementMixin)

chatterbot/ext/sqlalchemy_app/models.py

@@ -13,7 +13,7 @@ class ModelBase(object):
     """
 
     @declared_attr
-    def __tablename__(cls):
+    def __tablename__(cls) -> str:
         """
         Return the lowercase class name as the name of the table.
         """
@@ -99,7 +99,7 @@ class Statement(Base, StatementMixin):
         server_default=''
     )
 
-    def get_tags(self):
+    def get_tags(self) -> list[str]:
         """
         Return a list of tags for this statement.
         """

chatterbot/filters.py

@@ -1,4 +1,4 @@
-def get_recent_repeated_responses(chatbot, conversation, sample=10, threshold=3, quantity=3):
+def get_recent_repeated_responses(chatbot, conversation, sample=10, threshold=3, quantity=3) -> list:
     """
     A filter that eliminates possibly repetitive responses to prevent
     a chat bot from repeating statements that it has recently said.

chatterbot/logic/best_match.py

@@ -1,4 +1,5 @@
 from chatterbot.logic import LogicAdapter
+from chatterbot.conversation import Statement
 from chatterbot import filters
 
 
@@ -22,7 +23,7 @@ def __init__(self, chatbot, **kwargs):
 
         self.excluded_words = kwargs.get('excluded_words')
 
-    def process(self, input_statement, additional_response_selection_parameters=None):
+    def process(self, input_statement: Statement, additional_response_selection_parameters=None) -> Statement:
 
         # Get all statements that have a response text similar to the input statement
         search_results = self.search_algorithm.search(input_statement)

chatterbot/logic/logic_adapter.py

@@ -86,7 +86,7 @@ def can_process(self, statement) -> bool:
         """
         return True
 
-    def process(self, statement, additional_response_selection_parameters=None) -> Statement:
+    def process(self, statement: Statement, additional_response_selection_parameters: dict = None) -> Statement:
         """
         Override this method and implement your logic for selecting a response to an input statement.
 
@@ -99,11 +99,9 @@ def process(self, statement, additional_response_selection_parameters=None) -> S
         lowest confidence level and 1 is the highest.
 
         :param statement: An input statement to be processed by the logic adapter.
-        :type statement: Statement
 
         :param additional_response_selection_parameters: Parameters to be used when
             filtering results to choose a response from.
-        :type additional_response_selection_parameters: dict
         """
         raise self.AdapterMethodNotImplementedError()
 

chatterbot/logic/mathematical_evaluation.py

@@ -25,7 +25,7 @@ def __init__(self, chatbot, **kwargs):
         self.language = kwargs.get('language', languages.ENG)
         self.cache = {}
 
-    def can_process(self, statement):
+    def can_process(self, statement) -> bool:
         """
         Determines whether it is appropriate for this
         adapter to respond to the user input.
@@ -34,7 +34,7 @@ def can_process(self, statement):
         self.cache[statement.text] = response
         return response.confidence == 1
 
-    def process(self, statement, additional_response_selection_parameters=None):
+    def process(self, statement: Statement, additional_response_selection_parameters: dict = None) -> Statement:
         """
         Takes a statement string.
         Returns the equation from the statement with the mathematical terms solved.