Why does black output a different format when code has comments?

what I want

My goal is not to keep the code the way I want it to be and disable black package formatting.

The point I want to learn is that the difference between the two pieces of code is just one line of comment, and why black format results differently. I think the same code should be formatted to look the same as long as my configuration remains the same.

Examples 1

python code:

def long_long_long_long_long_long_long_long_long_long_long_long_func(arg: list): ...


long_long_long_long_long_long_long_long_long_long_long_name = (
    long_long_long_long_long_long_long_long_long_long_long_long_func(
        arg=[
            "long_long_long_long_long_long_long_long_long_long_long_string",
            "long_long_long_long_long_long_long_long_long_long_long_string",
        ]
    )
)

after black, nothing changed. That’s good.

Examples 2

python code:

def long_long_long_long_long_long_long_long_long_long_long_long_func(arg: list): ...


long_long_long_long_long_long_long_long_long_long_long_name = (
    long_long_long_long_long_long_long_long_long_long_long_long_func(
        arg=[
            "long_long_long_long_long_long_long_long_long_long_long_string",
            # a comment
            "long_long_long_long_long_long_long_long_long_long_long_string",
        ]
    )
)

after black, I got below. This is obviously not what I want.

def long_long_long_long_long_long_long_long_long_long_long_long_func(arg: list): ...


long_long_long_long_long_long_long_long_long_long_long_name = long_long_long_long_long_long_long_long_long_long_long_long_func(
    arg=[
        "long_long_long_long_long_long_long_long_long_long_long_string",
        # a comment
        "long_long_long_long_long_long_long_long_long_long_long_string",
    ]
)

env

  • black, 24.8.0 (compiled: yes)
  • Python (CPython) 3.9.19
  • macOS Sonoma 14.5

what I try

  • I’ve simplified the sample code to the point where it can at least reproduce the problem.
  • I looked in Black’s documentation for line breaks, maximum length, and there was no explanation for this
  • I searched stackoverflow. Com and Google and found no instructions.

2

This issue occurs because Black attempts to adhere to its strict rules on line length and formatting, even if it sometimes splits lines differently from what you expect. In your case, the issue is that Black treats the comment as a signal to reformat the line differently than when there is no comment.

Currently, Black doesn’t provide a way to keep the parentheses indentation style you desire when comments are involved.

If you want to maintain the original formatting style, you can use Black’s # fmt:off and # fmt:on directives.

This is the code.

# fmt: off
def long_long_long_long_long_long_long_long_long_long_long_long_func(arg: list): ...


long_long_long_long_long_long_long_long_long_long_long_name = (
    long_long_long_long_long_long_long_long_long_long_long_long_func(
        arg=[
            "long_long_long_long_long_long_long_long_long_long_long_string",
            # a comment
            "long_long_long_long_long_long_long_long_long_long_long_string",
        ]
    )
)
# fmt: on

I hope this will help you a little.

1

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật