ChatterBot 1.2.4__py3-none-any.whl → 1.2.6__py3-none-any.whl

chatterbot/__init__.py

@@ -4,7 +4,7 @@ ChatterBot is a machine learning, conversational dialog engine.
 from .chatterbot import ChatBot
 
 
-__version__ = '1.2.4'
+__version__ = '1.2.6'
 
 __all__ = (
     'ChatBot',

chatterbot/chatterbot.py

@@ -3,6 +3,7 @@ from chatterbot.storage import StorageAdapter
 from chatterbot.logic import LogicAdapter
 from chatterbot.search import TextSearch, IndexedTextSearch
 from chatterbot.tagging import PosLemmaTagger
+from chatterbot.conversation import Statement
 from chatterbot import languages
 from chatterbot import utils
 import spacy
@@ -114,13 +115,12 @@ class ChatBot(object):
         # 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):
+    def get_response(self, statement=None, **kwargs) -> Statement:
         """
         Return the bot's response based on the input.
 
         :param statement: An statement object or string.
         :returns: A response to the input.
-        :rtype: Statement
 
         :param additional_response_selection_parameters: Parameters to pass to the
             chat bot's logic adapters to control response selection.
@@ -314,7 +314,7 @@ class ChatBot(object):
         # Save the response statement
         return self.storage.create(**statement.serialize())
 
-    def get_latest_response(self, conversation):
+    def get_latest_response(self, conversation: str):
         """
         Returns the latest response in a conversation if it exists.
         Returns None if a matching conversation cannot be found.

chatterbot/comparisons.py

@@ -19,19 +19,17 @@ class Comparator:
     def __call__(self, statement_a, statement_b):
         return self.compare(statement_a, statement_b)
 
-    def compare_text(self, text_a, text_b):
+    def compare_text(self, text_a: str, text_b: str) -> float:
         """
         Implemented in subclasses: compare text_a to text_b.
 
         :return: The percent of similarity between the statements based on the implemented algorithm.
-        :rtype: float
         """
         return 0
 
-    def compare(self, statement_a, statement_b):
+    def compare(self, statement_a, statement_b) -> float:
         """
         :return: The percent of similarity between the statements based on the implemented algorithm.
-        :rtype: float
         """
         return self.compare_text(statement_a.text, statement_b.text)
 
@@ -46,12 +44,11 @@ class LevenshteinDistance(Comparator):
     based on the Levenshtein distance algorithm.
     """
 
-    def compare_text(self, text_a, text_b):
+    def compare_text(self, text_a: str, text_b: str) -> float:
         """
         Compare the two pieces of text.
 
         :return: The percent of similarity between the text of the statements.
-        :rtype: float
         """
 
         # Return 0 if either statement has a None text value
@@ -105,12 +102,11 @@ class SpacySimilarity(Comparator):
         # Disable the Named Entity Recognition (NER) component because it is not necessary
         self.nlp = spacy.load(model, exclude=['ner'])
 
-    def compare_text(self, text_a, text_b):
+    def compare_text(self, text_a: str, text_b: str) -> float:
         """
         Compare the similarity of two strings.
 
         :return: The percent of similarity between the closest synset distance.
-        :rtype: float
         """
 
         # Return 0 if either statement has a None text value
@@ -157,7 +153,7 @@ class JaccardSimilarity(Comparator):
         # Disable the Named Entity Recognition (NER) component because it is not necessary
         self.nlp = spacy.load(model, exclude=['ner'])
 
-    def compare_text(self, text_a, text_b):
+    def compare_text(self, text_a: str, text_b: str) -> float:
         """
         Return the calculated similarity of two
         statements based on the Jaccard index.

chatterbot/conversation.py

@@ -40,10 +40,9 @@ class StatementMixin(object):
         """
         self.tags.extend(tags)
 
-    def serialize(self):
+    def serialize(self) -> dict:
         """
         :returns: A dictionary representation of the statement object.
-        :rtype: dict
         """
         data = {}
 

chatterbot/ext/django_chatterbot/abstract_models.py

@@ -32,7 +32,8 @@ class AbstractBaseTag(models.Model):
 
     name = models.SlugField(
         max_length=constants.TAG_NAME_MAX_LENGTH,
-        unique=True
+        unique=True,
+        help_text='The unique name of the tag.'
     )
 
     class Meta:
@@ -49,16 +50,19 @@ class AbstractBaseStatement(models.Model, StatementMixin):
     """
 
     text = models.CharField(
-        max_length=constants.STATEMENT_TEXT_MAX_LENGTH
+        max_length=constants.STATEMENT_TEXT_MAX_LENGTH,
+        help_text='The text of the statement.'
     )
 
     search_text = models.CharField(
         max_length=constants.STATEMENT_TEXT_MAX_LENGTH,
-        blank=True
+        blank=True,
+        help_text='A modified version of the statement text optimized for searching.'
     )
 
     conversation = models.CharField(
-        max_length=constants.CONVERSATION_LABEL_MAX_LENGTH
+        max_length=constants.CONVERSATION_LABEL_MAX_LENGTH,
+        help_text='A label used to link this statement to a conversation.'
     )
 
     created_at = models.DateTimeField(
@@ -68,21 +72,25 @@ class AbstractBaseStatement(models.Model, StatementMixin):
 
     in_response_to = models.CharField(
         max_length=constants.STATEMENT_TEXT_MAX_LENGTH,
-        null=True
+        null=True,
+        help_text='The text of the statement that this statement is in response to.'
     )
 
     search_in_response_to = models.CharField(
         max_length=constants.STATEMENT_TEXT_MAX_LENGTH,
-        blank=True
+        blank=True,
+        help_text='A modified version of the in_response_to text optimized for searching.'
     )
 
     persona = models.CharField(
-        max_length=constants.PERSONA_MAX_LENGTH
+        max_length=constants.PERSONA_MAX_LENGTH,
+        help_text='A label used to link this statement to a persona.'
     )
 
     tags = models.ManyToManyField(
         TAG_MODEL,
-        related_name='statements'
+        related_name='statements',
+        help_text='The tags that are associated with this statement.'
     )
 
     # This is the confidence with which the chat bot believes

chatterbot/ext/django_chatterbot/apps.py

@@ -6,3 +6,10 @@ class DjangoChatterBotConfig(AppConfig):
     name = 'chatterbot.ext.django_chatterbot'
     label = 'django_chatterbot'
     verbose_name = 'Django ChatterBot'
+
+    def ready(self):
+        from chatterbot.ext.django_chatterbot import settings as defaults
+        from django.conf import settings
+
+        settings.CHATTERBOT = getattr(settings, 'CHATTERBOT', {})
+        settings.CHATTERBOT.update(defaults.CHATTERBOT_DEFAULTS)

chatterbot/ext/django_chatterbot/migrations/0020_alter_statement_conversation_and_more.py

@@ -0,0 +1,53 @@
+# Generated by Django 4.1 on 2025-03-29 23:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_chatterbot', '0019_alter_statement_id_alter_tag_id_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='statement',
+            name='conversation',
+            field=models.CharField(help_text='A label used to link this statement to a conversation.', max_length=32),
+        ),
+        migrations.AlterField(
+            model_name='statement',
+            name='in_response_to',
+            field=models.CharField(help_text='The text of the statement that this statement is in response to.', max_length=255, null=True),
+        ),
+        migrations.AlterField(
+            model_name='statement',
+            name='persona',
+            field=models.CharField(help_text='A label used to link this statement to a persona.', max_length=50),
+        ),
+        migrations.AlterField(
+            model_name='statement',
+            name='search_in_response_to',
+            field=models.CharField(blank=True, help_text='A modified version of the in_response_to text optimized for searching.', max_length=255),
+        ),
+        migrations.AlterField(
+            model_name='statement',
+            name='search_text',
+            field=models.CharField(blank=True, help_text='A modified version of the statement text optimized for searching.', max_length=255),
+        ),
+        migrations.AlterField(
+            model_name='statement',
+            name='tags',
+            field=models.ManyToManyField(help_text='The tags that are associated with this statement.', related_name='statements', to='django_chatterbot.tag'),
+        ),
+        migrations.AlterField(
+            model_name='statement',
+            name='text',
+            field=models.CharField(help_text='The text of the statement.', max_length=255),
+        ),
+        migrations.AlterField(
+            model_name='tag',
+            name='name',
+            field=models.SlugField(help_text='The unique name of the tag.', unique=True),
+        ),
+    ]

