From b0114f6b3f197bf1749f90504355fd4b2912dda7 Mon Sep 17 00:00:00 2001 From: Florent Biville Date: Tue, 14 Feb 2023 15:19:20 +0100 Subject: [PATCH 1/2] Rename default `execute_query` bookmark manager getter --- src/neo4j/_async/driver.py | 8 ++++---- src/neo4j/_sync/driver.py | 8 ++++---- tests/unit/async_/test_driver.py | 4 ++-- tests/unit/sync/test_driver.py | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/neo4j/_async/driver.py b/src/neo4j/_async/driver.py index 472e6e07a..546c54907 100644 --- a/src/neo4j/_async/driver.py +++ b/src/neo4j/_async/driver.py @@ -441,7 +441,7 @@ def __init__(self, pool, default_workspace_config): warnings.filterwarnings("ignore", message=r".*\bbookmark manager\b.*", category=ExperimentalWarning) - self._query_bookmark_manager = \ + self._default_execute_query_bookmark_manager = \ AsyncGraphDatabase.bookmark_manager() async def __aenter__(self) -> AsyncDriver: @@ -778,7 +778,7 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record:: parameters = dict(parameters_ or {}, **kwargs) if bookmark_manager_ is _default: - bookmark_manager_ = self._query_bookmark_manager + bookmark_manager_ = self._default_execute_query_bookmark_manager assert bookmark_manager_ is not _default with warnings.catch_warnings(): @@ -805,7 +805,7 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record:: "Driver.query_bookmark_manager is experimental. " "It might be changed or removed any time even without prior notice." ) - def query_bookmark_manager(self) -> AsyncBookmarkManager: + def default_execute_query_bookmark_manager(self) -> AsyncBookmarkManager: """The driver's default query bookmark manager. This is the default :class:`AsyncBookmarkManager` used by @@ -829,7 +829,7 @@ async def example(driver: neo4j.AsyncDriver) -> None: .. versionadded:: 5.5 """ - return self._query_bookmark_manager + return self._default_execute_query_bookmark_manager if t.TYPE_CHECKING: diff --git a/src/neo4j/_sync/driver.py b/src/neo4j/_sync/driver.py index d3a3e69d4..7b09e8783 100644 --- a/src/neo4j/_sync/driver.py +++ b/src/neo4j/_sync/driver.py @@ -439,7 +439,7 @@ def __init__(self, pool, default_workspace_config): warnings.filterwarnings("ignore", message=r".*\bbookmark manager\b.*", category=ExperimentalWarning) - self._query_bookmark_manager = \ + self._default_execute_query_bookmark_manager = \ GraphDatabase.bookmark_manager() def __enter__(self) -> Driver: @@ -776,7 +776,7 @@ def example(driver: neo4j.Driver) -> neo4j.Record:: parameters = dict(parameters_ or {}, **kwargs) if bookmark_manager_ is _default: - bookmark_manager_ = self._query_bookmark_manager + bookmark_manager_ = self._default_execute_query_bookmark_manager assert bookmark_manager_ is not _default with warnings.catch_warnings(): @@ -803,7 +803,7 @@ def example(driver: neo4j.Driver) -> neo4j.Record:: "Driver.query_bookmark_manager is experimental. " "It might be changed or removed any time even without prior notice." ) - def query_bookmark_manager(self) -> BookmarkManager: + def default_execute_query_bookmark_manager(self) -> BookmarkManager: """The driver's default query bookmark manager. This is the default :class:`BookmarkManager` used by @@ -827,7 +827,7 @@ def example(driver: neo4j.Driver) -> None: .. versionadded:: 5.5 """ - return self._query_bookmark_manager + return self._default_execute_query_bookmark_manager if t.TYPE_CHECKING: diff --git a/tests/unit/async_/test_driver.py b/tests/unit/async_/test_driver.py index 1a82a0435..745f49233 100644 --- a/tests/unit/async_/test_driver.py +++ b/tests/unit/async_/test_driver.py @@ -729,7 +729,7 @@ async def test_execute_query_bookmark_manager( with assert_warns_execute_query_experimental(): if bookmark_manager is Ellipsis: with assert_warns_execute_query_bmm_experimental(): - bookmark_manager = driver.query_bookmark_manager + bookmark_manager = driver.default_execute_query_bookmark_manager await driver.execute_query("") else: if positional: @@ -767,7 +767,7 @@ async def test_execute_query_result_transformer( res_custom: SomeClass if positional: with assert_warns_execute_query_bmm_experimental(): - bmm = driver.query_bookmark_manager + bmm = driver.default_execute_query_bookmark_manager res_custom = await driver.execute_query( "", None, "w", None, None, bmm, result_transformer ) diff --git a/tests/unit/sync/test_driver.py b/tests/unit/sync/test_driver.py index 29c526f62..73ebf6f4f 100644 --- a/tests/unit/sync/test_driver.py +++ b/tests/unit/sync/test_driver.py @@ -728,7 +728,7 @@ def test_execute_query_bookmark_manager( with assert_warns_execute_query_experimental(): if bookmark_manager is Ellipsis: with assert_warns_execute_query_bmm_experimental(): - bookmark_manager = driver.query_bookmark_manager + bookmark_manager = driver.default_execute_query_bookmark_manager driver.execute_query("") else: if positional: @@ -766,7 +766,7 @@ def test_execute_query_result_transformer( res_custom: SomeClass if positional: with assert_warns_execute_query_bmm_experimental(): - bmm = driver.query_bookmark_manager + bmm = driver.default_execute_query_bookmark_manager res_custom = driver.execute_query( "", None, "w", None, None, bmm, result_transformer ) From 483d5527e37b1fe5d1e5528e5f5d7335cfdaec84 Mon Sep 17 00:00:00 2001 From: Florent Biville Date: Wed, 15 Feb 2023 10:47:21 +0100 Subject: [PATCH 2/2] Fix documentation --- src/neo4j/_async/driver.py | 6 +++--- src/neo4j/_sync/driver.py | 6 +++--- tests/unit/async_/test_driver.py | 3 ++- tests/unit/sync/test_driver.py | 3 ++- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/neo4j/_async/driver.py b/src/neo4j/_async/driver.py index 546c54907..ad05a624e 100644 --- a/src/neo4j/_async/driver.py +++ b/src/neo4j/_async/driver.py @@ -744,7 +744,7 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record:: If present, the bookmark manager is used to keep the query causally consistent with all work executed using the same bookmark manager. - Defaults to the driver's :attr:`.query_bookmark_manager`. + Defaults to the driver's :attr:`.default_execute_query_bookmark_manager`. Pass :const:`None` to disable causal consistency. :type bookmark_manager_: @@ -802,7 +802,7 @@ async def example(driver: neo4j.AsyncDriver) -> neo4j.Record:: @property @experimental( - "Driver.query_bookmark_manager is experimental. " + "Driver.default_execute_query_bookmark_manager is experimental. " "It might be changed or removed any time even without prior notice." ) def default_execute_query_bookmark_manager(self) -> AsyncBookmarkManager: @@ -815,7 +815,7 @@ def default_execute_query_bookmark_manager(self) -> AsyncBookmarkManager: async def example(driver: neo4j.AsyncDriver) -> None: await driver.execute_query("") async with driver.session( - bookmark_manager=driver.query_bookmark_manager + bookmark_manager=driver.default_execute_query_bookmark_manager ) as session: # every query inside this session will be causally chained # (i.e., can read what was written by ) diff --git a/src/neo4j/_sync/driver.py b/src/neo4j/_sync/driver.py index 7b09e8783..4ce7cf45a 100644 --- a/src/neo4j/_sync/driver.py +++ b/src/neo4j/_sync/driver.py @@ -742,7 +742,7 @@ def example(driver: neo4j.Driver) -> neo4j.Record:: If present, the bookmark manager is used to keep the query causally consistent with all work executed using the same bookmark manager. - Defaults to the driver's :attr:`.query_bookmark_manager`. + Defaults to the driver's :attr:`.default_execute_query_bookmark_manager`. Pass :const:`None` to disable causal consistency. :type bookmark_manager_: @@ -800,7 +800,7 @@ def example(driver: neo4j.Driver) -> neo4j.Record:: @property @experimental( - "Driver.query_bookmark_manager is experimental. " + "Driver.default_execute_query_bookmark_manager is experimental. " "It might be changed or removed any time even without prior notice." ) def default_execute_query_bookmark_manager(self) -> BookmarkManager: @@ -813,7 +813,7 @@ def default_execute_query_bookmark_manager(self) -> BookmarkManager: def example(driver: neo4j.Driver) -> None: driver.execute_query("") with driver.session( - bookmark_manager=driver.query_bookmark_manager + bookmark_manager=driver.default_execute_query_bookmark_manager ) as session: # every query inside this session will be causally chained # (i.e., can read what was written by ) diff --git a/tests/unit/async_/test_driver.py b/tests/unit/async_/test_driver.py index 745f49233..0efda4874 100644 --- a/tests/unit/async_/test_driver.py +++ b/tests/unit/async_/test_driver.py @@ -66,7 +66,8 @@ def assert_warns_execute_query_experimental(): def assert_warns_execute_query_bmm_experimental(): with pytest.warns( ExperimentalWarning, - match=r"^Driver\.query_bookmark_manager is experimental\." + match= + r"^Driver\.default_execute_query_bookmark_manager is experimental\." ): yield diff --git a/tests/unit/sync/test_driver.py b/tests/unit/sync/test_driver.py index 73ebf6f4f..ba1ef991e 100644 --- a/tests/unit/sync/test_driver.py +++ b/tests/unit/sync/test_driver.py @@ -65,7 +65,8 @@ def assert_warns_execute_query_experimental(): def assert_warns_execute_query_bmm_experimental(): with pytest.warns( ExperimentalWarning, - match=r"^Driver\.query_bookmark_manager is experimental\." + match= + r"^Driver\.default_execute_query_bookmark_manager is experimental\." ): yield