Make usage of raw bookmarks easier #1065
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
(Async)Neo4jBookmarkManager's `initial_bookmarks` parameter, as well as `Bookmarks.from_raw_values` `values` parameter accept anything of type `Iterable[str]`. Unfortunately, `str` itself implements that type and yields the characters of the string. That most certainly not what the user intended. In an ideal world, we could tell the type checker to only accept `Iterable[str]` when *not* of type `str`. See also python/typing#256. To help users out, we now explicitly check for `isinstance(input, str)` and turn such inputs into an iterable with the input string as the only element.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(Async)Neo4jBookmarkManager's
initial_bookmarksparameter, as well asBookmarks.from_raw_valuesvaluesparameter accept anything of typeIterable[str]. Unfortunately,stritself implements that type and yields the characters of the string. That most certainly not what the user intended.In an ideal world, we could tell the type checker to only accept
Iterable[str]when not of typestr. See also python/typing#256.To help users out, we now explicitly check for
isinstance(input, str)and turn such inputs into an iterable with the input string as the only element.