chatterbot/ext/django_chatterbot/settings.py

@@ -5,7 +5,7 @@ from django.conf import settings
 from chatterbot import constants
 
 
-CHATTERBOT_SETTINGS = getattr(settings, 'CHATTERBOT', {})
+CHATTERBOT = getattr(settings, 'CHATTERBOT', {})
 
 CHATTERBOT_DEFAULTS = {
     'name': 'ChatterBot',
@@ -13,5 +13,4 @@ CHATTERBOT_DEFAULTS = {
     'django_app_name': constants.DEFAULT_DJANGO_APP_NAME
 }
 
-CHATTERBOT = CHATTERBOT_DEFAULTS.copy()
-CHATTERBOT.update(CHATTERBOT_SETTINGS)
+CHATTERBOT.update(CHATTERBOT_DEFAULTS)

chatterbot/logic/logic_adapter.py

@@ -4,6 +4,7 @@ from chatterbot.adapters import Adapter
 from chatterbot.storage import StorageAdapter
 from chatterbot.search import IndexedTextSearch
 from chatterbot.conversation import Statement
+from chatterbot import utils
 
 
 class LogicAdapter(Adapter):
@@ -28,7 +29,7 @@ class LogicAdapter(Adapter):
     :type response_selection_method: collections.abc.Callable
 
     :param default_response:
-          The default response returned by this logic adaper
+          The default response returned by this logic adapter
           if there is no other possible response to return.
     :type default_response: str or list or tuple
     """
@@ -50,6 +51,14 @@ class LogicAdapter(Adapter):
             'maximum_similarity_threshold', 0.95
         )
 
+        if response_selection_method := kwargs.get('response_selection_method'):
+            if isinstance(response_selection_method, str):
+                # If an import path is provided, import the method
+                response_selection_method = utils.import_module(
+                    response_selection_method
+                )
+                kwargs['response_selection_method'] = response_selection_method
+
         # By default, select the first available response
         self.select_response = kwargs.get(
             'response_selection_method',
@@ -68,18 +77,16 @@ class LogicAdapter(Adapter):
             Statement(text=default) for default in default_responses
         ]
 
-    def can_process(self, statement):
+    def can_process(self, statement) -> bool:
         """
         A preliminary check that is called to determine if a
         logic adapter can process a given statement. By default,
         this method returns true but it can be overridden in
         child classes as needed.
-
-        :rtype: bool
         """
         return True
 
-    def process(self, statement, additional_response_selection_parameters=None):
+    def process(self, statement, additional_response_selection_parameters=None) -> Statement:
         """
         Override this method and implement your logic for selecting a response to an input statement.
 
@@ -97,12 +104,10 @@ class LogicAdapter(Adapter):
         :param additional_response_selection_parameters: Parameters to be used when
             filtering results to choose a response from.
         :type additional_response_selection_parameters: dict
-
-        :rtype: Statement
         """
         raise self.AdapterMethodNotImplementedError()
 
-    def get_default_response(self, input_statement):
+    def get_default_response(self, input_statement: Statement) -> Statement:
         """
         This method is called when a logic adapter is unable to generate any
         other meaningful response.
@@ -125,7 +130,7 @@ class LogicAdapter(Adapter):
         return response
 
     @property
-    def class_name(self):
+    def class_name(self) -> str:
         """
         Return the name of the current logic adapter class.
         This is typically used for logging and debugging.

chatterbot/preprocessors.py

@@ -1,12 +1,13 @@
 """
 Statement pre-processors.
 """
+from chatterbot.conversation import Statement
 from unicodedata import normalize
 from re import sub as re_sub
 from html import unescape
 
 
-def clean_whitespace(statement):
+def clean_whitespace(statement: Statement) -> Statement:
     """
     Remove any consecutive whitespace characters from the statement text.
     """
@@ -24,7 +25,7 @@ def clean_whitespace(statement):
     return statement
 
 
-def unescape_html(statement):
+def unescape_html(statement: Statement) -> Statement:
     """
     Convert escaped html characters into unescaped html characters.
     For example: "&lt;b&gt;" becomes "<b>".
@@ -34,7 +35,7 @@ def unescape_html(statement):
     return statement
 
 
-def convert_to_ascii(statement):
+def convert_to_ascii(statement: Statement) -> Statement:
     """
     Converts unicode characters to ASCII character equivalents.
     For example: "på fédéral" becomes "pa federal".

chatterbot/response_selection.py

@@ -2,10 +2,11 @@
 Response selection methods determines which response should be used in
 the event that multiple responses are generated within a logic adapter.
 """
+from chatterbot.conversation import Statement
 import logging
 
 
-def get_most_frequent_response(input_statement, response_list, storage=None):
+def get_most_frequent_response(input_statement, response_list, storage=None) -> Statement:
     """
     :param input_statement: A statement, that closely matches an input to the chat bot.
     :type input_statement: Statement
@@ -18,7 +19,6 @@ def get_most_frequent_response(input_statement, response_list, storage=None):
     :type storage: StorageAdapter
 
     :return: The response statement with the greatest number of occurrences.
-    :rtype: Statement
     """
     matching_response = None
     occurrence_count = -1
@@ -41,7 +41,7 @@ def get_most_frequent_response(input_statement, response_list, storage=None):
     return matching_response
 
 
-def get_first_response(input_statement, response_list, storage=None):
+def get_first_response(input_statement, response_list, storage=None) -> Statement:
     """
     :param input_statement: A statement, that closely matches an input to the chat bot.
     :type input_statement: Statement
@@ -54,7 +54,6 @@ def get_first_response(input_statement, response_list, storage=None):
     :type storage: StorageAdapter
 
     :return: Return the first statement in the response list.
-    :rtype: Statement
     """
     logger = logging.getLogger(__name__)
     logger.info('Selecting first response from list of {} options.'.format(
@@ -63,7 +62,7 @@ def get_first_response(input_statement, response_list, storage=None):
     return response_list[0]
 
 
-def get_random_response(input_statement, response_list, storage=None):
+def get_random_response(input_statement, response_list, storage=None) -> Statement:
     """
     :param input_statement: A statement, that closely matches an input to the chat bot.
     :type input_statement: Statement
@@ -76,7 +75,6 @@ def get_random_response(input_statement, response_list, storage=None):
     :type storage: StorageAdapter
 
     :return: Choose a random response from the selection.
-    :rtype: Statement
     """
     from random import choice
     logger = logging.getLogger(__name__)

chatterbot/storage/django_storage.py

@@ -110,6 +110,9 @@ class DjangoStorageAdapter(StorageAdapter):
 
         tags = kwargs.pop('tags', [])
 
+        if 'search_in_response_to' in kwargs and kwargs['search_in_response_to'] is None:
+            kwargs['search_in_response_to'] = ''
+
         statement = Statement(**kwargs)
 
         statement.save()
@@ -169,7 +172,7 @@ class DjangoStorageAdapter(StorageAdapter):
                 search_text=statement.search_text,
                 conversation=statement.conversation,
                 in_response_to=statement.in_response_to,
-                search_in_response_to=statement.search_in_response_to,
+                search_in_response_to=statement.search_in_response_to or '',
                 created_at=statement.created_at
             )
 

chatterbot/storage/sql_storage.py

@@ -44,7 +44,7 @@ class SQLStorageAdapter(StorageAdapter):
                 dbapi_connection.execute('PRAGMA journal_mode=WAL')
                 dbapi_connection.execute('PRAGMA synchronous=NORMAL')
 
-        if not inspect(self.engine).has_table(self.engine, 'statement'):
+        if not inspect(self.engine).has_table('statement'):
             self.create_database()
 
         # Check if the expected index exists on the text field of the statement table

chatterbot/tagging.py

@@ -1,3 +1,4 @@
+from typing import List, Union, Tuple
 from chatterbot import languages
 from chatterbot.utils import get_model_for_language
 import spacy
@@ -20,7 +21,7 @@ class LowercaseTagger(object):
             'chatterbot_lowercase_indexer', name='chatterbot_lowercase_indexer', last=True
         )
 
-    def get_text_index_string(self, text):
+    def get_text_index_string(self, text: Union[str, List[str]]):
         if isinstance(text, list):
             documents = self.nlp.pipe(text)
             return [document._.search_index for document in documents]
@@ -28,7 +29,7 @@ class LowercaseTagger(object):
             document = self.nlp(text)
             return document._.search_index
 
-    def as_nlp_pipeline(self, texts):
+    def as_nlp_pipeline(self, texts: Union[List[str], Tuple[str, dict]]):
 
         process_as_tuples = texts and isinstance(texts[0], tuple)
 
@@ -52,7 +53,7 @@ class PosLemmaTagger(object):
             'chatterbot_bigram_indexer', name='chatterbot_bigram_indexer', last=True
         )
 
