Reordering of attributes

Author: technige

neo4j/v1/bolt.py

@@ -19,6 +19,13 @@
 # limitations under the License.
 
 
+"""
+This module contains the low-level functionality required for speaking
+Bolt. It is not intended to be used directly by driver users. Instead,
+the `session` module provides the main user-facing abstractions.
+"""
+
+
 from __future__ import division
 
 from base64 import b64encode
@@ -31,8 +38,7 @@
 from socket import create_connection, SHUT_RDWR, error as SocketError
 from struct import pack as struct_pack, unpack as struct_unpack, unpack_from as struct_unpack_from
 
-from .constants import DEFAULT_PORT, DEFAULT_USER_AGENT, KNOWN_HOSTS, MAGIC_PREAMBLE, \
-    TRUST_DEFAULT, TRUST_ON_FIRST_USE
+from .constants import DEFAULT_USER_AGENT, KNOWN_HOSTS, MAGIC_PREAMBLE, TRUST_DEFAULT, TRUST_ON_FIRST_USE
 from .compat import hex2
 from .exceptions import ProtocolError
 from .packstream import Packer, Unpacker

neo4j/v1/session.py

@@ -19,10 +19,9 @@
 # limitations under the License.
 
 """
-This module contains the main Bolt driver components as well as several
-helper and exception classes. The main entry point is the `GraphDatabase`
-class which can be used to obtain `Driver` instances that are used for
-managing sessions.
+This module contains the main user-facing abstractions. The main entry
+point is the `GraphDatabase` class which can be used to obtain `Driver`
+instances that are in turn used for managing sessions.
 """
 
 
@@ -42,16 +41,6 @@ class which can be used to obtain `Driver` instances that are used for
 DEFAULT_MAX_POOL_SIZE = 50
 
 
-def basic_auth(user, password):
-    """ Generate a basic auth token for a given user and password.
-
-    :param user: user name
-    :param password: current password
-    :return: auth token for use with :meth:`GraphDatabase.driver`
-    """
-    return AuthToken("basic", user, password)
-
-
 class AuthToken(object):
     """ Container for auth information
     """
@@ -80,18 +69,6 @@ def driver(url, **config):
         return Driver(url, **config)
 
 
-_warned_about_insecure_default = False
-
-
-def _warn_about_insecure_default():
-    global _warned_about_insecure_default
-    if not SSL_AVAILABLE and not _warned_about_insecure_default:
-        from warnings import warn
-        warn("Bolt over TLS is only available in Python 2.7.9+ and Python 3.3+ "
-             "so communications are not secure")
-        _warned_about_insecure_default = True
-
-
 class Driver(object):
     """ Accessor for a specific graph database resource.
     """
@@ -286,41 +263,6 @@ def peek(self):
         raise ResultError("End of stream")
 
 
-def run(connection, statement, parameters=None):
-    """ Run a Cypher statement on a given connection.
-
-    :param connection: connection to carry the request and response
-    :param statement: Cypher statement
-    :param parameters: optional dictionary of parameters
-    :return: statement result
-    """
-    # Ensure the statement is a Unicode value
-    if isinstance(statement, bytes):
-        statement = statement.decode("UTF-8")
-
-    params = {}
-    for key, value in (parameters or {}).items():
-        if isinstance(key, bytes):
-            key = key.decode("UTF-8")
-        if isinstance(value, bytes):
-            params[key] = value.decode("UTF-8")
-        else:
-            params[key] = value
-    parameters = params
-
-    run_response = Response(connection)
-    pull_all_response = Response(connection)
-    result = StatementResult(connection, run_response, pull_all_response)
-    result.statement = statement
-    result.parameters = parameters
-
-    connection.append(RUN, (statement, parameters), response=run_response)
-    connection.append(PULL_ALL, response=pull_all_response)
-    connection.send()
-
-    return result
-
-
 class Session(object):
     """ Logical session carried out over an established TCP connection.
     Sessions should generally be constructed using the :meth:`.Driver.session`
@@ -529,3 +471,60 @@ def __eq__(self, other):
 
     def __ne__(self, other):
         return not self.__eq__(other)
+
+
+def basic_auth(user, password):
+    """ Generate a basic auth token for a given user and password.
+
+    :param user: user name
+    :param password: current password
+    :return: auth token for use with :meth:`GraphDatabase.driver`
+    """
+    return AuthToken("basic", user, password)
+
+
+def run(connection, statement, parameters=None):
+    """ Run a Cypher statement on a given connection.
+
+    :param connection: connection to carry the request and response
+    :param statement: Cypher statement
+    :param parameters: optional dictionary of parameters
+    :return: statement result
+    """
+    # Ensure the statement is a Unicode value
+    if isinstance(statement, bytes):
+        statement = statement.decode("UTF-8")
+
+    params = {}
+    for key, value in (parameters or {}).items():
+        if isinstance(key, bytes):
+            key = key.decode("UTF-8")
+        if isinstance(value, bytes):
+            params[key] = value.decode("UTF-8")
+        else:
+            params[key] = value
+    parameters = params
+
+    run_response = Response(connection)
+    pull_all_response = Response(connection)
+    result = StatementResult(connection, run_response, pull_all_response)
+    result.statement = statement
+    result.parameters = parameters
+
+    connection.append(RUN, (statement, parameters), response=run_response)
+    connection.append(PULL_ALL, response=pull_all_response)
+    connection.send()
+
+    return result
+
+
+_warned_about_insecure_default = False
+
+
+def _warn_about_insecure_default():
+    global _warned_about_insecure_default
+    if not SSL_AVAILABLE and not _warned_about_insecure_default:
+        from warnings import warn
+        warn("Bolt over TLS is only available in Python 2.7.9+ and Python 3.3+ "
+             "so communications are not secure")
+        _warned_about_insecure_default = True