Implement type hints for Environment and environment utilities#4824
Open
Repiteo wants to merge 1 commit intoSCons:masterfrom
Open
Implement type hints for Environment and environment utilities#4824Repiteo wants to merge 1 commit intoSCons:masterfrom
Repiteo wants to merge 1 commit intoSCons:masterfrom
Conversation
Collaborator
|
Tackling a big one, I see :-) This will take a bit to review - and it seems to have blown up a few tests. In |
Contributor
Author
|
Hmm, I might've left a functional change in there while testing return types; it'd explain the tests acting up anyway. Will take a look later |
fa49a48 to
43f2960
Compare
• Hints operate under the assumption that `Environment.Base` is the "base" class
43f2960 to
adacd48
Compare
3 tasks
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
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.
Followup to Node type hinting PRs
Hints for Environment are particularly odd, as a lot of cases would technically want to derive from
SubstitutionEnvironmentinstead ofEnvironment.Base. However, I made the type hints act as ifEnvironment.Baseis the base class. This is because, in practice, absolutely nobody is usingSubstitutionEnvironment, and it might even be refactored away in the future(?). The files adjusted were:SCons/Environment.pySCons/Node/__init__.py(Environment→EnvironmentBase)SCons/Node/FS.py(Environment→EnvironmentBase)SCons/Script/SConscript.py(SpecificallySConsEnvironmentand related functions)SCons/Util/envs.py(Utility scripts for environments)Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).