-    def get_text_index_string(self, text):
+    def get_text_index_string(self, text: Union[str, List[str]]):
         """
         Return a string of text containing part-of-speech, lemma pairs.
         """
@@ -63,7 +64,7 @@ class PosLemmaTagger(object):
             document = self.nlp(text)
             return document._.search_index
 
-    def as_nlp_pipeline(self, texts):
+    def as_nlp_pipeline(self, texts: Union[List[str], Tuple[str, dict]]):
         """
         Accepts a single string or a list of strings, or a list of tuples
         where the first element is the text and the second element is a

chatterbot/trainers.py

@@ -1,12 +1,13 @@
 import os
-import sys
 import csv
 import time
 import glob
 import json
 import tarfile
+from typing import List, Union
 from tqdm import tqdm
 from dateutil import parser as date_parser
+from chatterbot.chatterbot import ChatBot
 from chatterbot.conversation import Statement
 
 
@@ -20,7 +21,7 @@ class Trainer(object):
            the environment variable if it is set.
     """
 
-    def __init__(self, chatbot, **kwargs):
+    def __init__(self, chatbot: ChatBot, **kwargs):
         self.chatbot = chatbot
 
         environment_default = bool(int(os.environ.get('CHATTERBOT_SHOW_TRAINING_PROGRESS', True)))
