feat: enable reuse of FromData instance #6853
Open
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
- do not raise RuntimeError with the reuse of FormData instance but returning self._writer - after already generated form data for a certain number of times, allow adding more fields to further-update the MultipartWriter instance
psf-chronographer
bot
added
the
bot:chronographer:provided
bdraco
reviewed
Jan 29, 2024
| @@ -132,8 +131,8 @@ def _gen_form_urlencoded(self) -> payload.BytesPayload: | |||
|
|
|||
| def _gen_form_data(self) -> multipart.MultipartWriter: | |||
| """Encode a list of fields using the multipart/form-data MIME format""" | |||
| if self._is_processed: | |||
| raise RuntimeError("Form data has been processed already") | |||
| if not self._fields: | |||
There was a problem hiding this comment.
I'm not sure this is safe to reprocess since it looks like get_payload supports streaming payloads which may only be able to be consumed once
There was a problem hiding this comment.
Yep, if we want to support this (and I've no idea if we do), then we'd probably need to subclass this, or have different logic depending on the type.
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.
I have been facing a situation that an API I was requesting would have some retryable error especially with form-data requests. While with reusing the FormData instance in my request, the RuntimeError was raised. In this case, I was confused that why the FormData instance would raise error upon re-gen.
With looking into the source code of aiohttp, I cannot discover any possible errors that may occurs with the reuse of FormData instance, especially the MultipartWriter seems to be designed with the ability to write() for more than once. As a result, I tried the change in this pr in my own code to test and proved that the resulting form-data to be send is correctly outputted.
To work more, with the fact that MultipartWriter seems to be designed for more than one time usage, the FormData may also accept further adding fields into the writer after already generated form data for a certain number of times. With this, it might be more flexible for we to deal with form-data request.
What do these changes do?
Are there changes in behavior for the user?
Users may reuse the FormData instance without the need of creating a new instance for every form-data requests.
Related issue number
n/a
Checklist
CONTRIBUTORS.txtCHANGESfolder<issue_id>.<type>for example (588.bugfix)issue_idchange it to the pr id after creating the pr.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.