Add some more typing for the public api#1619
Merged
rchiodo merged 2 commits intomicrosoft:mainfrom Jul 3, 2024
Merged
Conversation
debonte
reviewed
Jul 3, 2024
| class Options(object): | ||
| mode = None | ||
| address = None | ||
| address: "Optional[tuple[str, int]]" = None |
There was a problem hiding this comment.
I think the general feeling in the typing community is that Foo | None is more readable than Optional[Foo].
https://typing.readthedocs.io/en/latest/source/modernizing.html#typing-union-and-typing-optional
Contributor
Author
There was a problem hiding this comment.
I'll change them to that then.
debonte
approved these changes
Jul 3, 2024
| class Options(object): | ||
| mode = None | ||
| address = None | ||
| address: "tuple[str, int] | None" = None |
There was a problem hiding this comment.
I think the quotes are unnecessary?
Suggested change
| address: "tuple[str, int] | None" = None | |
| address: tuple[str, int] | None = None |
Contributor
Author
There was a problem hiding this comment.
They're only unnecessary on newer Python versions. Debugpy has to run on 3.8 I believe.
There was a problem hiding this comment.
Oh, interesting, I haven't run into that before.
Contributor
Author
There was a problem hiding this comment.
Yeah debugpy's pyproject forces 3.8:
[tool.pyright]
pythonVersion = "3.8"
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
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.
Was just using Pylance to test debugpy and started added some typing to the public API