Skip to content

Rename default execute_query bookmark manager getter #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Rename default execute_query bookmark manager getter #898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0114f6
Rename default `execute_query` bookmark manager getter
fbiville Feb 14, 2023
483d552
Fix documentation
fbiville Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/neo4j/_async/driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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_:
Expand Down Expand Up @@ -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():
Expand All @@ -802,10 +802,10 @@ 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 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
Expand All @@ -815,7 +815,7 @@ def query_bookmark_manager(self) -> AsyncBookmarkManager:
async def example(driver: neo4j.AsyncDriver) -> None:
await driver.execute_query("<QUERY 1>")
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 <QUERY 1>)
Expand All @@ -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:

Expand Down
14 changes: 7 additions & 7 deletions src/neo4j/_sync/driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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_:
Expand Down Expand Up @@ -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():
Expand All @@ -800,10 +800,10 @@ 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 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
Expand All @@ -813,7 +813,7 @@ def query_bookmark_manager(self) -> BookmarkManager:
def example(driver: neo4j.Driver) -> None:
driver.execute_query("<QUERY 1>")
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 <QUERY 1>)
Expand All @@ -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:

Expand Down
7 changes: 4 additions & 3 deletions tests/unit/async_/test_driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -729,7 +730,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:
Expand Down Expand Up @@ -767,7 +768,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
)
Expand Down
7 changes: 4 additions & 3 deletions tests/unit/sync/test_driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -728,7 +729,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:
Expand Down Expand Up @@ -766,7 +767,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
)
Expand Down