PR

【Python】フォーマッターのblackを使用してクォーテーションを統一

Python
記事内に広告が含まれています。

Pythonのフォーマッターを検討している方向けの記事となります。
個人的にクォーテーションを統一したかったので、blackを使って統一することにしました。

環境

  • Python: 3.9.1

blackを使用した経緯

元々開発していたプロジェクトでautopep8を使っていたのですが、クォーテーションを統一することができていませんでした。

個人的にクォーテーションを統一していないことが嫌なので、クォーテーションを統一することを求めた結果としてblackを導入する経緯に至りました。

blackのインストール

$ pip3 install black

今回導入したバージョンは、下記になります。

black==23.3.0

実際のフォーマット例

例えば、文字列の配列があるとします。

str_array = ['a', 'b', 'c', 'd', 'e']

blackを通すと、ダブルクォーテーションに自動変換されます。
blackのルールで、保存時にシングルクォーテーションがダブルクォーテーションに置換されます。

str_array = ["a", "b", "c", "d", "e"]

VSCodeでの設定方法

以下は、settings.jsonに記載する例です。
フォーマットに関連する部分だけ抜粋しています。

{
  "editor.formatOnSave": true,
  "python.formatting.provider": "black",
  "python.formatting.blackArgs": ["--line-length=119"]
}

line-length は1行あたりの最大文字列の設定になります。

まとめ

blackを使用してPythonでクォーテーションを統一することに関して記載しました。

Pythonを使用していてクォーテーションを統一したいけどできていないという方は、是非blackを導入してみてください。

また、他にもPythonに関連した記事を書いているので、興味のある方は↓から覗いていってください。
Pythonカテゴリの記事はこちら

コメント

タイトルとURLをコピーしました