✨ feat: add option to save additional headers when recording #773
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
markstory
reviewed
Aug 1, 2025
| @@ -64,6 +75,7 @@ def _dump( | |||
| registered: "List[BaseResponse]", | |||
| destination: "Union[BinaryIO, TextIOWrapper]", | |||
| dumper: "Callable[[Union[Dict[Any, Any], List[Any]], Union[BinaryIO, TextIOWrapper]], Any]", | |||
| additional_headers: "Optional[List[str]]" = None, | |||
There was a problem hiding this comment.
Should this be include_headers or capture_headers? On first read my interpretation was that these headers would be added into the recorded responses.
| self, | ||
| *, | ||
| file_path: "Union[str, bytes, os.PathLike[Any]]" = "response.yaml", | ||
| additional_headers: "Optional[List[str]]" = None, |
There was a problem hiding this comment.
Same here with include_headers, capture_headers or retain_headers 🤷
|
|
||
| @_recorder.record( | ||
| file_path=self.out_file, | ||
| additional_headers=["Authorization", "X-Custom-Header", "Date"], |
There was a problem hiding this comment.
Suggested change
| additional_headers=["Authorization", "X-Custom-Header", "Date"], | |
| include_headers=["Authorization", "X-Custom-Header", "Date"], |
I think this reads better, what do you think?
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.
What type of PR is this? (check all applicable)
Description
Add the ability to record additional headers when recording responses.
Before I make changes to README.md and CHANGES, want to first make sure there is appetite for this.
Related Issues
PR checklist
Before submitting this pull request, I have done the following:
toxandpre-commitchecks locallyAdded/updated tests?