Merge branch '6.x' into mark-imports-private

Author: robsdedude

CHANGELOG.md

@@ -57,17 +57,24 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
     - Remove possibility to override/set `message` and `code` properties.
     - Remove undocumented, internal methods `Neo4jError.hydrate`, `Neo4jError.invalidates_all_connections`,
       and `Neo4jError.is_fatal_during_discovery`.
-    - Remove deprecated method `Neo4jError.is_retriable`.
+    - Remove deprecated method `Neo4jError.is_retriable`.  
       Use `Neo4jError.is_retryable` instead.
     - Change string representation of `Neo4jError` to include GQL error information.
 - Remove deprecated `Record.__getslice__`. This magic method has been removed in Python 3.0.  
   If you were calling it directly, please use `Record.__getitem__(slice(...))` or simply `record[...]` instead.
-- Remove deprecated class `neo4j.Bookmark` in favor of `neo4j.Bookmarks`.
-- Remove deprecated class `session.last_bookmark()` in favor of `last_bookmarks()`.
+- Bookmarks
+  - Remove deprecated class `neo4j.Bookmark` in favor of `neo4j.Bookmarks`.
+  - Remove deprecated class `session.last_bookmark()` in favor of `last_bookmarks()`.
+  - Deprecate passing raw sting bookmarks as `initial_bookmarks` to `GraphDatabase.bookmark_manager()`.  
+    Use a `neo4j.Bookmarks` object instead.
+  - `Driver.session()` no longer accepts raw string bookmarks as `bookmarks` argument.  
+    Use a `neo4j.Bookmarks` object instead.
+- Remove deprecated `ServerInfo.connection_id`.  
+  There is no replacement as this is considered internal information.
 - Remove deprecated driver configuration option `trust`.  
   Use `trusted_certificates` instead.
   - Remove the associated constants `neo4j.TRUST_ALL_CERTIFICATES` and `neo4j.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES`.
-- Remove deprecated `session.read_transaction` and `session.write_transaction`.
+- Remove deprecated `session.read_transaction` and `session.write_transaction`.  
   Instead, use `session.execute_read` and  `session.execute_write` respectively.
 - Make undocumented classes `ResolvedAddress`, `ResolvedIPv4Address`, and `ResolvedIPv6Address` private.
 - Rework `PreviewWarning`.
@@ -92,6 +99,23 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
     - `client_errors`
     - `transient_errors`
     - all other indirectly exposed items from imports (e.g. `typing` as `neo4j.exceptions.t`)
+  - `neo4j.time`
+    - `DATE_ISO_PATTERN`
+    - `TIME_ISO_PATTERN`
+    - `DURATION_ISO_PATTERN`
+    - `NANO_SECONDS`
+    - `AVERAGE_SECONDS_IN_MONTH`
+    - `AVERAGE_SECONDS_IN_DAY`
+    - `FORMAT_F_REPLACE`
+    - `IS_LEAP_YEAR`
+    - `DAYS_IN_YEAR`
+    - `DAYS_IN_MONTH`
+    - `round_half_to_even`
+    - `symmetric_divmod`
+    - `DateTimeType`
+    - `DateType`
+    - `TimeType`
+    - all other indirectly exposed items from imports (e.g. `re` as `neo4j.time.re`)
   - `neo4j.spatial`
     - `hydrate_point`
     - `dehydrate_point`
@@ -107,12 +131,26 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
     - `.default_target`
   - `neo4j.graph`, `neo4j.addressing`, `neo4j.api`
     - indirectly exposed items from imports (e.g. `collections.abc.Mapping` as `neo4j.graph.Mapping`).
+  - `BoltDriver` and `Neo4jDriver`
+    - `.open`
+    - `.parse_target`
+    - `.default_host`
+    - `.default_port`
+    - `.default_target`
+  - `neo4j.debug`
+    - `ColourFormatter`
+    - `TaskIdFilter`
+    - all other indirectly exposed items from imports (e.g. `asyncio` as `neo4j.debug.asyncio`)
+- Deprecate ClockTime and its accessors
+  - For each `neo4j.time.Date`, `neo4j.time.DateTime`, `neo4j.time.Time`
+    - `from_clock_time` and `to_clock_time` methods
+  - `neo4j.time.ClockTime` itself
 - Raise `ConfigurationError` instead of ignoring the routing context (URI query parameters) when creating a direct
   driver ("bolt[+s[sc]]://" scheme).
 - Change behavior of closed drivers:
-    - Raise `DriverError` on using the closed driver.
-    - Calling `driver.close()` again is now a no-op.
-- No longer implicitly closing drivers and sessions in `__del__()` (finalizer/destructor).
+  - Raise `DriverError` on using the closed driver.
+  - Calling `driver.close()` again is now a no-op.
+- No longer implicitly closing drivers and sessions in `__del__()` (finalizer/destructor).  
   Make sure to call `.close()` on them explicitly or use them in a `with` statement.
 - Make `Summary.summary_notifications` a `tuple` instead of a `list` and type it with `Sequence` to signify that it
   should be treated as immutable.
