[Python]他人が見ても分かりやす関数名や変数名について（lst, dct等）

Question

こういう議論をしたところで何か一つに定まるものじゃないと言われるかもしれませんが、
何かしらのヒントが得られればと思い質問しました。

大体困るのはコレクション型を使っている時です。
具体例をPythonを使ってあげると、

# 何かしらの単語のList
word_lst = ["aaa","bbb","ccc"]
words = ["aaa","bbb","ccc"]

# 何かしらの単語のDictionary
word_dct = {"aaa" : 1, "bbb" : 2, "ccc" : 3}
words = {"aaa" : 1, "bbb" : 2, "ccc" : 3}

# set, tuple 等も同様

正直今の自分はlstやdctに慣れてしまっています。ですが、lstやdctなどは何となく気持ち悪い
感じがしています。恐らく気持ち悪さの裏にはlist → lst, dictionary → dctの略だというのがそうさせている
ような気がします。
コードを書く上での話をすると、List型の場合は
word_lstよりもwordsの方がしっくりきます。
ですが辞書型の場合はそうもいかず、
word_dctの方が分かりやすいと思いました。（その他いい変数名があれば教えて欲しいです）

そもそもlst, dctなどのような変数名をつけないほうがいいのでしょうか？
他人が見ても分かりやすい変数名や関数名をつけるのは本当に難しいです。
宜しくお願い致します。

Answer 1

そもそもlst, dctなどのような変数名をつけないほうがいいのでしょうか？

自分以外でコードを見た人がひと目でわかる名前であれば、なんでもよいです。
以下は個人的な好みです。

配列

配列名は <単数>_list とするよりも、複数形にする派ですね。

# fruit_list = ['apple', 'pen', 'banana']
fruits = ['apple', 'pen', 'banana']

# 要素1つを参照するときは単数形にします。
for fruit in fruits:
    print(fruit)

辞書

dict も複数形にします。

settings = {'width': 100, 'height': 200}

colors = {'red': (255, 0, 0), 'green': (0, 255, 0), 'blue': (0, 0, 255)}

なにかの対応関係を表している場合は <名前>_map もしくは <A>to<B>/<A>2<B> とします。

id_to_label = {1: 'apple', 3: 'orange', 4: 'peach'}

Comments

[_Victorique__]

回答ありがとうございます。
辞書型でもsをつけるのは意外でした。
今後のヒントにさせていただきます。
有り難うございました！

Answer 2

組み込み型のlist, dictとカブるというのがlst, dctを使う最大のモチベーションなので、質問文のケースはそもそも省略する必要があるケースに該当しません。

私なら基本的にはword_list, word_dictにします。

wordsのように複数形にするかどうかはケースバイケースな気がします。型を明示した方がわかりやすいときと、型なんか示しても何の役にも立たないようなときがあるので。

あとは一時変数的な用途でlist, dictそのものを使いたくなったときの処置が問題ですかね。個人的には、前者はlst、後者はdにしていることが多い気がします。

Comments

[_Victorique__]

回答有難うございます。
*_listが良かったり*sの方が良かったりがあるとのことですが、
それらを混在させることはさほど問題ないのでしょうか？
例えばなんですが、diseaseなどsをつけるだけでは分かりにくい場合もあります。
なので私の場合はsやlistが混在してしまっています。

[hayataka2049]

混在させてもあまり大きな問題はないと思いますが、たとえばチーム開発であれば「どんな基準で使い分けているのか」と議論になる前に統一しておいた方が良い、といったケースはあると思います