astral-sh/ruff

UP013, UP014: Comments inside the definition are dropped

Open

#9,715 opened on Jan 30, 2024

View on GitHub
 (3 comments) (3 reactions) (1 assignee)Rust (47,527 stars) (2,088 forks)batch import
bugfixeshelp wanted

Description

Starting with this code:

from typing import NamedTuple, TypedDict

X = TypedDict("X", {
    "some_config": int,  # important
})

Y = NamedTuple("Y", [
    ("some_config", int),  # important
])

Ruff (via rules UP013 and UP014) turns it into:

from typing import NamedTuple, TypedDict

class X(TypedDict):
    some_config: int

class Y(NamedTuple):
    some_config: int

Ideally it should retain the end-of-line comments.

Contributor guide

Tech stack
pythonrust
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Ruff's AST and comment handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The issue involves retaining end of line comments when Ruff's UP013/UP014 rules transform TypedDict and NamedTuple definitions. Research should focus on how Ruff handles comments in its AST, particularly in the pyupgrade rules. Check the crates/ruff linter/src/rules/pyupgrade/ directory and look for where comment tokens are preserved or dropped during the transformation.