Result.close->discard

Author: technige

docs/source/index.rst

@@ -26,7 +26,7 @@ Session API
 
 .. autofunction:: neo4j.v1.record
 
-.. autoclass:: neo4j.v1.ResultCursor
+.. autoclass:: neo4j.v1.StatementResult
    :members:
 
 .. autoclass:: neo4j.v1.ResultSummary

examples/test_examples.py

@@ -96,16 +96,18 @@ def test_statement(self):
         driver = GraphDatabase.driver("bolt://localhost", auth=auth_token)
         session = driver.session()
         # tag::statement[]
-        session.run("CREATE (person:Person {name: {name}})", {"name": "Arthur"}).close()
+        result = session.run("CREATE (person:Person {name: {name}})", {"name": "Arthur"})
         # end::statement[]
+        result.discard()
         session.close()
 
     def test_statement_without_parameters(self):
         driver = GraphDatabase.driver("bolt://localhost", auth=auth_token)
         session = driver.session()
         # tag::statement-without-parameters[]
-        session.run("CREATE (person:Person {name: 'Arthur'})").close()
+        result = session.run("CREATE (person:Person {name: 'Arthur'})")
         # end::statement-without-parameters[]
+        result.discard()
         session.close()
 
     def test_result_cursor(self):

neo4j/v1/session.py

@@ -148,7 +148,7 @@ def recycle(self, session):
             pool.appendleft(session)
 
 
-class ResultCursor(object):
+class StatementResult(object):
     """ A handler for the result of Cypher statement execution.
     """
 
@@ -163,7 +163,7 @@ class ResultCursor(object):
     summary = None
 
     def __init__(self, connection, run_response, pull_all_response):
-        super(ResultCursor, self).__init__()
+        super(StatementResult, self).__init__()
 
         # The Connection instance behind this cursor.
         self.connection = connection
@@ -205,6 +205,9 @@ def on_failure(metadata):
         pull_all_response.on_success = on_footer
         pull_all_response.on_failure = on_failure
 
+    def __iter__(self):
+        return self
+
     def __next__(self):
         if self._buffer:
             values = self._buffer.popleft()
@@ -216,10 +219,15 @@ def __next__(self):
                 self.connection.fetch()
             return self.__next__()
 
-    def __iter__(self):
-        return self
+    def keys(self):
+        """ Return the keys for the records.
+        """
+        # Fetch messages until we have the header or a failure
+        while self._keys is None and not self._consumed:
+            self.connection.fetch()
+        return self._keys
 
-    def close(self):
+    def discard(self):
         """ Consume the remainder of this result and detach the connection
         from this cursor.
         """
@@ -229,17 +237,9 @@ def close(self):
                 fetch()
             self.connection = None
 
-    def keys(self):
-        """ Return the keys for the records.
-        """
-        # Fetch messages until we have the header or a failure
-        while self._keys is None and not self._consumed:
-            self.connection.fetch()
-        return self._keys
-
 
 class ResultSummary(object):
-    """ A summary of execution returned with a :class:`.ResultCursor` object.
+    """ A summary of execution returned with a :class:`.StatementResult` object.
     """
 
     #: The statement that was executed to produce this result.
@@ -408,7 +408,7 @@ def __init__(self, driver):
         self.driver = driver
         self.connection = connect(driver.host, driver.port, driver.ssl_context, **driver.config)
         self.transaction = None
-        self.last_cursor = None
+        self.last_result = None
 
     def __del__(self):
         try:
@@ -437,7 +437,7 @@ def run(self, statement, parameters=None):
         :param statement: Cypher statement to execute
         :param parameters: dictionary of parameters
         :return: Cypher result
-        :rtype: :class:`.ResultCursor`
+        :rtype: :class:`.StatementResult`
         """
 
         # Ensure the statement is a Unicode value
@@ -456,22 +456,22 @@ def run(self, statement, parameters=None):
 
         run_response = Response(self.connection)
         pull_all_response = Response(self.connection)
-        cursor = ResultCursor(self.connection, run_response, pull_all_response)
+        cursor = StatementResult(self.connection, run_response, pull_all_response)
         cursor.statement = statement
         cursor.parameters = parameters
 
         self.connection.append(RUN, (statement, parameters), response=run_response)
         self.connection.append(PULL_ALL, response=pull_all_response)
         self.connection.send()
 
-        self.last_cursor = cursor
+        self.last_result = cursor
         return cursor
 
     def close(self):
         """ Recycle this session through the driver it came from.
         """
-        if self.last_cursor:
-            self.last_cursor.close()
+        if self.last_result:
+            self.last_result.discard()
         self.driver.recycle(self)
 
     def begin_transaction(self):

test/test_session.py

@@ -156,12 +156,12 @@ def test_can_run_simple_statement_with_params(self):
     def test_fails_on_bad_syntax(self):
         session = GraphDatabase.driver("bolt://localhost", auth=auth_token).session()
         with self.assertRaises(CypherError):
-            session.run("X").close()
+            session.run("X").discard()
 
     def test_fails_on_missing_parameter(self):
         session = GraphDatabase.driver("bolt://localhost", auth=auth_token).session()
         with self.assertRaises(CypherError):
-            session.run("RETURN {x}").close()
+            session.run("RETURN {x}").discard()
 
     def test_can_run_simple_statement_from_bytes_string(self):
         session = GraphDatabase.driver("bolt://localhost", auth=auth_token).session()
@@ -227,7 +227,7 @@ def test_can_return_path(self):
     def test_can_handle_cypher_error(self):
         with GraphDatabase.driver("bolt://localhost", auth=auth_token).session() as session:
             with self.assertRaises(CypherError):
-                session.run("X").close()
+                session.run("X").discard()
 
     def test_keys_are_available_before_and_after_stream(self):
         with GraphDatabase.driver("bolt://localhost", auth=auth_token).session() as session:
@@ -332,7 +332,7 @@ class ResetTestCase(ServerTestCase):
     def test_automatic_reset_after_failure(self):
         with GraphDatabase.driver("bolt://localhost", auth=auth_token).session() as session:
             try:
-                session.run("X").close()
+                session.run("X").discard()
             except CypherError:
                 result = session.run("RETURN 1")
                 record = next(result)
@@ -346,7 +346,7 @@ def test_defunct(self):
             assert not session.connection.defunct
             with patch.object(ChunkChannel, "chunk_reader", side_effect=ProtocolError()):
                 with self.assertRaises(ProtocolError):
-                    session.run("RETURN 1").close()
+                    session.run("RETURN 1").discard()
             assert session.connection.defunct
             assert session.connection.closed