(コーディング規約)スペースを複数入れて縦に揃えるのはアンチパターン？

Question

最近 Python をはじめた初心者です。Python の流儀に従おうと PEP8 で書いたコードをチェックしてみたのですが、下記のように複数のスペースを入れて縦をそろえたところ、E222:multiple spaces after operator と注意が出ました。

BUFFER_FLUSH_INTERVAL =   10
BUFFER_FLUSH_DELAY    =    5
BUFFER_MAX_SIZE       = 1000

MYSQL_ARGS = {
    'host'   : 'localhost',
    'user'   : 'root',
    'passwd' : '123123',
    'charset': 'utf8mb4',
    'db'     : 'mydb' 
}

コメントに従い次のようにすると、注意がでなくなります

BUFFER_FLUSH_INTERVAL = 10
BUFFER_FLUSH_DELAY = 5
BUFFER_MAX_SIZE = 1000

MYSQL_ARGS = {
    'host': 'localhost',
    'user': 'root',
    'passwd': '123123',
    'charset': 'utf8mb4',
    'db': 'mydb' 
}

しかし個人的には前者のほうが見やすいと思ったのですが、Python 的にはあまりやらない（行儀の悪い）表記なのでしょうか？みなさんの考え・どうしているかを教えてください。

ちなみに PEP8 にこだわりはなく、「調べてみたら何となくメジャーっぽいから」程度の選択理由です。

Answer 1

コーディング規約なんてものは、それこそ個人レベルで意見が出るモノですので。
あるコーディング規約(今回はPEP8)に準拠しようと思ったのなら、その規約に準ずるべきかと思います。
それが気に入らなければ、自分に合う他の規約を探すか、その部分のみ独自解釈とした独自のPEP8カスタム規約とすればよいかと。

私個人の意見としては、TABではなくスペースを使うべき、と言うのがまず最初にありまして。
前者のように値を揃えるやり方をTABではなくスペースで行うとすると、仮に変数名に変更があった場合や、その前後に何か入った場合にそろえなおすのが面倒なので、後者の書き方をしますね。

ただ、殆ど修正される事のないマスタデータを定義しているファイル等では前者の方法を使ったりします。
つまり、個人的にはどうでもいい類の話ですね。

Comments

[miyahan]

コメントありがとうございます。たしかに長い変数を追加してスペースを追加したり、逆に一番長かった変数が居なくなってスペースだらけのコードが残ったりと面倒ではありました。変なこだわりで、せっかくのコーディング規約を無視したり、面倒な作業をするのも何ですので、シングルスペースで行こうと思います。

Answer 2

見やすいと言えば見やすいですが、コードの修正や追加を考えると少し怖いですね。
たまに見る書き方ではありますが、その場合ですと変数名の変更や、BUFFER_FLUSH_INTERVALより長い変数名ができた場合に他の全てを修正する羽目になるので、PEP8の指摘のとおりのほうが良いかなぁと思います。

Googleのスタイルガイド等もありますが、Pythonにといては最もポピュラーで一般的なものがPEP8ですので、基本的にはそれに従っておけば間違いありません。

多くのエディタ（とそのプラグイン等）では、コードを自動的にPEP8に準拠するよう修正する機能がありますので、そういったものを使用してあまり深く考えないことをお勧めします。

Comments

[kunai]

＞BUFFER_FLUSH_INTERVALより長い変数名ができた場合・・・
ありますね、コレ。
で、これを回避するために当初つけようと思った変数名を変えて、他の変数と整合性が取れない名前になったりすると本末転倒だったりしますね

[miyahan]

コメントありがとうございます。PEP8 がもっともメジャーとのことで安心しました。せっかくの規約ですので、準拠していきたいと思います。