PYTHON-1880: Raise a warning when no_cursor_timeout is used with an implicit session #594
Conversation
This file contains hidden or 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
ShaneHarvey
requested changes
Apr 21, 2021
Member
ShaneHarvey
left a comment
ShaneHarvey
left a comment
There was a problem hiding this comment.
Thanks for taking this one @Kn99HN!
pymongo/cursor.py
Outdated
| if not isinstance(limit, int): | ||
| raise TypeError("limit must be an instance of int") | ||
| validate_boolean("no_cursor_timeout", no_cursor_timeout) | ||
| if no_cursor_timeout: |
Member
There was a problem hiding this comment.
suggest: if no_cursor_timeout and not self.__explicit_session:
This way users can avoid seeing the warning by applying the workaround described here: https://docs.mongodb.com/v4.4/reference/method/cursor.noCursorTimeout/#session-idle-timeout-overrides-nocursortimeout
Contributor
Author
There was a problem hiding this comment.
Thank you for pointing this out!
pymongo/cursor.py
Outdated
| if no_cursor_timeout: | ||
| warnings.warn("use an explicit session with no_cursor_timeout=True"\ | ||
| "otherwise the cursor may still timeout after 30 minutes,"\ | ||
| "for more info see DOCS-11255", |
Member
There was a problem hiding this comment.
A few suggestions:
- replace DOCS-11255 with https://docs.mongodb.com/v4.4/reference/method/cursor.noCursorTimeout/#session-idle-timeout-overrides-nocursortimeout
- limit lines to 80 characters
- remove the trailing
\since it's not needed.
ShaneHarvey
approved these changes
Apr 22, 2021
Member
|
Thanks @Kn99HN! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description