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 (2,088 forks)batch import
bugfixeshelp wanted

Repository metrics

Stars
 (47,527 stars)
PR merge metrics
 (Avg merge 3d 8h) (573 merged PRs in 30d)

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

Research direction
Inspect the AST transformation code in Ruff that converts TypedDict and NamedTuple definitions to class syntax, specifically the part that handles comments, and ensure end of line comments are preserved.
Tech stack
pythonrust
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65