Remove Bookmark in favor or Bookmarks

Author: robsdedude

CHANGELOG.md

@@ -40,6 +40,7 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
   - `connection_acquisition_timeout` configuration option
     - `ValueError` on invalid values (instead of `ClientError`)
     - Consistently restrict the value to be strictly positive
+- Remove deprecated class `neo4j.Bookmark` in favor of `neo4j.Bookmarks`.
 
 
 ## Version 5.28

docs/source/api.rst

@@ -984,13 +984,18 @@ Optional :class:`neo4j.Bookmarks`. Use this to causally chain sessions.
 See :meth:`.Session.last_bookmarks` or :meth:`.AsyncSession.last_bookmarks` for
 more information.
 
+:Type: ``None``, ``neo4j.Bookmarks``
+
 :Default: :data:`None`
 
 .. deprecated:: 5.0
     Alternatively, an iterable of strings can be passed. This usage is
     deprecated and will be removed in a future release. Please use a
     :class:`neo4j.Bookmarks` object instead.
 
+.. versionchanged:: 6.0
+    Only accepts :class:`neo4j.Bookmarks` objects or :data:`None`.
+
 
 .. _database-ref:
 
@@ -1940,9 +1945,6 @@ Bookmarks
     :members:
     :special-members: __bool__, __add__, __iter__
 
-.. autoclass:: neo4j.Bookmark
-    :members:
-
 
 BookmarkManager
 ===============

src/neo4j/__init__.py

@@ -93,7 +93,6 @@
     AuthToken,
     basic_auth,
     bearer_auth,
-    Bookmark,
     Bookmarks,
     custom_auth,
     DEFAULT_DATABASE,
@@ -126,7 +125,6 @@
     "Auth",
     "AuthToken",
     "BoltDriver",
-    "Bookmark",
     "Bookmarks",
     "Driver",
     "EagerResult",

src/neo4j/_async/work/workspace.py

@@ -127,21 +127,13 @@ def _set_pinned_database(self, database):
         self._config.database = database
 
     def _initialize_bookmarks(self, bookmarks):
-        if isinstance(bookmarks, Bookmarks):
-            prepared_bookmarks = tuple(bookmarks.raw_values)
-        elif hasattr(bookmarks, "__iter__"):
-            deprecation_warn(
-                "Passing an iterable as `bookmarks` to `Session` is "
-                "deprecated. Please use a `Bookmarks` instance.",
-                stack_level=5,
-            )
-            prepared_bookmarks = tuple(bookmarks)
-        elif not bookmarks:
+        if bookmarks is None:
             prepared_bookmarks = ()
+        elif isinstance(bookmarks, Bookmarks):
+            prepared_bookmarks = tuple(bookmarks.raw_values)
         else:
             raise TypeError(
-                "Bookmarks must be an instance of Bookmarks or an "
-                "iterable of raw bookmarks (deprecated)."
+                "Bookmarks must be an instance of Bookmarks or None."
             )
         self._initial_bookmarks = self._bookmarks = prepared_bookmarks
 

src/neo4j/_sync/work/workspace.py

@@ -65,7 +65,6 @@
     "AsyncBookmarkManager",
     "Auth",
     "AuthToken",
-    "Bookmark",
     "BookmarkManager",
     "Bookmarks",
     "ServerInfo",
