実装（解答者の理解の妨げになったので挙動から変更）と役割、どちらが関数名として適切なの？

Question

2018/2/11
区切りの為に書きます
この投稿にもう私が投稿するころはありません
皆さん質問ありがとうございました
回答者の方々どうしで議論するために使ってください

よろしければこちらのアイデアについて
ご意見がうかがえると嬉しいです
https://togetter.com/li/1198124

学業を収めることが卒業するために必要なんだから
趣味よりもそちらを最優先したほうがいいのではないかと思いました。
なので、こちらでの質問の返信は一時停止します。
せっかく答えてくださったのに、すぐに返信できずすみません。

前提・実現したいこと

twitterで実況しながらオノマトペをcsvにして作成するプログラムを作ろうとしています
で、オノマトペを生成する関数は作ったんですが、その関数名のつけ方に自信がないのです。

http://twilog.org/ys68472149/date-180206/asc
Ctrl+Fで以下を検索して

posted at 08:32:21

で作り始めたところからやっています
最新の状況は

https://twitter.com/ys68472149

でわかります

該当のソースコード

def dble_aft_join(fr,ba): #gen_onomatope(fr,ba)のほうがいいか？
    return (fr+ba)*2
    

試したこと

すいません・・・
まだ何も試していません

補足情報

引数の命名の妥当性とか
この省略はいいのか、とかそういうのも良ければお願いします

Answer 1

外部から呼び出して使う物は、役割で、内部のサブルーチン的な物は、挙動ですかね。

dble_aft_joinが、double_after_joinという意味なら略しません。そもそもこういう名前は付けない気がします。

Answer 2

特定の企業のネーミング規約の範囲内で、みたいない制限がない限り、あまりネーミングのルールはないでしょう。
関数の一覧を見たときなどに、その関数の機能を端的に理解できて、その関数を使うのがいちばん良いと判断できるネーミングにできるのがいちばんです。その関数の使い易さを端的に説明できるドキュメントもあると鬼に金棒です。

Answer 3

個人的な意見です。

「オノマトペを生成する」という機能（役割）を表明したい場合はgen_onomatopeあるいはcalc_～とします。
数学的操作（挙動）を強調、表明したい場合はdouble_after_joinとします。

「挙動」という言葉から私は実装を連想します。
そして関数の命名においては実装を隠蔽したいという意識が働きます。（あとで変えることがあるかもしれないので）
よって役割をもとに命名することが好みです。
あとfr,baが何か分かるようにします。（コメントを書くか、引数名を長くする）

追記。
私は忘れっぽいので、そもそもこの関数何に使うんだっけ？ということも忘れたりします。
で、こんな感じに引数と戻り値についての具体例を記載したりします。

# 「オノマトペ」を生成する
# fr    : 接頭文字列「チャカ」
# ba    : 接尾文字列「ポコ」
# 戻り値:「チャカポコチャカポコ」
def gen_onomatope( fr, ba):
    return (fr+ba)*2

print( gen_onomatope('チャカ','ポコ')) # チャカポコチャカポコ

Comments

[退会済みユーザー]

frとbaの命名理由はこれですね
「fr ba」の検索結果
http://twilog.org/ys68472149/search?word=fr%20ba&ao=a

2/5月曜日の発言は少し荒れてたし無関係なので無視してください…

[can110]

すみません。提示されたコードのみを見ての回答です。
んで、コード書いた本人すら数か月すると書いた内容、なぜそういう命名をしたかを完全に忘れたりするので、コメントなりは必要かと感じます。

[退会済みユーザー]

これに対する回答じゃないですけど
誤解を招いたみたいなんでタイトル少し変えてみます

Answer 4

関数の要件と用途がよくわからなかったのですが、
まず質問文の関数は引数から値を生成する関数ですか？それとも引数を元に変換する関数ですか？
どちらの関数でしょうか。

以下は個人的な感想です！

1. 関数名の先頭にdble_やgen_とするのではなく、まずクラス化してインスタンス関数としましょう。
2. fr,baは意味のある引数名に変更しましょう。そして:で型ヒント情報を付けましょう。戻り値も同様です。

---

2018年02月06日追加
Can110さんの回答をみてやっとやりたいことが分かりました。
関数名はそのままですが、私が書くならこう書き換えます。

# -*- coding: utf8 -*-


def dble_aft_join(front: str, back: str='', repeat: int=2) -> str:
    """
    :param front:接頭語
    :param back:接尾語
    :param repeat:繰り返し回数
    :return:オノマトペ
    """
    return (front + back) * repeat


def main() -> None:
    tokens =[
        dble_aft_join('ごろ', 'ごろ'),
        dble_aft_join('わく')
    ]
    for i in tokens:
        print(i)


if __name__ == '__main__':
    main()

Answer 5

私ならこうします。

def concat_x2(fr, ba):
    """Returns concatenated arguments with doubled."""
    return (fr + ba) * 2

関数名は単体で、その関数の入出力（と副作用）が想像できるほうが好みです。

Answer 6

この関数が他の同じぐらいの抽象度な関数と組み合わせて、より抽象な関数になるならこのままでいいです

この関数をユーザーが使うなら少なくとも私は何する関数なのか全くわからないのでやめたほうがいいです

要するに、モジュールの意図する抽象度に合わせて名前をつけます

ちなみにfr/baに違和感を覚えたので
複合語の前後は英語でどう表現するのか調べたところfirst/second elementが適当な感じですね