@@ -30,7 +31,7 @@ class Trainer(object):
             environment_default
         )
 
-    def get_preprocessed_statement(self, input_statement):
+    def get_preprocessed_statement(self, input_statement: Statement) -> Statement:
         """
         Preprocess the input statement.
         """
@@ -58,7 +59,7 @@ class Trainer(object):
             )
             super().__init__(message or default)
 
-    def _generate_export_data(self):
+    def _generate_export_data(self) -> list:
         result = []
         for statement in self.chatbot.storage.filter():
             if statement.in_response_to:
@@ -82,7 +83,7 @@ class ListTrainer(Trainer):
     where the list represents a conversation.
     """
 
-    def train(self, conversation: list):
+    def train(self, conversation: List[str]):
         """
         Train the chat bot based on the provided list of
         statements that represents a single conversation.
@@ -95,7 +96,6 @@ class ListTrainer(Trainer):
         # Run the pipeline in bulk to improve performance
         documents = self.chatbot.tagger.as_nlp_pipeline(conversation)
 
-        # for text in enumerate(conversation):
         for document in tqdm(documents, desc='List Trainer', disable=self.disable_progress):
             statement_search_text = document._.search_index
 
@@ -123,7 +123,7 @@ class ChatterBotCorpusTrainer(Trainer):
     ChatterBot dialog corpus.
     """
 
-    def train(self, *corpus_paths):
+    def train(self, *corpus_paths: Union[str, List[str]]):
         from chatterbot.corpus import load_corpus, list_corpus_files
 
         data_file_paths = []
@@ -178,7 +178,17 @@ class GenericFileTrainer(Trainer):
     or directory of those file types.
     """
 
-    def __init__(self, chatbot, **kwargs):
+    # NOTE: If the value is an integer, this be the
+    # column index instead of the key or header
+    DEFAULT_STATEMENT_TO_HEADER_MAPPING = {
+        'text': 'text',
+        'conversation': 'conversation',
+        'created_at': 'created_at',
+        'persona': 'persona',
+        'tags': 'tags'
+    }
+
+    def __init__(self, chatbot: ChatBot, **kwargs):
         """
         data_path: str The path to the data file or directory.
         field_map: dict A dictionary containing the column name to header mapping.
@@ -187,22 +197,12 @@ class GenericFileTrainer(Trainer):
 
         self.file_extension = None
 
-        # NOTE: If the key is an integer, this be the
-        # column index instead of the key or header
-        DEFAULT_STATEMENT_TO_HEADER_MAPPING = {
-            'text': 'text',
-            'conversation': 'conversation',
-            'created_at': 'created_at',
-            'persona': 'persona',
-            'tags': 'tags'
-        }
-
         self.field_map = kwargs.get(
             'field_map',
-            DEFAULT_STATEMENT_TO_HEADER_MAPPING
+            self.DEFAULT_STATEMENT_TO_HEADER_MAPPING
         )
 
-    def _get_file_list(self, data_path, limit):
+    def _get_file_list(self, data_path: str, limit: Union[int, None]):
         """
         Get a list of files to read from the data set.
         """
@@ -210,7 +210,7 @@ class GenericFileTrainer(Trainer):
         if self.file_extension is None:
             raise self.TrainerInitializationException(
                 'The file_extension attribute must be set before calling train().'
-            ) 
+            )
 
         # List all csv or json files in the specified directory
         if os.path.isdir(data_path):
@@ -226,7 +226,7 @@ class GenericFileTrainer(Trainer):
 
                 yield file_path
         else:
-            return [data_path]
+            yield data_path
 
     def train(self, data_path: str, limit=None):
         """
