fix BatchRequestItem now properly serializes the header and body fields #959
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
baywet
requested changes
Jun 19, 2025
Member
baywet
left a comment
baywet
left a comment
There was a problem hiding this comment.
Thanks for the contribution!
Can you add unit tests please?
Adding this test required fixing the request_info fixture and the test_initialization test because they were using a BytesIO object when the content field should just be bytes.
Contributor
Author
|
@microsoft-github-policy-service agree |
baywet
reviewed
Jun 25, 2025
…tionWriter to test the result of serialization
Contributor
|
This pull request has conflicting changes, the author must resolve the conflicts before this pull request can be merged. |
baywet
previously approved these changes
Jun 27, 2025
Member
baywet
left a comment
baywet
left a comment
There was a problem hiding this comment.
Thank you for making the changes!
baywet
previously approved these changes
Jun 27, 2025
baywet
reviewed
Jun 27, 2025
baywet
approved these changes
Jun 27, 2025
|
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.
Overview
The batch request item serialization does not currently work for the header and body fields. For both of them, a dictionary is being passed to the write_collection_of_object_values, which is supposed to be given a list of parsable objects. An ignore type annotation is being given to silence the error.
I've replaced the method with write_additional_data_value. This method accepts a dictionary of arbitrary types, so it's able to handle the deserialized json string for the body.
Demo
Notes
The write_additional_data_value is not intended to be used in this way, and is usually used to handle excess fields that may be included in the body of a request, but are not part of the parsable model class. A dedicated method for serializing dicts is probably needed.
Testing Instructions