Fix #2097: Recognize type comments with spaces after ##4652
Closed
anthonychen000 wants to merge 1 commit intopsf:mainpsf/black:mainfrom
anthonychen000:fix-2097-type-comment-recognitionanthonychen000/black:fix-2097-type-comment-recognitionCopy head branch name to clipboard
Closed
Fix #2097: Recognize type comments with spaces after ##4652anthonychen000 wants to merge 1 commit intopsf:mainpsf/black:mainfrom anthonychen000:fix-2097-type-comment-recognitionanthonychen000/black:fix-2097-type-comment-recognitionCopy head branch name to clipboard
anthonychen000 wants to merge 1 commit intopsf:mainpsf/black:mainfrom
anthonychen000:fix-2097-type-comment-recognitionanthonychen000/black:fix-2097-type-comment-recognitionCopy head branch name to clipboard
Conversation
Updated comment recognition functions (is_type_comment, is_type_ignore_comment, and helpers) to correctly identify type/ignore comments even when extra whitespace exists between '#' and 'type:'. This addresses the core recognition bug described in issue #2097 without implementing comment standardization. Includes test case and CHANGELOG entry. Also includes unrelated mypy fix for action/main.py.
Collaborator
|
I'm closing this PR since #4645 seems more comprehensive. Additionally, this PR seems to have some unrelated changes included - please make sure to only include the relevant changes in the future. |
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
2 participants
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 #2097
Description
Currently, Black fails to recognize
# type:and# type: ignorecomments if there's extra whitespace after the#(e.g.,# type:), as described in issue #2097. This can lead to these comments being treated as regular comments, potentially causing incorrect formatting or instability.This PR updates the comment recognition logic (
is_type_comment,is_type_ignore_comment, and helper functions likeis_type_comment_string/is_type_ignore_comment_string) to correctly handle this leading whitespace after the#. It allows comments like# type: valueand# type: ignoreto be correctly identified.As discussed in the issue thread, this change focuses only on fixing the recognition part of the bug and does not implement comment standardization (i.e., it doesn't reformat
# type:to# type:).Additionally, this PR includes a small fix for unrelated
mypyerrors ([import-untyped, unreachable]) encountered inaction/main.pywhich were required to pass local pre-commit checks.