@@ -254,7 +254,9 @@ class GenericFileTrainer(Trainer):
 
             statements_to_create = []
 
-            with open(data_file, 'r', encoding='utf-8') as file:
+            file_abspath = os.path.abspath(data_file)
+
+            with open(file_abspath, 'r', encoding='utf-8') as file:
 
                 if self.file_extension == 'json':
                     data = json.load(file)
@@ -281,18 +283,39 @@ class GenericFileTrainer(Trainer):
 
                 text_row = self.field_map['text']
 
-                documents = self.chatbot.tagger.as_nlp_pipeline([
+                try:
+                    documents = self.chatbot.tagger.as_nlp_pipeline([
+                        (
+                            row[text_row],
+                            {
+                                # Include any defined metadata columns
+                                key: row[value]
+                                for key, value in self.field_map.items()
+                                if key != text_row
+                            }
+                        ) for row in data if len(row) > 0
+                    ])
+                except KeyError as e:
+                    raise KeyError(
+                        f'{e}. Please check the field_map parameter used to initialize '
+                        f'the training class and remove this value if it is not needed. '
+                        f'Current mapping: {self.field_map}'
+                    )
+
+            response_to_search_index_mapping = {}
+
+            if 'in_response_to' in self.field_map.keys():
+                # Generate the search_in_response_to value for the in_response_to fields
+                response_documents = self.chatbot.tagger.as_nlp_pipeline([
                     (
-                        row[text_row],
-                        {
-                            # Include any defined metadata columns
-                            key: row[value]
-                            for key, value in self.field_map.items()
-                            if key != text_row
-                        }
-                    ) for row in data if len(row) > 0
+                        row[self.field_map['in_response_to']]
+                    ) for row in data if len(row) > 0 and row[self.field_map['in_response_to']] is not None
                 ])
 
+                # (Process the response values the same way as the text values)
+                for document in response_documents:
+                    response_to_search_index_mapping[document.text] = document._.search_index
+
             for document, context in documents:
                 statement = Statement(
                     text=document.text,
@@ -305,14 +328,19 @@ class GenericFileTrainer(Trainer):
                     statement.created_at = date_parser.parse(context['created_at'])
 
                 statement.search_text = document._.search_index
-                statement.search_in_response_to = previous_statement_search_text
 
                 # Use the in_response_to attribute for the previous statement if
                 # one is defined, otherwise use the last statement which was created
                 if 'in_response_to' in self.field_map.keys():
                     statement.in_response_to = context.get(self.field_map['in_response_to'], None)
+                    statement.search_in_response_to = response_to_search_index_mapping.get(
+                        context.get(self.field_map['in_response_to'], None), ''
+                    )
                 else:
+                    # List-type data such as CSVs with no response specified can use
+                    # the previous statement as the in_response_to value
                     statement.in_response_to = previous_statement_text
+                    statement.search_in_response_to = previous_statement_search_text
 
                 for preprocessor in self.chatbot.preprocessors:
                     statement = preprocessor(statement)
@@ -336,7 +364,6 @@ class GenericFileTrainer(Trainer):
                 )
             )
 
-
 class CsvFileTrainer(GenericFileTrainer):
     """
     .. note::
@@ -349,11 +376,11 @@ class CsvFileTrainer(GenericFileTrainer):
     parameter is set to 'tsv'.
 
     :param str file_extension: The file extension to look for when searching for files (defaults to 'csv').
-    :param str field_map: A dictionary containing the database column name to header mapping.
+    :param dict field_map: A dictionary containing the database column name to header mapping.
                           Values can be either the header name (str) or the column index (int).
     """
 
-    def __init__(self, chatbot, **kwargs):
+    def __init__(self, chatbot: ChatBot, **kwargs):
         super().__init__(chatbot, **kwargs)
 
         self.file_extension = kwargs.get('file_extension', 'csv')
@@ -367,26 +394,26 @@ class JsonFileTrainer(GenericFileTrainer):
     Allow chatbots to be trained with data from a JSON file or
     directory of JSON files.
 
-    :param str field_map: A dictionary containing the database column name to header mapping.
+    :param dict field_map: A dictionary containing the database column name to header mapping.
     """
 
-    def __init__(self, chatbot, **kwargs):
+    DEFAULT_STATEMENT_TO_KEY_MAPPING = {
+        'text': 'text',
+        'conversation': 'conversation',
+        'created_at': 'created_at',
+        'in_response_to': 'in_response_to',
+        'persona': 'persona',
+        'tags': 'tags'
+    }
+
+    def __init__(self, chatbot: ChatBot, **kwargs):
         super().__init__(chatbot, **kwargs)
 
         self.file_extension = 'json'
 
-        DEFAULT_STATEMENT_TO_KEY_MAPPING = {
-            'text': 'text',
-            'conversation': 'conversation',
-            'created_at': 'created_at',
-            'in_response_to': 'in_response_to',
-            'persona': 'persona',
-            'tags': 'tags'
-        }
-
         self.field_map = kwargs.get(
             'field_map',
-            DEFAULT_STATEMENT_TO_KEY_MAPPING
+            self.DEFAULT_STATEMENT_TO_KEY_MAPPING
         )
 
 
@@ -403,7 +430,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
     :param str ubuntu_corpus_data_directory: The directory where the Ubuntu corpus data is already located, or where it should be downloaded and extracted.
     """
 
