Make neo4j.conf and neo4j.routing internal

Author: robsdedude

neo4j/__conf.py

@@ -71,11 +71,6 @@
 
 from logging import getLogger
 
-from .__conf import (
-    TrustAll,
-    TrustCustomCAs,
-    TrustSystemCAs,
-)
 from ._async.driver import (
     AsyncBoltDriver,
     AsyncDriver,
@@ -88,6 +83,15 @@
     AsyncSession,
     AsyncTransaction,
 )
+from ._conf import (
+    Config,
+    PoolConfig,
+    SessionConfig,
+    TrustAll,
+    TrustCustomCAs,
+    TrustSystemCAs,
+    WorkspaceConfig,
+)
 from ._data import Record
 from ._meta import (
     ExperimentalWarning,
@@ -131,12 +135,6 @@
     Version,
     WRITE_ACCESS,
 )
-from .conf import (
-    Config,
-    PoolConfig,
-    SessionConfig,
-    WorkspaceConfig,
-)
 from .work import (
     Query,
     ResultSummary,

neo4j/__init__.py

@@ -16,11 +16,15 @@
 # limitations under the License.
 
 
-from ..__conf import (
+from .._async_compat.util import AsyncUtil
+from .._conf import (
+    Config,
+    PoolConfig,
+    SessionConfig,
     TrustAll,
     TrustStore,
+    WorkspaceConfig,
 )
-from .._async_compat.util import AsyncUtil
 from .._meta import (
     deprecation_warn,
     experimental,
@@ -32,12 +36,6 @@
     TRUST_ALL_CERTIFICATES,
     TRUST_SYSTEM_CA_SIGNED_CERTIFICATES,
 )
-from ..conf import (
-    Config,
-    PoolConfig,
-    SessionConfig,
-    WorkspaceConfig,
-)
 
 
 class AsyncGraphDatabase:

neo4j/_async/driver.py

@@ -26,6 +26,7 @@
 from ..._async_compat.util import AsyncUtil
 from ..._codec.hydration import v1 as hydration_v1
 from ..._codec.packstream import v1 as packstream_v1
+from ..._conf import PoolConfig
 from ..._exceptions import (
     BoltError,
     BoltHandshakeError,
@@ -37,7 +38,6 @@
     ServerInfo,
     Version,
 )
-from ...conf import PoolConfig
 from ...exceptions import (
     AuthError,
     DriverError,

neo4j/_async/io/_bolt.py

@@ -31,21 +31,22 @@
     AsyncRLock,
 )
 from ..._async_compat.network import AsyncNetworkUtil
+from ..._conf import (
+    PoolConfig,
+    WorkspaceConfig,
+)
 from ..._deadline import (
     connection_deadline,
     Deadline,
     merge_deadlines,
     merge_deadlines_and_timeouts,
 )
 from ..._exceptions import BoltError
+from ..._routing import RoutingTable
 from ...api import (
     READ_ACCESS,
     WRITE_ACCESS,
 )
-from ...conf import (
-    PoolConfig,
-    WorkspaceConfig,
-)
 from ...exceptions import (
     ClientError,
     ConfigurationError,
@@ -56,7 +57,6 @@
     SessionExpired,
     WriteServiceUnavailable,
 )
-from ...routing import RoutingTable
 from ._bolt import AsyncBolt
 
 

neo4j/_async/io/_pool.py

@@ -21,6 +21,7 @@
 from time import perf_counter
 
 from ..._async_compat import async_sleep
+from ..._conf import SessionConfig
 from ..._meta import (
     deprecated,
     deprecation_warn,
@@ -30,7 +31,6 @@
     READ_ACCESS,
     WRITE_ACCESS,
 )
-from ...conf import SessionConfig
 from ...exceptions import (
     ClientError,
     DriverError,

neo4j/_async/work/session.py

@@ -18,12 +18,12 @@
 
 import asyncio
 
+from ..._conf import WorkspaceConfig
 from ..._deadline import Deadline
 from ..._meta import (
     deprecation_warn,
     unclosed_resource_warn,
 )
-from ...conf import WorkspaceConfig
 from ...exceptions import (
     ServiceUnavailable,
     SessionExpired,

neo4j/_async/work/workspace.py

@@ -19,11 +19,6 @@
 from abc import ABCMeta
 from collections.abc import Mapping
 
-from .__conf import (
-    TrustAll,
-    TrustCustomCAs,
-    TrustSystemCAs,
-)
 from ._meta import (
     deprecation_warn,
     get_user_agent,
@@ -52,6 +47,76 @@ def iter_items(iterable):
             yield key, value
 
 
+class TrustStore:
+    # Base class for trust stores. For internal type-checking only.
+    pass
+
+
+class TrustSystemCAs(TrustStore):
+    """Used to configure the driver to trust system CAs (default).
+
+    Trust server certificates that can be verified against the system
+    certificate authority. This option is primarily intended for use with
+    full certificates.
+
+    For example::
+
+        import neo4j
+
+        driver = neo4j.GraphDatabase.driver(
+            url, auth=auth, trusted_certificates=neo4j.TrustSystemCAs()
+        )
+    """
+    pass
+
+
+class TrustAll(TrustStore):
+    """Used to configure the driver to trust all certificates.
+
+    Trust any server certificate. This ensures that communication
+    is encrypted but does not verify the server certificate against a
+    certificate authority. This option is primarily intended for use with
+    the default auto-generated server certificate.
+
+
+    For example::
+
+        import neo4j
+
+        driver = neo4j.GraphDatabase.driver(
+            url, auth=auth, trusted_certificates=neo4j.TrustAll()
+        )
+    """
+    pass
+
+
+class TrustCustomCAs(TrustStore):
+    """Used to configure the driver to trust custom CAs.
+
+    Trust server certificates that can be verified against the certificate
+    authority at the specified paths. This option is primarily intended for
+    self-signed and custom certificates.
+
+    :param certificates (str): paths to the certificates to trust.
+        Those are not the certificates you expect to see from the server but
+        the CA certificates you expect to be used to sign the server's
+        certificate.
+
+    For example::
+
+        import neo4j
+
+        driver = neo4j.GraphDatabase.driver(
+            url, auth=auth,
+            trusted_certificates=neo4j.TrustCustomCAs(
+                "/path/to/ca1.crt", "/path/to/ca2.crt",
+            )
+        )
+    """
+    def __init__(self, *certificates):
+        self.certs = certificates
+
+
 class DeprecatedAlias:
     """Used when a config option has been renamed."""
 

neo4j/conf.py renamed to neo4j/_conf.py

@@ -28,7 +28,7 @@
 from functools import reduce
 from operator import xor as xor_operator
 
-from .conf import iter_items
+from ._conf import iter_items
 from .graph import (
     Node,
     Path,

neo4j/_data.py

@@ -146,7 +146,7 @@ def should_be_purged_from_memory(self):
         :return: Returns true if it is old and not used for a while.
         :rtype: bool
         """
-        from neo4j.conf import RoutingConfig
+        from neo4j._conf import RoutingConfig
         perf_time = perf_counter()
         log.debug("[#0000]  C: <ROUTING AGED> last_updated_time=%r perf_time=%r", self.last_updated_time, perf_time)
         return self.last_updated_time + self.ttl + RoutingConfig.routing_table_purge_delay <= perf_time