ChatterBot 1.2.3__tar.gz → 1.2.4__tar.gz

{chatterbot-1.2.3 → chatterbot-1.2.4}/ChatterBot.egg-info/PKG-INFO

@@ -1,27 +1,15 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ChatterBot
-Version: 1.2.3
+Version: 1.2.4
 Summary: ChatterBot is a machine learning, conversational dialog engine
 Author: Gunther Cox
-License: Copyright (c) 2016 - 2025, Gunther Cox
-        All rights reserved.
-        
-        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-        
-        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-        
-        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-        
-        * Neither the name of ChatterBot nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
+License-Expression: BSD-3-Clause
 Project-URL: Documentation, https://docs.chatterbot.us
 Project-URL: Repository, https://github.com/gunthercox/ChatterBot
+Project-URL: Changelog, https://github.com/gunthercox/ChatterBot/releases
 Keywords: ChatterBot,chatbot,chat,bot,natural language processing,nlp,artificial intelligence,ai
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -40,7 +28,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: ~=3.9
+Requires-Python: <3.13,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mathparse<0.2,>=0.1
@@ -54,6 +42,7 @@ Requires-Dist: coverage; extra == "test"
 Requires-Dist: nose; extra == "test"
 Requires-Dist: sphinx<8.2,>=5.3; extra == "test"
 Requires-Dist: sphinx-sitemap>=2.6.0; extra == "test"
+Requires-Dist: huggingface_hub; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pint>=0.8.1; extra == "dev"
 Requires-Dist: pyyaml<7.0,>=6.0; extra == "dev"
@@ -65,6 +54,7 @@ Requires-Dist: langchain-huggingface; extra == "redis"
 Requires-Dist: sentence-transformers; extra == "redis"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<4.12,>=4.11; extra == "mongodb"
+Dynamic: license-file
 
 ![ChatterBot: Machine learning in Python](https://i.imgur.com/b3SCmGT.png)
 
@@ -167,7 +157,7 @@ See release notes for changes https://github.com/gunthercox/ChatterBot/releases
    a new branch `my-pull-request`.
 3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/).
 4. Please follow the [Python style guide for PEP-8](https://www.python.org/dev/peps/pep-0008/).
-5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing.html).
+5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing/).
    to help make sure that your contribution is free from errors.
 
 # License

{chatterbot-1.2.3 → chatterbot-1.2.4}/ChatterBot.egg-info/requires.txt

@@ -24,3 +24,4 @@ coverage
 nose
 sphinx<8.2,>=5.3
 sphinx-sitemap>=2.6.0
+huggingface_hub

{chatterbot-1.2.3 → chatterbot-1.2.4}/PKG-INFO

@@ -1,27 +1,15 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ChatterBot
-Version: 1.2.3
+Version: 1.2.4
 Summary: ChatterBot is a machine learning, conversational dialog engine
 Author: Gunther Cox
-License: Copyright (c) 2016 - 2025, Gunther Cox
-        All rights reserved.
-        
-        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-        
-        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-        
-        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-        
-        * Neither the name of ChatterBot nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
+License-Expression: BSD-3-Clause
 Project-URL: Documentation, https://docs.chatterbot.us
 Project-URL: Repository, https://github.com/gunthercox/ChatterBot
+Project-URL: Changelog, https://github.com/gunthercox/ChatterBot/releases
 Keywords: ChatterBot,chatbot,chat,bot,natural language processing,nlp,artificial intelligence,ai
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -40,7 +28,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: ~=3.9
+Requires-Python: <3.13,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mathparse<0.2,>=0.1
@@ -54,6 +42,7 @@ Requires-Dist: coverage; extra == "test"
 Requires-Dist: nose; extra == "test"
 Requires-Dist: sphinx<8.2,>=5.3; extra == "test"
 Requires-Dist: sphinx-sitemap>=2.6.0; extra == "test"
+Requires-Dist: huggingface_hub; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pint>=0.8.1; extra == "dev"
 Requires-Dist: pyyaml<7.0,>=6.0; extra == "dev"
