【Python/VSCode】関数の前後が自動で2行改行されるのを防ぎたい

Question

したいこと

VSCodeにおいて、Pythonの自動整形で、自動整形自体はONのまま、関数の前後が自動で2行改行されるのを防ぐ設定変更がしたいです。

現状

保存時の自動整形をONにしており、自動で関数の前後が2行改行されてしまいます。
自動で改行してほしくないです。

↓自動整形前

↓自動整形後

作業環境

• MacOS10.14.6
• Visual Studio Code

Answer 1

解決策ではありませんし、ご存知の上での質問かもしれませんが、1つの回答として書きます。
開発チームの取り決めでスタイルが制限されていてこの問題が発生してしまうというような場合はあてはまらないのですみません。

pythonプロジェクトは、書き方の作法として pep8 というのを提供/公開しています。
コーディングのスタイルについてのいろいろな規定ですが、これを守ることで、見た目の統一が取れ、他の人に読んでもらってり、他人のコードを読むときにもあまり違和感を感じることが少なくなり、メンテナンスなどしやすくなります。
そして、お使いの整形ツールもこの規定に沿った修正を行なうようになっています。

それに従う場合、「関数定義の前は2行空ける」ことになります。また、そうすると質問にあるコメントが離れてしまいますが、このような関数の内容についてのコメントは「このコメントは def の行のあとに置くべきです」というように、defの後に書くことで離れてしまうことを防ぐことができます。

pep8に沿ってコードを書くのは最初は慣れないので違和感がありますが、慣れてしまえば書きやすくなりますし、他人のコードが読み易くなります。

Comments

[Cocode]

そのような書き方のお作法があるとは存じませんでした。とても勉強になります。ありがとうございます。