Merge branch '5.0' into bolt-handshake-v2

Author: robsdedude

.gitattributes

@@ -1,5 +1,5 @@
 # configure github not to display generated files
 /src/neo4j/_sync/** linguist-generated=true
-/tests/unit/sync_/** linguist-generated=true
-/tests/integration/sync_/** linguist-generated=true
+/tests/unit/sync/** linguist-generated=true
+/tests/integration/sync/** linguist-generated=true
 /testkitbackend/_sync/** linguist-generated=true

.pre-commit-config.yaml

@@ -19,10 +19,13 @@ repos:
           - batch
       - id: trailing-whitespace
         args: [ --markdown-linebreak-ext=md ]
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: local
     hooks:
       - id: isort
+        name: isort
+        entry: isort
+        types_or: [ python, pyi ]
+        language: system
   - repo: https://github.com/sphinx-contrib/sphinx-lint
     rev: e83a1a42a73284d301c05baaffc176042ffbcf82
     hooks:
@@ -45,7 +48,7 @@ repos:
         name: mypy static type check
         entry: mypy
         args: [ --show-error-codes, src, tests, testkitbackend, benchkit ]
-        'types_or': [ python, pyi ]
+        types_or: [ python, pyi ]
         language: system
         pass_filenames: false
         require_serial: true

CHANGELOG.md

@@ -3,7 +3,8 @@
 See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
 
 ## NEXT RELEASE
-- No breaking or major changes.
+- Since the types of `Relationship`s are tied to the `Graph` object they belong to, fixing `pickle` support for graph types means that `Relationship`s with the same name will have a different type after `deepcopy`ing or pickling and unpickling them or their graph.
+  For more details, see https://github.com/neo4j/neo4j-python-driver/pull/1133
 
 
 ## Version 5.27

benchkit/app.py

@@ -16,6 +16,7 @@
 
 from __future__ import annotations
 
+import sys
 import typing as t
 from contextlib import contextmanager
 from multiprocessing import Semaphore
@@ -43,7 +44,10 @@
     from .workloads import Workload
 
 
-T_App: te.TypeAlias = "Sanic[Config, BenchKitContext]"
+if sys.version_info < (3, 8):
+    T_App: te.TypeAlias = "Sanic"
+else:
+    T_App: te.TypeAlias = "Sanic[Config, BenchKitContext]"
 
 
 def create_app() -> T_App:

benchkit/workloads.py

@@ -543,7 +543,7 @@ def parse(cls, query: t.Any) -> te.Self:
 @dataclass
 class _WorkloadConfig:
     database: str | None
-    routing: t.Literal["r", "w"]
+    routing: te.Literal["r", "w"]
 
     @classmethod
     def parse(cls, data: t.Any) -> te.Self:
@@ -553,7 +553,7 @@ def parse(cls, data: t.Any) -> te.Self:
             if not isinstance(database, str):
                 raise TypeError("Workload database must be a string")
 
-        routing: t.Literal["r", "w"] = "w"
+        routing: te.Literal["r", "w"] = "w"
         if "routing" in data:
             raw_routing = data["routing"]
             if not isinstance(routing, str):

bin/dist-functions

@@ -121,6 +121,6 @@ function setup
 {
     ARGS="$*"
     rm -rf ${DIST} 2> /dev/null
-    set_metadata_and_setup "neo4j-driver" "True" ${ARGS} --sdist  # Legacy package; can be removed in 2.0
+    set_metadata_and_setup "neo4j-driver" "True" ${ARGS}  # Legacy package; can be removed in 2.0
     set_metadata_and_setup "neo4j" "False" ${ARGS}
 }

docs/source/api.rst

@@ -260,7 +260,8 @@ Closing a driver will immediately shut down all connections in the pool.
         :param database\_:
             Database to execute the query against.
 
-            None (default) uses the database configured on the server side.
+            :data:`None` (default) uses the database configured on the server
+            side.
 
             .. Note::
                 It is recommended to always specify the database explicitly
@@ -1034,7 +1035,7 @@ Specifically, the following applies:
   all queries within that session are executed with the explicit database
   name 'movies' supplied. Any change to the user’s home database is
   reflected only in sessions created after such change takes effect. This
-  behavior requires additional network communication. In clustered
+  behavior may require additional network communication. In clustered
   environments, it is strongly recommended to avoid a single point of
   failure. For instance, by ensuring that the connection URI resolves to
   multiple endpoints. For older Bolt protocol versions the behavior is the

docs/source/async_api.rst

@@ -247,7 +247,8 @@ Closing a driver will immediately shut down all connections in the pool.
         :param database\_:
             Database to execute the query against.
 
-            None (default) uses the database configured on the server side.
+            :data:`None` (default) uses the database configured on the server
+            side.
 
             .. Note::
                 It is recommended to always specify the database explicitly

pyproject.toml

@@ -122,7 +122,7 @@ use_parentheses = true
 
 [tool.pytest.ini_options]
 mock_use_standalone_module = true
-asyncio_mode = "auto"
+asyncio_mode = "strict"
 
 
 [tool.mypy]

requirements-dev.txt

@@ -2,32 +2,31 @@
 -e .[pandas,numpy,pyarrow]
 
 # needed for packaging
-build
+build>=1.1.1  # TODO: 6.0 - bump when support for Python 3.7 is dropped
 
 # auto-generate sync driver from async code
-unasync>=0.5.0
+unasync==0.5.0
 # pre-commit hooks and tools
-pre-commit>=2.15.0
-isort>=5.10.0
-mypy>=0.971
-typing-extensions>=4.3.0
-types-pytz>=2022.1.2
-ruff>=0.6.4
+pre-commit>=2.21.0  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+isort>=5.11.5  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+mypy>=1.4.1  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+typing-extensions>=4.7.1
+types-pytz>=2023.3.1.1  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+ruff>=0.8.2
 
 # needed for running tests
-coverage[toml]>=5.5
+coverage[toml]>=7.2.7  # TODO: 6.0 - bump when support for Python 3.7 is dropped
 freezegun>=1.5.1
-mock>=4.0.3
-pytest>=6.2.5
-pytest-asyncio>=0.16.0
-pytest-benchmark>=3.4.1
-pytest-cov>=3.0.0
-pytest-mock>=3.6.1
-tox>=4.0.0
-teamcity-messages>=1.32
+mock>=5.1.0
+pytest>=7.4.4  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+pytest-asyncio~=0.21.2  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+pytest-benchmark>=4.0.0
+pytest-cov>=4.1.0  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+pytest-mock>=3.11.1  # TODO: 6.0 - bump when support for Python 3.7 is dropped
+tox>=4.8.0  # TODO: 6.0 - bump when support for Python 3.7 is dropped
 
 # needed for building docs
-sphinx
+Sphinx>=5.3.0  # TODO: 6.0 - bump when support for Python 3.7 is dropped
 
 # needed for BenchKit
-sanic>=23.12.1 ; python_version >= '3.8.0'
+sanic>=23.3.0  # TODO: 6.0 - bump when support for Python 3.7 is dropped

setup.py

@@ -20,7 +20,6 @@
 
 import pathlib
 import sys
-import warnings
 from contextlib import contextmanager
 
 import tomlkit
@@ -37,13 +36,6 @@
 )
 
 
-if deprecated:
-    warnings.warn(
-        f"`{package}` is deprecated, please install `neo4j` instead.",
-        DeprecationWarning,
-        stacklevel=0,
-    )
-
 readme_path = THIS_DIR / "README.rst"
 readme = readme_path.read_text(encoding="utf-8")
 

src/neo4j/_async/driver.py

@@ -799,7 +799,8 @@ async def example(driver: neo4j.AsyncDriver) -> int:
         :param database_:
             Database to execute the query against.
 
-            None (default) uses the database configured on the server side.
+            :data:`None` (default) uses the database configured on the server
+            side.
 
             .. Note::
                 It is recommended to always specify the database explicitly

src/neo4j/_async/home_db_cache.py

@@ -0,0 +1,150 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# This file is part of Neo4j.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+from __future__ import annotations
+
+import math
+import typing as t
+from time import monotonic
+
+from .._async_compat.concurrency import AsyncCooperativeLock
+
+
+if t.TYPE_CHECKING:
+    import typing_extensions as te
+
+    TKey: te.TypeAlias = t.Union[
+        str,
+        t.Tuple[t.Tuple[str, t.Hashable], ...],
+        t.Tuple[None],
+    ]
+    TVal: te.TypeAlias = t.Tuple[float, str]
+
+
+class AsyncHomeDbCache:
+    _ttl: float
+    _enabled: bool
+    _max_size: int | None
+
+    def __init__(
+        self,
+        enabled: bool = True,
+        ttl: float = float("inf"),
+        max_size: int | None = None,
+    ) -> None:
+        if math.isnan(ttl) or ttl <= 0:
+            raise ValueError(f"home db cache ttl must be greater 0, got {ttl}")
+        self._enabled = enabled
+        self._ttl = ttl
+        self._cache: dict[TKey, TVal] = {}
+        self._lock = AsyncCooperativeLock()
+        self._oldest_entry = monotonic()
+        if max_size is not None and max_size <= 0:
+            raise ValueError(
+                f"home db cache max_size must be greater 0 or None, "
+                f"got {max_size}"
+            )
+        self._max_size = max_size
+        self._truncate_size = (
+            min(max_size, int(0.01 * max_size * math.log(max_size)))
+            if max_size is not None
+            else None
+        )
+
+    def compute_key(
+        self,
+        imp_user: str | None,
+        auth: dict | None,
+    ) -> TKey:
+        if not self._enabled:
+            return (None,)
+        if imp_user is not None:
+            return imp_user
+        if auth is not None:
+            return _consolidate_auth_token(auth)
+        return (None,)
+
+    def get(self, key: TKey) -> str | None:
+        if not self._enabled:
+            return None
+        with self._lock:
+            self._clean(monotonic())
+            val = self._cache.get(key)
+            if val is None:
+                return None
+            return val[1]
+
+    def set(self, key: TKey, value: str | None) -> None:
+        if not self._enabled:
+            return
+        with self._lock:
+            now = monotonic()
+            self._clean(now)
+            if value is None:
+                self._cache.pop(key, None)
+            else:
+                self._cache[key] = (now, value)
+
+    def clear(self) -> None:
+        if not self._enabled:
+            return
+        with self._lock:
+            self._cache = {}
+            self._oldest_entry = monotonic()
+
+    def _clean(self, now: float | None = None) -> None:
+        now = monotonic() if now is None else now
+        if now - self._oldest_entry > self._ttl:
+            self._cache = {
+                k: v
+                for k, v in self._cache.items()
+                if now - v[0] < self._ttl * 0.9
+            }
+            self._oldest_entry = min(
+                (v[0] for v in self._cache.values()), default=now
+            )
+        if self._max_size and len(self._cache) > self._max_size:
+            self._cache = dict(
+                sorted(
+                    self._cache.items(),
+                    key=lambda item: item[1][0],
+                    reverse=True,
+                )[: self._truncate_size]
+            )
+
+    def __len__(self) -> int:
+        return len(self._cache)
+
+    @property
+    def enabled(self) -> bool:
+        return self._enabled
+
+
+def _consolidate_auth_token(auth: dict) -> tuple | str:
+    if auth.get("scheme") == "basic" and isinstance(
+        auth.get("principal"), str
+    ):
+        return auth["principal"]
+    return _hashable_dict(auth)
+
+
+def _hashable_dict(d: dict) -> tuple:
+    return tuple(
+        (k, _hashable_dict(v) if isinstance(v, dict) else v)
+        for k, v in sorted(d.items())
+    )

src/neo4j/_async/io/__init__.py

@@ -22,7 +22,8 @@
 """
 
 __all__ = [
-    "AcquireAuth",
+    "AcquisitionAuth",
+    "AcquisitionDatabase",
     "AsyncBolt",
     "AsyncBoltPool",
     "AsyncNeo4jPool",
@@ -43,7 +44,8 @@
     ConnectionErrorHandler,
 )
 from ._pool import (
-    AcquireAuth,
+    AcquisitionAuth,
+    AcquisitionDatabase,
     AsyncBoltPool,
     AsyncNeo4jPool,
 )