Begin storage overhaul

chatterbot/conversation/session.py

@@ -1,5 +1,4 @@
 import uuid
-from chatterbot.queues import ResponseQueue
 
 
 class StatementManager(object):
@@ -25,7 +24,6 @@ def add(self, statement):
         """
         Add a statement to the conversation.
         """
-        statement.conversation_id = self.conversation_id
         self.storage.update(statement)
 
     def count(self):
@@ -60,7 +58,6 @@ def get_last_response_statement(self):
         """
         statements = self.statements.all()
         if statements:
-            # Return the latest output statement (This should be ordering them by date to get the latest)
             return statements[1]
         return None
 

chatterbot/conversation/statement.py

@@ -3,6 +3,26 @@
 from datetime import datetime
 
 
+class StatementSerializer(object):
+
+    def serialize(self, obj):
+        """
+        :returns: A dictionary representation of the statement object.
+        :rtype: dict
+        """
+        data = {}
+
+        data['text'] = obj.text
+        data['in_response_to'] = {'text': obj.in_response_to.text}
+        data['created_at'] = obj.created_at
+        data['extra_data'] = obj.extra_data
+
+        return data
+
+    def deserialize(self, data):
+        pass
+
+
 class Statement(object):
     """
     A statement represents a single spoken entity, sentence or
@@ -11,7 +31,6 @@ class Statement(object):
 
     def __init__(self, text, **kwargs):
         self.text = text
-        self.conversation_id = kwargs.pop('conversation_id', None)
         self.in_response_to = kwargs.pop('in_response_to', [])
 
         # The date and time that this statement was created at
@@ -125,24 +144,8 @@ def get_response_count(self, statement):
         return 0
 
     def serialize(self):
-        """
-        :returns: A dictionary representation of the statement object.
-        :rtype: dict
-        """
-        data = {}
-
-        data['text'] = self.text
-        data['in_response_to'] = []
-        data['created_at'] = self.created_at
-        data['extra_data'] = self.extra_data
-
-        if self.conversation_id:
-            data['conversation_id'] = self.conversation_id
-
-        for response in self.in_response_to:
-            data['in_response_to'].append(response.serialize())
-
-        return data
+        serializer = StatementSerializer()
+        return serializer.serialize(self)
 
     @property
     def response_statement_cache(self):

chatterbot/ext/django_chatterbot/models.py

@@ -9,26 +9,24 @@ class Statement(models.Model):
     """
 
     text = models.CharField(
-        unique=True,
         blank=False,
         null=False,
         max_length=255
     )
 
-    conversation = models.ForeignKey(
-        'Conversation',
-        related_name='statements',
-        blank=True,
-        null=True
-    )
-
     created_at = models.DateTimeField(
         default=timezone.now,
         help_text='The date and time that this statement was created at.'
     )
 
     extra_data = models.CharField(max_length=500)
 
+    response = models.OneToOneField(
+        'Statement',
+        related_name='in_response_to',
+        null=True
+    )
+
     # This is the confidence with which the chat bot believes
     # this is an accurate response. This value is set when the
     # statement is returned by the chat bot.
@@ -47,13 +45,6 @@ def __init__(self, *args, **kwargs):
         # Responses to be saved if the statement is updated with the storage adapter
         self.response_statement_cache = []
 
-    @property
-    def in_response_to(self):
-        """
-        Return the response objects that are for this statement.
-        """
-        return Response.objects.filter(statement=self)
-
     def add_extra_data(self, key, value):
         """
         Add extra data to the extra_data field.
@@ -74,39 +65,6 @@ def add_response(self, statement):
         """
         self.response_statement_cache.append(statement)
 
-    def remove_response(self, response_text):
-        """
-        Removes a response from the statement's response list based
-        on the value of the response text.
-
-        :param response_text: The text of the response to be removed.
-        :type response_text: str
-        """
-        is_deleted = False
-        response = self.in_response.filter(response__text=response_text)
-
-        if response.exists():
-            is_deleted = True
-
-        return is_deleted
-
-    def get_response_count(self, statement):
-        """
-        Find the number of times that the statement has been used
-        as a response to the current statement.
-
-        :param statement: The statement object to get the count for.
-        :type statement: chatterbot.conversation.statement.Statement
-
-        :returns: Return the number of times the statement has been used as a response.
-        :rtype: int
-        """
-        try:
-            response = self.in_response.get(response__text=statement.text)
-            return response.occurrence
-        except Response.DoesNotExist:
-            return 0
-
     def serialize(self):
         """
         :returns: A dictionary representation of the statement object.
@@ -119,56 +77,10 @@ def serialize(self):
             self.extra_data = '{}'
 
         data['text'] = self.text
