platform-dependent testing.CaptureMode type alias#3452
Open
jorenham wants to merge 3 commits into
Open
Conversation
AndreasBackx
approved these changes
May 22, 2026
Collaborator
AndreasBackx
left a comment
AndreasBackx
left a comment
There was a problem hiding this comment.
As other PRs: main instead of stable and no version change?
Comment on lines
+26
to
+29
| if sys.platform == "win32": | ||
| CaptureMode: t.TypeAlias = t.Literal["sys"] # pyright: ignore[reportRedeclaration] | ||
| else: | ||
| CaptureMode: t.TypeAlias = t.Literal["sys", "fd"] # pyright: ignore[reportRedeclaration] |
Collaborator
There was a problem hiding this comment.
I wonder how you would make pyright happy here... 🤔️ Anyhow, this should still be fine I believe.
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
5 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.
CliRunner.__init__will raise aValueErrorifcapture="fd"on windows. By using the fact that type-checkers are able to understand basicsys.platformchecks (https://typing.python.org/en/latest/spec/directives.html#version-and-platform-checking), we can use Python's type system to prevent this from happening, by having a definition for theCaptureModetype alias on windows, improving type-safety.