Change internal types in individual files to be private. Use TypeAlias in code where types are declared.
#61504
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
mroeschke
reviewed
May 27, 2025
| @@ -71,7 +72,7 @@ | |||
| from pandas.core.resample import Resampler | |||
| from pandas.core.window.rolling import BaseWindow | |||
|
|
|||
| ResType = dict[int, Any] | |||
| _ResType: TypeAlias = dict[int, Any] | |||
There was a problem hiding this comment.
Is this idea of making these lead with a starting _ is to they are marked as "private"? Should they instead just be moved to _typing.py with other defined "private" annotations?
There was a problem hiding this comment.
Is this idea of making these lead with a starting
_is to they are marked as "private"? Should they instead just be moved to_typing.pywith other defined "private" annotations?
The difference with the annotations in _typing.py is that many (but not all) are used in more than one pandas module. For the ones that are marked private in this PR, they are only used locally within that module.
I'm also going to be doing an MR to make more of the ones in _typing.py public.
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.
After introducing
TypeAliasin_typing.py, goal of this PR is to use it in any other source files that are creating types in this way. Also, make all of those types private.I believe that I caught them all via some searching, but may have missed a few. Couldn't find a rule that enforces use of
TypeAlias. Note that in 3.12, the recommendation is to do atypedeclaration, which is probably why there isn't such a rule.