【VSCode】Pythonのimport文の順番が勝手に入れ替わらないようにする（editor.formatOnPasteを使用）

はじまり#

リサちゃん

あーー！ なぜだああぁぁぁあああ！！？

135ml

どうしたんだ、急にがなり始めて。

リサちゃん

VSCodeでPythonを書いてたら、勝手にfrom文がフォーマットされてしまうのだよ・・・せっかく、`sys.path.append`したのに・・・

135ml

あららら。その場合は、settings.jsonを編集すると解消できるぞ。今回は、どのフィールドを編集すればよいかを紹介します。

リサちゃん

おっ

問題点#

今回、from文を以下のようにペーストした際に、from文の順番が前に移動してしまうためにソースにエラーが発生してしまいました。どうやら、ファイルを保存した際にも、この事象が発生するようです。

せっかく、sys.path.appendしたのに・・・

以下で、僕がこの事象を解消した方法を紹介します。

解消法#

"editor.formatOnPaste“と"editor.formatOnSave"のフィールドを黙らせると勝手に順番を入れ替わることはなくなりそうです。

解消前はこのように記述していますが・・・、

settings.json (解消前):

1
{
2

3
  ...
4

5
  "[python]": {
6
    "editor.tabSize": 4,
7
    // "editor.formatOnPaste": false,
8
    // "editor.formatOnSave": false
9
  },
10
  "editor.formatOnPaste": true,
11
  "editor.formatOnSave": true,
12

13
  ...
14

15
}

解消後のコードは以下のように記述しています。

settings.json (解消後):

1
{
2

3
  ...
4

5
  "[python]": {
6
    "editor.tabSize": 4,
7
    "editor.formatOnPaste": false,
8
    "editor.formatOnSave": false
9
  },
10
  "editor.formatOnPaste": true,
11
  "editor.formatOnSave": true,
12

13
  ...
14

15
}

解消後の動きはこの様になっています。

補足#

ここでも"editor.formatOnPaste“と"editor.formatOnSave"のフィールドをいじれますが、Pythonだけにフォーマットを無効化したい場合は、settings.jsonでないとおそらく編集できません。

おしまい#

リサちゃん

は〜、よかった〜、一生 VSCodeが使えなくなるかと思った〜。

135ml

`settings.json`で色々設定をいじれるから、VSCodeの挙動で何か困ったら、いじってみましょ。

以上になります！