docs(python-guide): Add type checking guidance for AWS CDK Python development #476
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
…elopment - Expand section on preventing type errors in Python CDK development - Add detailed instructions for IDE type checking with VS Code and PyCharm - Include command-line type checking methods using MyPy and Pyright - Provide recommended workflow for type checking during development and CI/CD - Enhance documentation to help developers catch and prevent type-related errors early
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.
Description
Improve the
Type pitfallsfor Python with more details and recommendatoins.Documentation Change Type:
Affected Documentation Page(s):
Description of Changes
Motivation and Context
We are seeing some CDK Python users deploying their code with no type checks and that could potentially lead to unexpected results. We should strengthen the type checking in cdk python.
How Has This Been Validated?
Screenshots (if appropriate)
Checklist
Additional Information