異なる型の引数を想定した関数

Question

悩んでいること

たとえば、以下のようなコードを改良する際に、

def sums(vals):
    n = 0
    for k in vals:
        n += k
    return n

# a = sums(3)  # TypeError: 'int' object is not iterable
b = sums([4,5,8])

以下のようにすれば上のエラーは解決しますが、

def sums(vals):
    if type(vals) == list:
        n = 0
        for k in vals:
            n += k
        return n
    else:
        return vals

a = sums(3)
b = sums([4,5,8])

このように、条件分岐で対応するより、もっと良い（pythonぽい）応用範囲の広い方法があるのではないかと思い悩んでいます。さらには、後々、引数[[2,3],[4,5]]などに対応する際に、拡張しやすいかなども考えて、手が止まっています。
（※上記の和を求めるコードはあくまで例で、たとえばnumpyを使えばもっと簡単ですよ、とかいう話ではありません）

概念としてはポリモーフィズムというものを使うのかと思いましたが、そうではないのでしょうか。クラスも使っていませんし。

教えてほしいこと

こういった、異なる型の引数を想定した関数（クラス？）を設計する際に、どういったことを考えていけばよいのでしょうか。ここを乗り越えれば、かなり視野が広がる気がしてモヤモヤしています。質問が抽象的で申し訳ありませんが、よろしくお願いします。

Answer 1

回答になっていないかもしれませんが、私はpythonでは異なる型の引数を想定した関数/クラスを用意することはほぼありません。

ただし例示されたsums()関数のような（これは良い例ですね）オブジェクトまたは任意次元のリストに対する処理の場合、私なら再帰を利用します。

def sums(vals):
    n = 0
    if type(vals) == list or type(vals) == tuple: # ついでにタプルも
        for v in vals:
            n += sums(v)
    else:
        n = vals

    return n

print(sums(1)) # 1
print(sums((1,2,3))) # 6
print(sums([1,2,3])) # 6
print(sums([[1,2,3],[4,5,6]])) # 21

Comments

[murmur1975]

異なる型の引数にそんなに需要はないのでしょうか。
再帰はハノイの塔を解く例題で見たっきりでした。こんなふうに使えるんですね。

[can110]

需要は、どうなんでしょう？
私は他にC++使いますが、同名異型の関数を定義することはほぼほぼありません。むしろ基底→派生クラス＋仮想関数で振る舞いを変えるくらいですかね。

[murmur1975]

「基底→派生クラス＋仮想関数」は面白そうな響きですが、まだ理解できそうもないので、じっくり取り組んでいきます。ありがとうございました。

[can110]

あ、「基底→派生クラス＋仮想関数」はまさにポリモーフィズム（の実装手段）です。分かりにくい表現でした。すみません。

[murmur1975]

やっぱりポリモーフィズムが最も近い解なのでしょうね。資料などを読んだだけだでは、なんとなくフワッとしかわからないので、とにかく試しにコードをたくさん書いてみます。

Answer 2

可変長引数と Iterable の判定を使って描いてみました。

from collections.abc import Iterable

def sums(*args):
    s = 0
    for v in args:
        if isinstance(v, Iterable):
            s += sums(*v)
        else:
            s += v
    return s

print(sums(3))
print(sums(3, 4))
print(sums(*[4, 5, 8]))
print(sums([4, 5, 8]))
print(sums(4, [5, 8]))
print(sums([4], [5], [8]))

print(sums(list(range(1,10))))
print(sums(*list(range(1,10))))

実行例

参考情報

• In Python, how do I determine if an object is iterable?

https://stackoverflow.com/questions/1952464

Comments

[murmur1975]

どんな形でも順番に値を取り出せるところが面白いですね。listかどうか、ではなく、Iterableかどうか、を見るのですね。目からウロコです。

Answer 3

functools.singledispatchが使えます。

from functools import singledispatch

@singledispatch
def sums(vals):
    raise TypeError
    
@sums.register(int)
def _(vals):
    return vals

@sums.register(list)   # collections.abc.Iterableでも良い
def _(vals):
    return sum(vals)


print(sums(1))
print(sums([1, 2]))
print(sums("abc"))

実行結果 Wandbox

1
3
Traceback (most recent call last):
  File "prog.py", line 18, in <module>
    print(sums("abc"))
  File "/opt/wandbox/cpython-3.6.2/lib/python3.6/functools.py", line 803, in wrapper
    return dispatch(args[0].__class__)(*args, **kw)
  File "prog.py", line 5, in sums
    raise TypeError
TypeError

ですが、あまりこれを多用するとコードが読みづらくなるようにも思います。

Comments

[murmur1975]

こんな方法もあるのですね。
多用してコードが読みづらくなるということは、私が思い描いている設計方針自体に問題がありそうですね。

[LouiS0616]

場合に依りけりだとは思います。
オーバーロードしてすっきりする場合もあるわけですし。

例に限って言えば、私はsums(int)が必要になる場面はあまりないのかな、と。

[murmur1975]

もちろん単体では使わないとは思いますが、都合上、たとえばsumsを呼ぶ部分がループに入っていたりすると、引数が一つだけになってしまうこともあるかと思います。私が実際困っている場面も同様で、引数が一つの時も二つ以上の時も同じ動作をさせたいのですが、実行時にType Errorが生じてしまったりするので、型によらない方法がないかと考えていた次第です。
オーバーロードもまだ使ったことがないので、この機会に練習も兼ねて実装してみます。

Answer 4

私見ですが、この場合パラメーターがリストであることを保証するのは
呼び側であって、関数内で対応するのは筋が違うんじゃないかなあ、と。
もしやるとしてもエラーチェック的にはじくくらいかなあ。
よしんばそういう値がくるという仕様だったら、(自分だったら)
間にラッパーをかませて調整するかなって気がします。

Comments

[murmur1975]

なるほど、そうするのが一般的なのでしょうか。ところで、ラッパーをかませるとは、sums計算本体とは別に、型を判定する関数を呼び側で用意して、その結果を利用するというようなことでしょうか？

[takasima20]

そんな感じですね。
sumsx を用意して、パラメータ解析、調整し、それを sums に渡す。
呼び側は sumsx を使用する。ってイメージでした。