fix(jsii-pacmak): Python modules fail due to bidirectional type imports #4971
+3,564
−838
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.
In the situation of 2 modules that use each other's types, all languages are able to cope except Python. For Python,
jsii-pacmakgenerates reciprocalimportstatements (at the top) which lead to a (failing) import from an incomplete module.To solve this, we render all type signatures strictly in quotes, and gate all imports that are only being done for type declarations behind an
gate.
Implementation notes
requiredImports()into "run-time imports" and "typing imports".UserType.toPythonName()function, we centralize it a bit.typing.get_type_hints()function which has a bug when it comes to resolving forward references (ref). Changingtyping.Dicttobuiltins.dictseems to solve that, but this strictly requires Python >= 3.9 (importing will now fail on 3.8 or earlier).preEmit()phase. We use a new methodvisitTypes()to make sure we visit all types used in all module members.toTypeName()a bunch during emission; in most classes the result of that conversion is now stored in a class field.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.