@@ -235,17 +273,17 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
   manager related methods:
   - `neo4j.BookmarkManger` and `neo4j.AsyncBookmarkManger` abstract base
     classes:
-    - ``update_bookmarks`` has no longer a ``database`` argument.
-    - ``get_bookmarks`` has no longer a ``database`` argument.
-    - The ``get_all_bookmarks`` method was removed.
-    - The ``forget`` method was removed.
+    - `update_bookmarks` has no longer a `database` argument.
+    - `get_bookmarks` has no longer a `database` argument.
+    - The `get_all_bookmarks` method was removed.
+    - The `forget` method was removed.
   - `neo4j.GraphDatabase.bookmark_manager` and
     `neo4j.AsyncGraphDatabase.bookmark_manager` factory methods:
-    - ``initial_bookmarks`` is no longer a mapping from database name
+    - `initial_bookmarks` is no longer a mapping from database name
       to bookmarks but plain bookmarks.
-    - ``bookmarks_supplier`` no longer receives the database name as
+    - `bookmarks_supplier` no longer receives the database name as
       an argument.
-    - ``bookmarks_consumer`` no longer receives the database name as
+    - `bookmarks_consumer` no longer receives the database name as
       an argument.  
 
 

benchkit/app.py

@@ -20,7 +20,6 @@
 from contextlib import contextmanager
 from multiprocessing import Semaphore
 