-    def __init__(self, chatbot, **kwargs):
+    def __init__(self, chatbot: ChatBot, **kwargs):
         super().__init__(chatbot, **kwargs)
         home_directory = os.path.expanduser('~')
 
@@ -425,7 +452,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
             'persona': 1,
         }
 
-    def is_downloaded(self, file_path):
+    def is_downloaded(self, file_path: str):
         """
         Check if the data file is already downloaded.
         """
@@ -435,7 +462,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
 
         return False
 
-    def is_extracted(self, file_path):
+    def is_extracted(self, file_path: str):
         """
         Check if the data file is already extracted.
         """
@@ -445,7 +472,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
             return True
         return False
 
-    def download(self, url, show_status=True):
+    def download(self, url: str, show_status=True):
         """
         Download a file from the given url.
         Show a progress indicator for the download status.
@@ -484,7 +511,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
             print('Download location: %s' % file_path)
         return file_path
 
-    def extract(self, file_path):
+    def extract(self, file_path: str):
         """
         Extract a tar file at the specified file path.
         """
@@ -524,7 +551,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
 
         return True
     
-    def _get_file_list(self, data_path, limit):
+    def _get_file_list(self, data_path: str, limit: Union[int, None]):
         """
         Get a list of files to read from the data set.
         """
@@ -555,7 +582,7 @@ class UbuntuCorpusTrainer(CsvFileTrainer):
 
             yield file_path
 
-    def train(self, data_download_url, limit=None):
+    def train(self, data_download_url: str, limit: Union[int, None] = None):
         """
         :param str data_download_url: The URL to download the Ubuntu dialog corpus from.
         :param int limit: The maximum number of files to train from.

chatterbot/utils.py

@@ -3,7 +3,6 @@ ChatterBot utility functions
 """
 import importlib
 import time
-import sys
 
 
 def import_module(dotted_path):
@@ -71,7 +70,7 @@ def validate_adapter_class(validate_class, adapter_class):
         )
 
 
-def get_response_time(chatbot, statement='Hello'):
+def get_response_time(chatbot, statement='Hello') -> float:
     """
     Returns the amount of time taken for a given
     chat bot to return a response.
@@ -80,7 +79,6 @@ def get_response_time(chatbot, statement='Hello'):
     :type chatbot: ChatBot
 
     :returns: The response time in seconds.