@@ -234,51 +233,6 @@ def custom_auth(
     return Auth(scheme, principal, credentials, realm, **parameters)
 
 
-# TODO: 6.0 - remove this class
-@deprecated("Use the `Bookmarks` class instead.")
-class Bookmark:
-    """
-    A Bookmark object contains an immutable list of bookmark string values.
-
-    :param values: ASCII string values
-
-    .. deprecated:: 5.0
-        `Bookmark` will be removed in version 6.0.
-        Use :class:`Bookmarks` instead.
-    """
-
-    def __init__(self, *values: str) -> None:
-        if values:
-            bookmarks = []
-            for ix in values:
-                try:
-                    if ix:
-                        ix.encode("ascii")
-                        bookmarks.append(ix)
-                except UnicodeEncodeError as e:
-                    raise ValueError(f"The value {ix} is not ASCII") from e
-            self._values = frozenset(bookmarks)
-        else:
-            self._values = frozenset()
-
-    def __repr__(self) -> str:
-        """
-        Represent the container as str.
-
-        :returns: repr string with sorted values
-        """
-        values = ", ".join([f"'{ix}'" for ix in sorted(self._values)])
-        return f"<Bookmark values={{{values}}}>"
-
-    def __bool__(self) -> bool:
-        return bool(self._values)
-
-    @property
-    def values(self) -> frozenset:
-        """:returns: immutable list of bookmark string values"""
-        return self._values
-
-
 class Bookmarks:
     """
     Container for an immutable set of bookmark string values.

src/neo4j/api.py

@@ -242,21 +242,6 @@ async def test_session_last_bookmark_is_deprecated(async_fake_pool, bookmarks):
                 assert (await session.last_bookmark()) is None
 
 
-@pytest.mark.parametrize(
-    "bookmarks", (("foo",), ("foo", "bar"), (), ["foo", "bar"], {"a", "b"})
-)
-@mark_async_test
-async def test_session_bookmarks_as_iterable_is_deprecated(
-    async_fake_pool, bookmarks
-):
-    with pytest.warns(DeprecationWarning):
-        async with AsyncSession(
-            async_fake_pool, SessionConfig(bookmarks=bookmarks)
-        ) as session:
-            ret_bookmarks = (await session.last_bookmarks()).raw_values
-            assert ret_bookmarks == frozenset(bookmarks)
-
-
 @pytest.mark.parametrize(
     ("query", "error_type"),
     (

tests/unit/async_/work/test_session.py

@@ -28,145 +28,6 @@
 standard_ascii = [chr(i) for i in range(128)]
 not_ascii = "♥O◘♦♥O◘♦"
 
-
-def test_bookmark_is_deprecated() -> None:
-    with pytest.deprecated_call():
-        neo4j.Bookmark()
-
-
-def test_bookmark_initialization_with_no_values() -> None:
-    with pytest.deprecated_call():
-        bookmark = neo4j.Bookmark()
-    assert bookmark.values == frozenset()
-    assert bool(bookmark) is False
-    assert repr(bookmark) == "<Bookmark values={}>"
-
-
-@pytest.mark.parametrize(
-    ("test_input", "expected_values", "expected_bool", "expected_repr"),
-    [
-        (
-            (None,),
-            frozenset(),
-            False,
-            "<Bookmark values={}>",
-        ),
-        (
-            (None, None),
-            frozenset(),
-            False,
-            "<Bookmark values={}>",
-        ),
-        (
-            ("bookmark1", None),
-            frozenset({"bookmark1"}),
-            True,
-            "<Bookmark values={'bookmark1'}>",
-        ),
-        (
-            ("bookmark1", None, "bookmark2", None),
-            frozenset({"bookmark1", "bookmark2"}),
-            True,
-            "<Bookmark values={'bookmark1', 'bookmark2'}>",
-        ),
-        (
-            (None, "bookmark1", None, "bookmark2", None, None, "bookmark3"),
-            frozenset({"bookmark1", "bookmark2", "bookmark3"}),
-            True,
-            "<Bookmark values={'bookmark1', 'bookmark2', 'bookmark3'}>",
-        ),
-    ],
-)
-def test_bookmark_initialization_with_values_none(
-    test_input, expected_values, expected_bool, expected_repr
-) -> None:
-    with pytest.deprecated_call():
-        bookmark = neo4j.Bookmark(*test_input)
-    assert bookmark.values == expected_values
-    assert bool(bookmark) is expected_bool
-    assert repr(bookmark) == expected_repr
-
-
-@pytest.mark.parametrize(
-    ("test_input", "expected_values", "expected_bool", "expected_repr"),
-    [
-        (
-            ("",),
-            frozenset(),
-            False,
-            "<Bookmark values={}>",
-        ),
-        (
-            ("", ""),
-            frozenset(),
-            False,
-            "<Bookmark values={}>",
-        ),
-        (
-            ("bookmark1", ""),
-            frozenset({"bookmark1"}),
-            True,
-            "<Bookmark values={'bookmark1'}>",
-        ),
-        (
-            ("bookmark1", "", "bookmark2", ""),
-            frozenset({"bookmark1", "bookmark2"}),
-            True,
-            "<Bookmark values={'bookmark1', 'bookmark2'}>",
-        ),
-        (
-            ("", "bookmark1", "", "bookmark2", "", "", "bookmark3"),
-            frozenset({"bookmark1", "bookmark2", "bookmark3"}),
-            True,
-            "<Bookmark values={'bookmark1', 'bookmark2', 'bookmark3'}>",
-        ),
-    ],
-)
-def test_bookmark_initialization_with_values_empty_string(
-    test_input, expected_values, expected_bool, expected_repr
-) -> None:
-    with pytest.deprecated_call():
-        bookmark = neo4j.Bookmark(*test_input)
-    assert bookmark.values == expected_values
-    assert bool(bookmark) is expected_bool
-    assert repr(bookmark) == expected_repr
-
-
-@pytest.mark.parametrize(
-    ("test_input", "expected_values", "expected_bool", "expected_repr"),
-    [
-        (
-            ("bookmark1",),
-            frozenset({"bookmark1"}),
-            True,
-            "<Bookmark values={'bookmark1'}>",
-        ),
-        (
-            ("bookmark1", "bookmark2", "bookmark3"),
-            frozenset({"bookmark1", "bookmark2", "bookmark3"}),
-            True,
-            "<Bookmark values={'bookmark1', 'bookmark2', 'bookmark3'}>",
-        ),
-        (
-            standard_ascii,
-            frozenset(standard_ascii),
-            True,
-            "<Bookmark values={{'{values}'}}>".format(
-                values="', '".join(standard_ascii)
-            ),
-        ),
-    ],
-)
-def test_bookmark_initialization_with_valid_strings(
-    test_input, expected_values, expected_bool, expected_repr
-) -> None:
-    with pytest.deprecated_call():
-        bookmark = neo4j.Bookmark(*test_input)
-    assert bookmark.values == expected_values
-    assert bool(bookmark) is expected_bool
-    assert repr(bookmark) == expected_repr
-
-
 _bm_input_mark = pytest.mark.parametrize(
     ("test_input", "expected"),
     [
@@ -177,14 +38,6 @@ def test_bookmark_initialization_with_valid_strings(
 )
 
 
-@_bm_input_mark
-def test_bookmark_initialization_with_invalid_strings(
-    test_input: tuple[str], expected
-) -> None:
-    with pytest.raises(expected), pytest.warns(DeprecationWarning):
-        neo4j.Bookmark(*test_input)
-
-
 @_bm_input_mark
 def test_bookmarks_initialization_with_invalid_strings(
     test_input: tuple[str], expected

tests/unit/common/test_api.py

@@ -43,7 +43,6 @@ def test_import_neo4j():
     ("basic_auth", None),
     ("bearer_auth", None),
     ("BoltDriver", None),
-    ("Bookmark", None),
     ("Bookmarks", None),
     ("custom_auth", None),
     ("DEFAULT_DATABASE", None),