3
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

blackで始める妥協のないPythonコードフォーマッティング

Posted at

タイトルで言いたいことは終わりました。Pythonのコードフォーマッターであるblackの紹介です。

Any code style you like, as long as it's black. コードのスタイリングは十人十色になりがちです。コードフォーマッターを導入してみたものの、ちょっと自分が使いやすいようにカスタマイズするとか。このblackは妥協のないただ一つのコードフォーマットスタイルを手に入れようというフォーマッターです。PEP8にのっとり、カスタマイズできない(独自ルールが作成できない)フォーマット機能を提供するようで、さまざまなプロジェクトで使用されている様子です。潔い。悩みたくないからこれで良い感があります。

The following notable open-source projects trust Black with enforcing a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis, attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Bandersnatch, Pipenv, virtualenv), pandas, Pillow, Twisted, LocalStack, every Datadog Agent Integration, Home Assistant, Zulip, Kedro, and many more.
The following organizations use Black: Facebook, Dropbox, KeepTruckin, Mozilla, Quora, Duolingo, QuantumBlack, Tesla.

https://github.com/psf/black#note-this-is-a-beta-product より。

Visual Studio Codeで利用する

まずはpipでインストールする。

> pip install black

コマンドラインで実行するとこんな感じ。

> black main.py
All done! ✨ 🍰 ✨
1 file left unchanged.

毎度コマンドをたたくのも面倒なので、Visual Studio Code でファイル保存時に、自動的にフォーマットが行われるようにします。ユーザー設定から。

python.formatting.providerblack に設定する。
image.png

editor.formatOnSave をチェックする。
image.png

これでOK!コードフォーマット自体の設定が無いので、ここから自分に合うようなカスタマイズをする必要はもちろんありません。潔くて良い!(2回目)

3
5
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
5

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?