インデントを2つに整形する方法について

Question

pythonの開発をVSCodeにて行なっているのですが、自動整形ツール(black)にてインデントの幅が「2」に修正されない現象が起きてしまっております。
VSCodeの設定につきましてはQiitaの記事を参考に設定を行いました。また、black導入につきましては、こちらの記事を参考にしました。
現状、VSCodeのsettings.jsonファイルの内容は下記になります。

{
  "python.pythonPath": "/Users/aaa/Desktop/test/venv/bin/python",
  "git.ignoreLimitWarning": true,
  // リンタの設定
  "python.linting.pylintEnabled": false,
  "python.linting.flake8Enabled": true,
  "python.linting.lintOnSave": true,
  "python.linting.flake8Args": [
    "--max-line-length",
    "--indent-size=2",
    "88",
    "--ignore=E203,W503,W504"
  ],

  // フォーマッタの設定
  "python.formatting.provider": "black",

  "[python]": {
    "editor.tabSize": 2, // インデントレベルは「2」
    "editor.formatOnSave": true, // 保存時に自動整形を行う
    "editor.formatOnPaste": false, // ペースト時に自動整形を行わない
    "editor.formatOnType": false // 入力後に自動整形を行わない
  }
}

black,flak8はpip install black flake8にて、インストールを行いました。

settings.jsonにて、設定項目を記述後、Pythonファイルを確認してみましたら、コードは整形されていたのですが、インデントが4つになっていました。
こちら、どのようにすれば、インデントを2つに修正できるのか分からない為、ご助言頂けましたら幸いです。

Answer 1

blackは、4スペースインデントを強要するフォーマッターなので、2スペースインデントで使うことは出来ません。

2スペースインデントにするには、VSCodeの設定"editor.tabSize": 2のほかに、フォーマッターに「インデントに2つの空白を使ってください」と伝える必要があります。

あなたが参考にしたサイトでは、以下のようにautopep8(VSCodeのPythonにおける標準フォーマッター)に、"--indent-size=2"を伝えています。

  "python.formatting.autopep8Args": [         // autopep8 の設定
    "--indent-size=2",
    "--ignore=E111, E114, E402, E501"
  ],

(ところで、あなたが質問中に提示したコードでは、autopep8に対する設定の一部("--indent-size=2",がflake8に対する設定の途中に割り込んでいるため、うまく動作しないと思われます)

いっぽう、blackは「ぼく(作者)が考えたさいきょうのフォーマット」を強要する性質のフォーマッターで、カスタマイズできる設定が、一行の長さなどごく少数しかありません。

インデントのスペースの数も、「変更できない設定」に含まれており、GitHubの公式リポジトリでも、「2スペースインデントを設定可能にしてくれない?(意訳)」という意見が出ても、開発側から明確に否定されています。

Configurable Indent Levels? · Issue #378 · psf/black

Comments

[study_111]

ご回答ありがとうございます。
そもそもblackは「4スペースインデントを強要するフォーマッター」であったのですね。
色々調べていたのですが、「pep8」というコーディング規約には、pythonにおいては4スペースを推奨しているみたいですし、4スペースで開発を進めてみるのが無難かもしれないですね

[Daregada]

個人で使う分には、blackのコードで4スペースを挿入している部分を2スペースに変更すれば、「2スペースインデントを強要するblack」は作れますけどね。

[study_111]

え！そうなんですね。
自分的には、今まで2スペースで開発行なってきたので、戸惑う部分はあるのですが、コーディング規約で定義されているなら、4スペースの方が良いかなってなる部分はありますね