@@ -65,6 +54,7 @@ Requires-Dist: langchain-huggingface; extra == "redis"
 Requires-Dist: sentence-transformers; extra == "redis"
 Provides-Extra: mongodb
 Requires-Dist: pymongo<4.12,>=4.11; extra == "mongodb"
+Dynamic: license-file
 
 ![ChatterBot: Machine learning in Python](https://i.imgur.com/b3SCmGT.png)
 
@@ -167,7 +157,7 @@ See release notes for changes https://github.com/gunthercox/ChatterBot/releases
    a new branch `my-pull-request`.
 3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/).
 4. Please follow the [Python style guide for PEP-8](https://www.python.org/dev/peps/pep-0008/).
-5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing.html).
+5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing/).
    to help make sure that your contribution is free from errors.
 
 # License

{chatterbot-1.2.3 → chatterbot-1.2.4}/README.md

@@ -99,7 +99,7 @@ See release notes for changes https://github.com/gunthercox/ChatterBot/releases
    a new branch `my-pull-request`.
 3. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/).
 4. Please follow the [Python style guide for PEP-8](https://www.python.org/dev/peps/pep-0008/).
-5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing.html).
+5. Use the projects [built-in automated testing](https://docs.chatterbot.us/testing/).
    to help make sure that your contribution is free from errors.
 
 # License

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/__init__.py

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

chatterbot-1.2.4/chatterbot/__main__.py

@@ -0,0 +1,27 @@
+"""
+Example usage for ChatterBot command line arguments:
+
+python -m chatterbot --help
+"""
+
+import sys
+
+
+def get_chatterbot_version():
+    """
+    Return the version of the current package.
+    """
+    from chatterbot import __version__
+
+    return __version__
+
+
+if __name__ == '__main__':
+    if '--version' in sys.argv:
+        print(get_chatterbot_version())
+    elif '--help' in sys.argv:
+        print('usage: chatterbot [--version, --help]')
+        print('  --version: Print the version of ChatterBot')
+        print('  --help: Print this help message')
+        print()
+        print('Documentation at https://docs.chatterbot.us')

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/chatterbot.py

@@ -11,11 +11,41 @@ import spacy
 class ChatBot(object):
     """
     A conversational dialog chat bot.
+
+    :param name: A name is the only required parameter for the ChatBot class.
+    :type name: str
+
+    :keyword storage_adapter: The dot-notated import path to a storage adapter class.
+                              Defaults to ``"chatterbot.storage.SQLStorageAdapter"``.
+    :type storage_adapter: str
+
+    :param logic_adapters: A list of dot-notated import paths to each logic adapter the bot uses.
+                           Defaults to ``["chatterbot.logic.BestMatch"]``.
+    :type logic_adapters: list
+
+    :param tagger: The tagger to use for the chat bot.
+                   Defaults to :class:`~chatterbot.tagging.PosLemmaTagger`
+    :type tagger: object
+
+    :param tagger_language: The language to use for the tagger.
+                            Defaults to :class:`~chatterbot.languages.ENG`.
+    :type tagger_language: object
+
+    :param preprocessors: A list of preprocessor functions to use for the chat bot.
+    :type preprocessors: list
+
+    :param read_only: If True, the chat bot will not save any input it receives, defaults to False.
+    :type read_only: bool
+
+    :param logger: A ``Logger`` object.
+    :type logger: logging.Logger
     """
 
     def __init__(self, name, **kwargs):
         self.name = name
 
+        self.logger = kwargs.get('logger', logging.getLogger(__name__))
+
         storage_adapter = kwargs.get('storage_adapter', 'chatterbot.storage.SQLStorageAdapter')
 
         logic_adapters = kwargs.get('logic_adapters', [
@@ -30,11 +60,29 @@ class ChatBot(object):
 
         self.storage = utils.initialize_class(storage_adapter, **kwargs)
 
-        Tagger = kwargs.get('tagger', PosLemmaTagger)
+        tagger_language = kwargs.get('tagger_language', languages.ENG)
 
-        self.tagger = Tagger(language=kwargs.get(
-            'tagger_language', languages.ENG
-        ))
+        try:
+            Tagger = kwargs.get('tagger', PosLemmaTagger)
+
+            self.tagger = Tagger(language=tagger_language)
+        except IOError as io_error:
+            # Return a more helpful error message if possible
+            if "Can't find model" in str(io_error):
+                model_name = utils.get_model_for_language(tagger_language)
+                if hasattr(tagger_language, 'ENGLISH_NAME'):
+                    language_name = tagger_language.ENGLISH_NAME
+                else:
+                    language_name = tagger_language
+                raise self.ChatBotException(
+                    'Setup error:\n'
+                    f'The Spacy model for "{language_name}" language is missing.\n'
+                    'Please install the model using the command:\n\n'
+                    f'python -m spacy download {model_name}\n\n'
+                    'See https://spacy.io/usage/models for more information about available models.'
+                ) from io_error
+            else:
+                raise io_error
 
         primary_search_algorithm = IndexedTextSearch(self, **kwargs)
         text_search_algorithm = TextSearch(self, **kwargs)
@@ -63,8 +111,6 @@ class ChatBot(object):
         # NOTE: 'xx' is the language code for a multi-language model
         self.nlp = spacy.blank(self.tagger.language.ISO_639_1)
 
-        self.logger = kwargs.get('logger', logging.getLogger(__name__))
-
         # Allow the bot to save input it receives so that it can learn
         self.read_only = kwargs.get('read_only', False)
 

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/comparisons.py

@@ -2,7 +2,7 @@
 This module contains various text-comparison algorithms
 designed to compare one statement to another.
 """
-from chatterbot import constants
+from chatterbot.utils import get_model_for_language
 from difflib import SequenceMatcher
 import spacy
 
@@ -100,12 +100,7 @@ class SpacySimilarity(Comparator):
     def __init__(self, language):
         super().__init__(language)
 
-        try:
-            model = constants.DEFAULT_LANGUAGE_TO_SPACY_MODEL_MAP[self.language]
-        except KeyError as e:
-            raise KeyError(
-                f'Spacy model is not available for language {self.language}'
-            ) from e
+        model = get_model_for_language(language)
 
         # Disable the Named Entity Recognition (NER) component because it is not necessary
         self.nlp = spacy.load(model, exclude=['ner'])
@@ -157,12 +152,7 @@ class JaccardSimilarity(Comparator):
     def __init__(self, language):
         super().__init__(language)
 
-        try:
-            model = constants.DEFAULT_LANGUAGE_TO_SPACY_MODEL_MAP[self.language]
-        except KeyError as e:
-            raise KeyError(
-                f'Spacy model is not available for language {self.language}'
-            ) from e
+        model = get_model_for_language(language)
 
         # Disable the Named Entity Recognition (NER) component because it is not necessary
         self.nlp = spacy.load(model, exclude=['ner'])

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/ext/sqlalchemy_app/models.py

@@ -1,7 +1,7 @@
 from sqlalchemy import Table, Column, Integer, String, DateTime, ForeignKey
-from sqlalchemy.orm import relationship
+from sqlalchemy.orm import relationship, declarative_base
 from sqlalchemy.sql import func
-from sqlalchemy.ext.declarative import declared_attr, declarative_base
+from sqlalchemy.ext.declarative import declared_attr
 
 from chatterbot.conversation import StatementMixin
 from chatterbot import constants

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/logic/specific_response.py

@@ -1,6 +1,7 @@
 from chatterbot.logic import LogicAdapter
 from chatterbot.conversation import Statement
-from chatterbot import constants, languages
+from chatterbot import languages
+from chatterbot.utils import get_model_for_language
 import spacy
 
 
@@ -35,12 +36,7 @@ class SpecificResponseAdapter(LogicAdapter):
         self._output_text = kwargs.get('output_text')
 
     def _initialize_nlp(self, language):
-        try:
-            model = constants.DEFAULT_LANGUAGE_TO_SPACY_MODEL_MAP[language]
-        except KeyError as e:
-            raise KeyError(
-                f'Spacy model is not available for language {language}'
-            ) from e
+        model = get_model_for_language(language)
 
         return spacy.load(model)
 

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/logic/time_adapter.py

@@ -1,7 +1,8 @@
 from datetime import datetime
-from chatterbot import constants, languages
+from chatterbot import languages
 from chatterbot.logic import LogicAdapter
 from chatterbot.conversation import Statement
+from chatterbot.utils import get_model_for_language
 import spacy
 
 
@@ -36,12 +37,7 @@ class TimeLogicAdapter(LogicAdapter):
 
         language = kwargs.get('language', languages.ENG)
 
-        try:
-            model = constants.DEFAULT_LANGUAGE_TO_SPACY_MODEL_MAP[language]
-        except KeyError as e:
-            raise KeyError(
-                f'Spacy model is not available for language {language}'
-            ) from e
+        model = get_model_for_language(language)
 
         self.nlp = spacy.load(model)
 

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/search.py

@@ -149,58 +149,3 @@ class TextSearch:
                 ))
 
                 yield statement
-
-
-class VectorSearch:
-    """
-    .. note:: BETA feature: this search method is new and experimental.
-
-    Search for similar text based on a :term:`vector database`.
-    """
-
-    name = 'vector_search'
-
-    def __init__(self, chatbot, **kwargs):
-        from chatterbot.storage import RedisVectorStorageAdapter
-
-        # Good documentation:
-        # https://python.langchain.com/docs/integrations/vectorstores/redis/
-        #
-        # https://hub.docker.com/r/redis/redis-stack
-
-        # Mondodb:
-        # > Vector Search is only supported on Atlas Clusters
-        # https://www.mongodb.com/community/forums/t/can-a-local-mongodb-instance-be-used-when-working-with-langchain-mongodbatlasvectorsearch/265356
-
-        # FAISS:
-        # https://python.langchain.com/docs/integrations/vectorstores/faiss/
-
-        print("Starting Redis Vector Store")
-
-        # TODO: look into:
-        # https://python.langchain.com/api_reference/redis/chat_message_history/langchain_redis.chat_message_history.RedisChatMessageHistory.html
-
-        # The VectorSearch class is only compatible with the RedisVectorStorageAdapter
-        if not isinstance(chatbot.storage, RedisVectorStorageAdapter):
-            raise Exception(
-                'The VectorSearch search method requires the RedisVectorStorageAdapter storage adapter.'
-            )
-
-    def search(self, input_statement, **additional_parameters):
-        print("Querying Vector Store")
-
-        # Similarity search with score and filter
-        # NOTE: It looks like `return_all` is needed to return the full document
-        # specifically what we need here is the ID
-        scored_results = self.storage.vector_store.similarity_search_with_score(
-            input_statement.text, k=2, return_all=True
-        )
-        # sort_by="score", filter={"category": "likes"})
-
-        print("Similarity Search with Score Results:\n")
-        for doc, score in scored_results:
-            print(f"Content: {doc.page_content[:150]}...")
-            print(f"ID: {doc.id}")
-            print(f"Metadata: {doc.metadata}")
-            print(f"Score: {score}")
-            print()

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/storage/sql_storage.py

@@ -326,7 +326,7 @@ class SQLStorageAdapter(StorageAdapter):
         record = None
 
         if hasattr(statement, 'id') and statement.id is not None:
-            record = session.query(Statement).get(statement.id)
+            record = session.get(Statement, statement.id)
         else:
             record = session.query(Statement).filter(
                 Statement.text == statement.text,

{chatterbot-1.2.3 → chatterbot-1.2.4}/chatterbot/tagging.py

@@ -1,4 +1,5 @@
-from chatterbot import languages, constants
+from chatterbot import languages
+from chatterbot.utils import get_model_for_language
 import spacy
 
 
@@ -42,12 +43,7 @@ class PosLemmaTagger(object):
 
         self.language = language or languages.ENG
 
-        try:
-            model = constants.DEFAULT_LANGUAGE_TO_SPACY_MODEL_MAP[self.language]
-        except KeyError as e:
-            raise KeyError(
-                f'Spacy model is not available for language {self.language}'
-            ) from e
+        model = get_model_for_language(self.language)
 
         # Disable the Named Entity Recognition (NER) component because it is not necessary
         self.nlp = spacy.load(model, exclude=['ner'])