Tag: formatter

Python 的 Black

在 Hacker News 上看到 Black 這個幫你處理 Python 程式碼的工具：「Black, the uncompromising Python code formatter, is stable (pypi.org)」。

Black is the uncompromising Python code formatter. By using it, you agree to cede control over minutiae of hand-formatting. In return, Black gives you speed, determinism, and freedom from pycodestyle nagging about formatting. You will save time and mental energy for more important matters.

然後從 Hacker News 上討論的情況看起來大家都覺得很不錯？好像可以看看能不能拿來用...

另外一個在討論的時候看到學到的東西，是 git blame --ignore-revs-file 這個功能，可以在 git blame 時濾掉某些 commit，剛好拿來過濾 reformatting commit：

Ignore revisions listed in file, which must be in the same format as an fsck.skipList. This option may be repeated, and these files will be processed after any files specified with the blame.ignoreRevsFile config option. An empty file name, "", will clear the list of revs from previously processed files.

Python 的 code formatter：Black

Black 是一套 Python 上的 Code Formatter，可以幫你重排程式碼以符合 coding style 與 coding standard，比起只是告訴你哪邊有錯來的更進階...

記得以前好像不是掛在官方帳號下面的，翻了一下發現在 Hacker News 上的「https://news.ycombinator.com/item?id=17151813」這則可以看到，去年在 ambv 的 repository 上，現在則是被導到 python 的組織下了 :o

目前還是掛 beta，另外有不少 practice 讓人不太舒服，像是 Hacker News 上「https://news.ycombinator.com/item?id=19939806」這邊提到的：

Against my better judgment I'll bite.
I super dislike black's formatting, and I think it's really rare to actually see it in codebases. It wraps weirdly (sometimes not at all). I'd prefer to use yapf, but last I checked it still crashes on "f-strings".

Here's a small example:

    basket.add({
        apple.stem
        for satchel in satchels
        for apple in satchel
    })
Black formats this as:
    basket.add(
        {
            apple.stem
            for satchel in satchels
            for apple in satchel
        }
    )
        
I've never seen Python code like that.
I totally believe using a formatter is good practice. Black is in a challenging position of coming into a community with a lot of existing code and customs, and I get that. But I also think that's an opportunity, rather than having to guess at what is good, there's a wealth of prior art to look at. I wish it had done this, rather than essentially codify the author's style.

看起來還有很多可以調整的，然後也可以考慮用看看... 以前是 3rd-party 還可以丟著不管，現在帶有官方色彩得看一下 :o