Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalize type comment formatting and handle extra spaces #4542

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Normalize type comment formatting and handle extra spaces #4542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/black/nodes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,9 +932,14 @@ def is_type_comment(leaf: Leaf) -> bool:
be used for general type comments (excluding ignore annotations, which should
use `is_type_ignore_comment`). Note that general type comments are no longer
used in modern version of Python, this function may be deprecated in the future."""
t = leaf.type
v = leaf.value
return t in {token.COMMENT, STANDALONE_COMMENT} and v.startswith("# type:")
if leaf.type not in {token.COMMENT, STANDALONE_COMMENT}:
return False
comment_text = leaf.value.lstrip("#").lstrip()
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:"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

return True


def is_type_ignore_comment(leaf: Leaf) -> bool:
Expand Down