📝 Clarify the need for mix_stderr when accessing the output of stderr in tests#1045
Merged
tiangolo merged 5 commits intofastapi:masterfrom Feb 27, 2025
Merged
Conversation
Contributor
svlandeg
reviewed
Feb 5, 2025
Member
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
I see your point for making this more clear in the docs. I've proposed a slightly different phrasing, including a reference to stdout to refer to the code snippet that is shown in the docs right before.
svlandeg
changed the title
mix_stderr when accessing the output of stderr in tests
Contributor
Author
|
hi @svlandeg I have no objections to that change 👍 |
svlandeg
approved these changes
Feb 6, 2025
Member
svlandeg
left a comment
svlandeg
left a comment
There was a problem hiding this comment.
Thanks for the feedback @mrchrisadams! This should now be good to merge, I'll just run it by Tiangolo for final approval.
Contributor
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
3 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.
This pull request includes a small change to the
docs/tutorial/testing.mdfile. The change updates the documentation to clarify how to check for output sent to standard error when usingCliRunner.Documentation update:
docs/tutorial/testing.md: Clarified that theCliRunnerinstance must be created with themix_stderr=Falseargument to accessresult.stderrin tests.Why would this change be necessary?
I've made this because I was left scratching my head trying to test the output of
stderrtoday in a project using Typer, and I only found the solution when I came across #385, an issue that was filed in 2022.I looked for a better
Exceptionto raise, but it looks like this more a problem with Click'sResultclass than Typer; after looking into the codebase there didn't seem to be an obvious place in Typer to create a new, clearer exception class.So, I've tried to go for some clearer text in the docs instead.
This is the before version:
This is the after version: