docs: replace calls to __del__ with calls to close #200
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.
Related to #190.
Proposed Changes
Use
close
rather than__del__
in docs, tests and examples.I could have added a close method to
ApiClient
for consistency but I didn't.This SO answer provides a nice explanation of what
__del__
is and its limitations and why using it is not a great pattern.At least, I think the content should be in the close method, and the close method should be called in
__del__
rather than the opposite.Anyway, as said in #190, a context manager would be a nice way of solving the whole thing.
Until then, I figured using
close
in the docs would be better.Checklist
pytest tests
completes successfully