fix: TYPE_CHECKING block is empty when a downstream tool strips submodule imports#5201
Open
dgandhi62 wants to merge 2 commits into
Open
fix: TYPE_CHECKING block is empty when a downstream tool strips submodule imports#5201dgandhi62 wants to merge 2 commits into
dgandhi62 wants to merge 2 commits into
Conversation
dgandhi62
changed the title
dgandhi62
force-pushed
the
python-imports-12
branch
from
25191f8 to
4f0c14e
Compare
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
1 participant
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.
Fixes #5196
This pr emits a
passas the first statement of the generatedif typing.TYPE_CHECKING:block in a module's__init__.py, so the block remains syntactically valid even if a downstream consumer removes thefrom . import ...lines that follow it.We've seen this behavior in
cdktf get(https://github.com/hashicorp/terraform-cdk/blob/main/packages/%40cdktf/provider-generator/lib/get/constructs-maker.ts#L713) and this workaround will unblock customers.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.