Introduce a context manager that closes opened connections #279
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
mjs
reviewed
Aug 29, 2017
doc/src/advanced.rst
Outdated
| However if an error is raised when selecting the folder, the connection may be | ||
| left open. | ||
|
|
||
| IMAPClient provides a context manager that automatically closes |
There was a problem hiding this comment.
"IMAPClient may be used as a context manager... " might be slightly better?
imapclient/imapclient.py
Outdated
| def __exit__(self, exc_type, exc_val, exc_tb): | ||
| """Logout and closes the connection when exiting the context manager. | ||
|
|
||
| All exceptions are caught because an error in `logout` or `shutdown` |
There was a problem hiding this comment.
"All exceptions during logout and connection shutdown are caught because an error here usually means the connection was already closed."
| mock_logger.info.assert_called_once_with( | ||
| 'Could not close the connection cleanly: %s', | ||
| self.client._imap.shutdown.side_effect | ||
| ) |
There was a problem hiding this comment.
Please consider one more test where an exception occurs inside the with block. We want to be sure it isn't suppressed by the context manager.
doc/src/advanced.rst
Outdated
| @@ -3,6 +3,33 @@ Advanced Usage | |||
| This document covers some more advanced features and tips for handling | |||
| specific usages. | |||
|
|
|||
| Prevent leaving unclosed connections | |||
There was a problem hiding this comment.
"Cleaning Up Connections" might be better
To prevent users of the library from inadvertently leaking sockets. Fixes mjs#276
NicolasLM
force-pushed
the
context-manager
branch
from
612d05c
to
043e4bd
Compare
|
Awesome stuff. Thank you! |
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.
To prevent users of the library from inadvertently leaking
sockets.
Fixes #276