-    :rtype: float
     """
     start_time = time.time()
 

{chatterbot-1.2.4.dist-info → chatterbot-1.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ChatterBot
-Version: 1.2.4
+Version: 1.2.6
 Summary: ChatterBot is a machine learning, conversational dialog engine
 Author: Gunther Cox
 License-Expression: BSD-3-Clause
@@ -66,10 +66,11 @@ known conversations. The language independent design of ChatterBot allows it
 to be trained to speak any language.
 
 [![Package Version](https://img.shields.io/pypi/v/chatterbot.svg)](https://pypi.python.org/pypi/chatterbot/)
-[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-360/)
+[![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-360/)
 [![Coverage Status](https://img.shields.io/coveralls/gunthercox/ChatterBot.svg)](https://coveralls.io/r/gunthercox/ChatterBot)
-[![Code Climate](https://codeclimate.com/github/gunthercox/ChatterBot/badges/gpa.svg)](https://codeclimate.com/github/gunthercox/ChatterBot)
+[![Follow on Bluesky](https://img.shields.io/badge/🦋%20Bluesky-1185fe)](https://bsky.app/profile/chatterbot.us)
 [![Join the chat at https://gitter.im/chatterbot/Lobby](https://badges.gitter.im/chatterbot/Lobby.svg)](https://gitter.im/chatterbot/Lobby?utm_source=badge&utm_medium=badge&utm_content=badge)
+<!-- [![Code Climate](https://codeclimate.com/github/gunthercox/ChatterBot/badges/gpa.svg)](https://codeclimate.com/github/gunthercox/ChatterBot) -->
 
 An example of typical input would be something like this:
 

{chatterbot-1.2.4.dist-info → chatterbot-1.2.6.dist-info}/RECORD

@@ -1,31 +1,31 @@
-chatterbot/__init__.py,sha256=Woq2bFnaAs8yTE2HVPsxXEyzFrXs1njsGJnJVgbYGvI,158
+chatterbot/__init__.py,sha256=wHoKxLsCOplHJ02JmxRCg5cRL-Z-blQblhJKdE95Pck,158
 chatterbot/__main__.py,sha256=zvH4uxtGlGrP-ht_LkhX29duzjm3hRH800SDCq4YOwg,637
 chatterbot/adapters.py,sha256=LJ_KqLpHKPdYAFpMGK63RVH4weV5X0Zh5uGyan6qdVU,878
-chatterbot/chatterbot.py,sha256=BW_XQK78iOvc0fZ8EsEglNUdjyRE2lxUI_sP-fa4gCc,12505
-chatterbot/comparisons.py,sha256=8kkjW-lhS-57XSUlQI5B-dAdJO-CvkIirWLBKtbe4gw,6187
+chatterbot/chatterbot.py,sha256=nqxdeTBWdA_LDIEWTMf2gphvpNfd0c9htNwrxa_7pzo,12543
+chatterbot/comparisons.py,sha256=kYYR5DUipdzr7ok08m8s6r9LBez4GBQICaSmLZcmoiM,6184
 chatterbot/components.py,sha256=ld3Xam8olBClvE5QqcFYggE7Q7tODCFek7BO7lhfyeU,1782
 chatterbot/constants.py,sha256=c_KPQKc82CHX6H3maeyTYqWatx6j-N-8HJhmejoVi60,1875
-chatterbot/conversation.py,sha256=Y-WOxPN7I3igRyAEe5py1sfS6JIYPdbwjVlY3kM8Ys8,3175
+chatterbot/conversation.py,sha256=-JshXr4Uvsl8NVeEgm1am2e4UStBN1BXfMQHYkQFvco,3162
 chatterbot/corpus.py,sha256=n1sFU0KF-oRdj7g3nXft7uHOVilwbj_mVZnaeIHgC54,2409
 chatterbot/exceptions.py,sha256=gqAlckDna6SB53kyqutmCtCqWxia40WBdUOnGVQ2Kbk,163
 chatterbot/filters.py,sha256=vDSDJz2FM10xT6ybs7qJiqy4X5I4gTEfwEnjBGUxZ9g,847
 chatterbot/languages.py,sha256=XSenfc5FxHk_JWG5gGHsZvjvrPBbCaVCm_OU-BeER_M,32784
 chatterbot/parsing.py,sha256=vS-w70cMkjq4YEpDOv_pXWhAI6Zj06WYDAcMDhYDj0M,23174
-chatterbot/preprocessors.py,sha256=aI4v987dZc7GOKhO43i0i73EX748hehYSpzikFHpEXs,1271
-chatterbot/response_selection.py,sha256=aYeZ54jpGIcQnI-1-TDcua_f1p3PiM5_iMg4hF5ZaIU,2951
+chatterbot/preprocessors.py,sha256=kqsgnejSj6Z1rr9U2TGHKOp-MMaFWBdNT41EwyhQFls,1389
+chatterbot/response_selection.py,sha256=JpUVuBYrgxhHkDMRHXyWvhluSLxQED5mAhE1-VvJSmg,2970
 chatterbot/search.py,sha256=FTwwON2eKPWqoc5uoKh4AUmuXDCqyfMcMcXB4wijpxg,4910
-chatterbot/tagging.py,sha256=czcI2g18vILujphkjvobRyEewJU8-QjS7QRzY-hCZ4o,2429
-chatterbot/trainers.py,sha256=9mxi1_UmtiuXuEzpn4uztnV8PObD0Xt0PrAbTZ6oyt0,19294
-chatterbot/utils.py,sha256=tGmUt-KYYylD2fiG_oq_XxhGbAHukzwudZ_6hNuraIA,2944
+chatterbot/tagging.py,sha256=si0PQ3CY5EbiZ0-PIslbBtExZaQZ3NYrLUGoourweKo,2585
+chatterbot/trainers.py,sha256=CZezNX68Byg9gg2z-PUZbTc5pqzTzbhgSmqHx7P6Ivg,20973
+chatterbot/utils.py,sha256=ubPiBapvUvdFVhrDjxqq5IGekUh9qMUJs_dQ605xLAI,2924
 chatterbot/vectorstores.py,sha256=-S1NB8PrZzoFIu95n2W7N4UaXuCUpyDUXIGYFebjv08,2056
 chatterbot/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 chatterbot/ext/django_chatterbot/__init__.py,sha256=iWzmBzpAsYwkwi1faxAPFY9L1bbL97RgVXK2uqULIMc,92
-chatterbot/ext/django_chatterbot/abstract_models.py,sha256=PkuBGS0uv2toL3jGE1U6HJLCLXoKwpRNohm9JbVT_y4,3303
+chatterbot/ext/django_chatterbot/abstract_models.py,sha256=skMqOqxIL_xOyfU8ZabtDqzUKTz0YtqGkaylB3TC1JA,3883
 chatterbot/ext/django_chatterbot/admin.py,sha256=jyCJGLRcRoeaoYWZFv-TCivcDUNTE4Li7pmYE8_hYCM,266
-chatterbot/ext/django_chatterbot/apps.py,sha256=Gsk3wEv2raklK79D8eKXXEY1OMMjGHnFIFSdvnaMgzo,195
+chatterbot/ext/django_chatterbot/apps.py,sha256=YSqF77pD9Pl2-BP6KeQZRr22XhL8gInpHVkVTLtZsUU,464
 chatterbot/ext/django_chatterbot/model_admin.py,sha256=aJVE6u1fquMrvFTm_0aclK6FSAcUtfZcj-RPnXmm6iM,353
 chatterbot/ext/django_chatterbot/models.py,sha256=GqIXvDxSRKaeFgAVh71t9MRS6qEAIOUQ8a42I4wBxYs,360
-chatterbot/ext/django_chatterbot/settings.py,sha256=JH59sMoX06yC346VCA7W1unQkiNnHE2ryAMgEiYWogo,430
+chatterbot/ext/django_chatterbot/settings.py,sha256=CBPnTLCIrznPm_YHd0-ss8E_gzRrydujBX37gI0G0gA,381
 chatterbot/ext/django_chatterbot/migrations/0001_initial.py,sha256=mZQYculJOOVyo9QdSlnbT3Bp_B5_e7y81aEyRQjfRgQ,1266
 chatterbot/ext/django_chatterbot/migrations/0002_statement_extra_data.py,sha256=hbMubk-eBsseP8QZ5pxt13jrxP5e5RJyEFOqxxk5Tzk,441
 chatterbot/ext/django_chatterbot/migrations/0003_change_occurrence_default.py,sha256=maDz1Y9F5oTeCFotQdk7Tf-hpkjWVUqiDVXP4nQJTNg,408
@@ -45,24 +45,25 @@ chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py,sha25
 chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py,sha256=3RGCsV9fAFAYjuyHbGVUXFdzvT3fj9FAKoNZmyfaR9M,692
 chatterbot/ext/django_chatterbot/migrations/0018_text_max_length.py,sha256=508TxWE8xGff1jKExxxBj9Ulu9Exz6rWDHnNxFli2xU,876
 chatterbot/ext/django_chatterbot/migrations/0019_alter_statement_id_alter_tag_id_and_more.py,sha256=rsVxwDFMQ-cU1KMhjDq9Wcl_6gTPKc_dc3p-gv_R7v8,999
+chatterbot/ext/django_chatterbot/migrations/0020_alter_statement_conversation_and_more.py,sha256=PpcIvl6sO9jNBxW4UgvFMv_j0eNmUBHire5qo7u-XAg,2133
 chatterbot/ext/django_chatterbot/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 chatterbot/ext/sqlalchemy_app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 chatterbot/ext/sqlalchemy_app/models.py,sha256=ZQ-R_5rA-f1agaqYGUQhuuO7zx__BvTDUvJo5R7ZrDY,2492
 chatterbot/logic/__init__.py,sha256=28-5swBCPfSVMl8xB5C8frOKZ2oj28rQfenbd9E4r-4,531
 chatterbot/logic/best_match.py,sha256=8TNW0uZ_Uq-XPfaZUMUZDVH6KzDT65j59xblxQBv-dQ,4820
-chatterbot/logic/logic_adapter.py,sha256=5kNEirh5fiF5hhSMFXD7bIkKwXHmrSsSS4qDm-6xry0,4694
+chatterbot/logic/logic_adapter.py,sha256=zcYrzyywZ0kT3GsjcMRr69abvswurlNYOPLsUpIwaB8,5144
 chatterbot/logic/mathematical_evaluation.py,sha256=GPDKUwNFajERof2R-MkPGi2jJRP-rKAGm_f0V9JHDHE,2282
 chatterbot/logic/specific_response.py,sha256=akWHkfe0AjzlCUvjs_PbKFNkX4SZhu_tzY45xCRXoo0,2236
 chatterbot/logic/time_adapter.py,sha256=1PT6tWtGauZLRH02-Xlh2LublDpu_3hnCqHBqNGM9yg,2256
 chatterbot/logic/unit_conversion.py,sha256=-ENMLqZqtZx0riUi0guda2oJECST0M7pZG4cSIv3ieM,5898
 chatterbot/storage/__init__.py,sha256=ADw0WQe0YKr1UIDQLaxwf0mHDnuKW_CSzgz11K4TM-4,465
-chatterbot/storage/django_storage.py,sha256=S5S4GipD7FyNJy4RWu5-S8sLPuSJIObwTtqTpnJu-ok,6159
+chatterbot/storage/django_storage.py,sha256=BpuVEO4rPOiPu7f7KW1Zyar2LqEXy6I4HgPYhyGP0kE,6305
 chatterbot/storage/mongodb.py,sha256=Ozvdvcjb3LGZxcvbSQGzwP9VloYQbmsa2FaKunFpMyU,7934
 chatterbot/storage/redis.py,sha256=FKROrzZ-7WXZ8ZoK0dKmTDdS45TxL04XOSeu0p3Jrak,12675
-chatterbot/storage/sql_storage.py,sha256=dAMLByFKQgbiTFoBUtKDeqadYRdwVO5fz1OONTcVCH4,13076
+chatterbot/storage/sql_storage.py,sha256=wESsp0OKuXjYmAZ7dl-ztX7lt4xEpjD0WCBQXK22__4,13063
 chatterbot/storage/storage_adapter.py,sha256=fvyb-qNiB0HMJ0siVMCWUIY--6d-C47N1_kKZVFZAv4,6110
-chatterbot-1.2.4.dist-info/licenses/LICENSE,sha256=5b04U8mi0wp5gJMYlKi49EalnD9Q2nwY_6UEI_Avgu4,1476
-chatterbot-1.2.4.dist-info/METADATA,sha256=lrGa5gxvPrNRh6fCKqr7zPvRp_qmY293ijj0ODW4uZM,7049
-chatterbot-1.2.4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-chatterbot-1.2.4.dist-info/top_level.txt,sha256=W2TzAbAJ-eBXTIKZZhVlkrh87msJNmBQpyhkrHqjSrE,11
-chatterbot-1.2.4.dist-info/RECORD,,
+chatterbot-1.2.6.dist-info/licenses/LICENSE,sha256=5b04U8mi0wp5gJMYlKi49EalnD9Q2nwY_6UEI_Avgu4,1476
+chatterbot-1.2.6.dist-info/METADATA,sha256=lOBXOb2GEaOguy3_Rwqo_TEP77GeunbhiI9BGqB1zfc,7175
+chatterbot-1.2.6.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+chatterbot-1.2.6.dist-info/top_level.txt,sha256=W2TzAbAJ-eBXTIKZZhVlkrh87msJNmBQpyhkrHqjSrE,11
+chatterbot-1.2.6.dist-info/RECORD,,