Normalize type comment formatting and handle extra spaces #4542
Conversation
This file contains 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
cobaltt7
reviewed
Dec 30, 2024
| if not comment_text.startswith("type:"): | ||
| return False | ||
| type_annotation = comment_text[5:].strip() | ||
| leaf.value = f"# type: {type_annotation}" if type_annotation else "# type:" |
There was a problem hiding this comment.
I think this function should probably stay pure, maybe put the modification part somewhere else
Also, this will need to go in the preview style
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.
Description: This PR addresses an issue with the handling of type comments in Black. Previously, type comments with multiple spaces after # were not recognized correctly, and formatting could lead to unnecessary whitespace.
Changes:
Fixed the handling of type comments by normalizing whitespace after # and : (e.g., converting # type: str to # type: str).
The function now trims extra spaces and ensures consistent formatting for type comments.
Added a check for comments starting with type: and cleaned up the comment text accordingly.
Updated the function to format the comment as # type: if no type annotation is present.
Why:
This change improves the detection and formatting of type comments, especially in cases where users accidentally add extra spaces.
It ensures a standardized format for type comments across the codebase, reducing the likelihood of errors in formatting.
Related Issue:
If this PR addresses a specific issue, reference it here by including the issue number (e.g., Fixes #2097 ).