Add option to get bytes from download_attachment directly #124
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hi, thank you for reviewing this pull request!
I recently started to use this package in a project and noticed a few things that would really improve it even more.
I'm submitting them in seperate pull requests.
It would be very useful if one could have the choice whether to write the attachment data, streamed via the download endpoint of a JMAP server, to file (as is currently the only option) or to get the bytes directly without the overhead of reading them from that file.
For this purpose I changed the behavior of download_attachment of the Client class in the case of an empty file_name arg.
I replaced raising an error with returning the raw content of the HTTP response, which would otherwise be written to file.
If you have objections to this implementation, please let me know and I'll be happy to change it.
Another possible way to implement this would be to add a kwarg 'stream' which controls this behavior.
Test for all code additions were added.
All tests and lints passed on the last commit.
There was no AI involved in writing this code.