-        data['in_response_to'] = []
+        data['in_response_to'] = {'text': self.in_response_to.text}
         data['created_at'] = self.created_at
         data['extra_data'] = json.loads(self.extra_data)
 
-        for response in self.in_response.all():
-            data['in_response_to'].append(response.serialize())
-
-        return data
-
-
-class Response(models.Model):
-    """
-    Connection between a response and the statement that triggered it.
-
-    Comparble to a ManyToMany "through" table, but without the M2M indexing/relations.
-    The text and number of times the response has occurred are stored.
-    """
-
-    statement = models.ForeignKey(
-        'Statement',
-        related_name='in_response'
-    )
-
-    response = models.ForeignKey(
-        'Statement',
-        related_name='responses'
-    )
-
-    unique_together = (('statement', 'response'),)
-
-    occurrence = models.PositiveIntegerField(default=1)
-
-    def __str__(self):
-        statement = self.statement.text
-        response = self.response.text
-        return '{} => {}'.format(
-            statement if len(statement) <= 20 else statement[:17] + '...',
-            response if len(response) <= 40 else response[:37] + '...'
-        )
-
-    def serialize(self):
-        """
-        :returns: A dictionary representation of the statement object.
-        :rtype: dict
-        """
-        data = {}
-
-        data['text'] = self.response.text
-        data['occurrence'] = self.occurrence
-
         return data
 
 

chatterbot/storage/jsonfile.py

@@ -29,14 +29,13 @@ def __init__(self, **kwargs):
         database_path = self.kwargs.get('database', 'database.db')
         self.database = Database(database_path)
 
-        self.adapter_supports_queries = False
+        # Create the statements document as an empty list
+        self.database['statements'] = []
 
-    def _keys(self):
-        # The value has to be cast as a list for Python 3 compatibility
-        return list(self.database[0].keys())
+        self.adapter_supports_queries = False
 
     def count(self):
-        return len(self._keys())
+        return len(self.database['statements'].keys())
 
     def find(self, statement_text):
         values = self.database.data(key=statement_text)
@@ -131,14 +130,10 @@ def filter(self, **kwargs):
 
         order_by = kwargs.pop('order_by', None)
 
-        for key in self._keys():
-            values = self.database.data(key=key)
-
-            # Add the text attribute to the values
-            values['text'] = key
+        for statement in self.database['statements']:
 
-            if self._all_kwargs_match_values(kwargs, values):
-                results.append(self.json_to_object(values))
+            if self._all_kwargs_match_values(kwargs, statement):
+                results.append(self.json_to_object(statement))
 
         if order_by:
 
@@ -154,18 +149,16 @@ def update(self, statement):
         """
         Update a statement in the database.
         """
-        data = statement.serialize()
+        statements = self.database['statements']
 
-        # Remove the text key from the data
-        del data['text']
-        self.database.data(key=statement.text, value=data)
+        statements.append(statement.serialize())
 
         # Make sure that an entry for each response exists
-        for response_statement in statement.in_response_to:
-            response = self.find(response_statement.text)
-            if not response:
-                response = self.Statement(response_statement.text)
-                self.update(response)
+        if statement.in_response_to:
+            response = self.Statement(statement.in_response_to.text)
+            statements.append(statement.in_response_to.serialize())
+
+        self.database.data(key='statements', value=statements)
 
         return statement
 
@@ -175,8 +168,8 @@ def get_random(self):
         if self.count() < 1:
             raise self.EmptyDatabaseException()
 
-        statement = choice(self._keys())
-        return self.find(statement)
+        statement = choice(self.database['statements'])
+        return statement
 
     def drop(self):
         """

chatterbot/storage/mongodb.py

@@ -98,9 +98,6 @@ def __init__(self, **kwargs):
         # The mongo collection of statement documents
         self.statements = self.database['statements']
 
-        # Set a requirement for the text attribute to be unique
-        self.statements.create_index('text', unique=True)
-
         self.base_query = Query()
 
     def count(self):

chatterbot/storage/storage_adapter.py

@@ -40,19 +40,6 @@ def generate_base_query(self, chatterbot, session_id):
             for filter_instance in chatterbot.filters:
                 self.base_query = filter_instance.filter_selection(chatterbot, session_id)
 
-    def create_conversation(self):
-        """
-        Returns a new storage-aware conversation instance.
-        """
-        import os
-
-        if 'DJANGO_SETTINGS_MODULE' in os.environ:
-            from chatterbot.ext.django_chatterbot.models import Conversation
-            return Conversation.objects.create()
-        else:
-            from chatterbot.conversation import Conversation
-            return Conversation(self)
-
     def count(self):
         """
         Return the number of entries in the database.