-import typing_extensions as te
 from sanic import Sanic
 from sanic.exceptions import (
     BadRequest,
@@ -43,7 +42,7 @@
     from .workloads import Workload
 
 
-T_App: te.TypeAlias = "Sanic[Config, BenchKitContext]"
+T_App: t.TypeAlias = "Sanic[Config, BenchKitContext]"
 
 
 def create_app() -> T_App:

benchkit/workloads.py

@@ -19,13 +19,16 @@
 import asyncio
 import enum
 import typing as t
+from collections.abc import (
+    Iterable,
+    Iterator,
+    Mapping,
+)
 from dataclasses import dataclass
 
-import typing_extensions as te
-
 
 if t.TYPE_CHECKING:
-    from collections.abc import Iterator
+    import typing_extensions as te
 
     from neo4j import (
         AsyncDriver,
@@ -40,7 +43,7 @@
 ]
 
 
-class Workloads(t.Mapping):
+class Workloads(Mapping):
     def __init__(self) -> None:
         self._workloads: dict[str, Workload] = {}
         self._current_id: int = 0
@@ -517,7 +520,7 @@ class _WorkloadQuery:
 
     @classmethod
     def parse_multiple(cls, queries: t.Any) -> list[te.Self]:
-        if not isinstance(queries, t.Iterable):
+        if not isinstance(queries, Iterable):
             raise TypeError("Workload queries must be a list")
         return [cls.parse(query) for query in queries]
 
@@ -544,7 +547,7 @@ def parse(cls, query: t.Any) -> te.Self:
 @dataclass
 class _WorkloadConfig:
     database: str | None
-    routing: te.Literal["r", "w"]
+    routing: t.Literal["r", "w"]
 
     @classmethod
     def parse(cls, data: t.Any) -> te.Self:
@@ -554,7 +557,7 @@ def parse(cls, data: t.Any) -> te.Self:
             if not isinstance(database, str):
                 raise TypeError("Workload database must be a string")
 
-        routing: te.Literal["r", "w"] = "w"
+        routing: t.Literal["r", "w"] = "w"
         if "routing" in data:
             raw_routing = data["routing"]
             if not isinstance(routing, str):

docs/source/conf.py

@@ -17,7 +17,6 @@
 
 import os
 import sys
-import typing
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -123,17 +122,7 @@
 # Don't include type hints in function signatures
 autodoc_typehints = "description"
 
-autodoc_type_aliases = {
-    # The code-base uses `import typing_extensions as te`.
-    # Re-write these to use `typing` instead, as Sphinx always resolves against
-    # the latest version of the `typing` module.
-    # This is a work-around to make Sphinx resolve type hints correctly, even
-    # though we're using `from __future__ import annotations`.
-    "te": typing,
-    # Type alias that's only defined and imported if `typing.TYPE_CHECKING`
-    # is `True`.
-    "_TAuth": "typing.Tuple[typing.Any, typing.Any] | Auth | None",
-}
+autodoc_type_aliases = {}
 
 # -- Options for HTML output ----------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

pyproject.toml

@@ -139,6 +139,7 @@ extend-exclude = [
 
 [tool.ruff.lint]
 preview = true  # to get CPY lints
+typing-modules = ["neo4j._typing"]
 extend-ignore = [
     "RUF002",  # allow ’ (RIGHT SINGLE QUOTATION MARK) to be used as an apostrophe (e.g. "it’s")
 

src/neo4j/__init__.py

@@ -14,8 +14,7 @@
 # limitations under the License.
 
 
-import typing as _t
-
+from . import _typing as _t
 from ._api import (  # noqa: F401 dynamic attributes
     NotificationCategory,
     NotificationDisabledCategory,

src/neo4j/_addressing.py

@@ -16,7 +16,6 @@
 
 from __future__ import annotations
 
-import typing as t
 from contextlib import suppress as _suppress
 from socket import (
     AddressFamily,
@@ -25,17 +24,15 @@
     getservbyname,
 )
 
-
-if t.TYPE_CHECKING:
-    import typing_extensions as te
+from . import _typing as t
 
 
 _T = t.TypeVar("_T")
 
 
 if t.TYPE_CHECKING:
 
-    class _WithPeerName(te.Protocol):
+    class _WithPeerName(t.Protocol):
         def getpeername(self) -> tuple: ...
 
 

src/neo4j/_api.py

@@ -16,21 +16,19 @@
 
 from __future__ import annotations
 
-import typing as t
 from enum import Enum
 from urllib.parse import (
     parse_qs,
     urlparse,
 )
 
-from . import api
+from . import (
+    _typing as t,
+    api,
+)
 from .exceptions import ConfigurationError
 
 
-if t.TYPE_CHECKING:
-    import typing_extensions as te
-
-
 __all__ = [
     "DRIVER_BOLT",
     "DRIVER_NEO4J",
@@ -51,14 +49,14 @@
 ]
 
 
-DRIVER_BOLT: te.Final[str] = "DRIVER_BOLT"
-DRIVER_NEO4J: te.Final[str] = "DRIVER_NEO4J"
+DRIVER_BOLT: t.Final[str] = "DRIVER_BOLT"
+DRIVER_NEO4J: t.Final[str] = "DRIVER_NEO4J"
 
-SECURITY_TYPE_NOT_SECURE: te.Final[str] = "SECURITY_TYPE_NOT_SECURE"
-SECURITY_TYPE_SELF_SIGNED_CERTIFICATE: te.Final[str] = (
+SECURITY_TYPE_NOT_SECURE: t.Final[str] = "SECURITY_TYPE_NOT_SECURE"
+SECURITY_TYPE_SELF_SIGNED_CERTIFICATE: t.Final[str] = (
     "SECURITY_TYPE_SELF_SIGNED_CERTIFICATE"
 )
-SECURITY_TYPE_SECURE: te.Final[str] = "SECURITY_TYPE_SECURE"
+SECURITY_TYPE_SECURE: t.Final[str] = "SECURITY_TYPE_SECURE"
 
 
 def parse_neo4j_uri(uri):
@@ -184,7 +182,7 @@ class NotificationMinimumSeverity(str, Enum):
 if t.TYPE_CHECKING:
     T_NotificationMinimumSeverity = (
         NotificationMinimumSeverity
-        | te.Literal[
+        | t.Literal[
             "OFF",
             "WARNING",
             "INFORMATION",
@@ -331,7 +329,7 @@ class NotificationDisabledClassification(str, Enum):
     T_NotificationDisabledCategory = (
         NotificationDisabledCategory
         | NotificationDisabledClassification
-        | te.Literal[
+        | t.Literal[
             "HINT",
             "UNRECOGNIZED",
             "UNSUPPORTED",
@@ -458,5 +456,5 @@ class TelemetryAPI(int, Enum):
 
 
 if t.TYPE_CHECKING:
-    T_RoutingControl = RoutingControl | te.Literal["r", "w"]
+    T_RoutingControl = RoutingControl | t.Literal["r", "w"]
     __all__.append("T_RoutingControl")

src/neo4j/_async/_debug/_concurrency_check.py

@@ -18,10 +18,10 @@
 
 import inspect
 import traceback
-import typing as t
 from copy import deepcopy
 from functools import wraps
 
+from ... import _typing as t
 from ..._async_compat.concurrency import (
     AsyncLock,
     AsyncRLock,

src/neo4j/_async/auth_management.py

@@ -17,9 +17,9 @@
 from __future__ import annotations
 
 import abc
-import typing as t
 from logging import getLogger
 
+from .. import _typing as t
 from .._async_compat.concurrency import (
     AsyncCooperativeLock,
     AsyncLock,
@@ -32,9 +32,11 @@
     ExpiringAuth,
 )
 
+# ignore TCH001 to make sphinx not completely drop the ball
+from ..api import _TAuth  # noqa: TCH001
+
 
 if t.TYPE_CHECKING:
-    from ..api import _TAuth
     from ..exceptions import Neo4jError