実行ファイルと外部ファイルで定義した関数の関数名のみを取得する方法

Question

一応方法は思いつくのですが、もっとスマートな方法があれば教えてください。

実行ファイルで定義した関数のみ取得

my_var = 1

def my_func():
    pass

print([k for k, v in globals().items() if callable(v)]) # ['my_func']

外部ファイルmy_module.pyで定義した関数のみ取得

import my_module

print([k for k, v in vars(my_module).items() if callable(v)]) # ['my_func']

Comments

[quickquip]

なぜそんなことをしたいのか? を書いた方がいいと思います。

Answer 1

こういうことに興味を持ってくれる人は少ないですね。

特定のモジュールで定義した関数だけを知りたいということですね。

関数はcallableですが、callableなものがすべて関数ではありません。
たとえば、intのことを型変換の関数だと誤解している人もいますが、intはクラスです。

>>> print(callable(int))
True
>>> print(type(int))
<class 'type'>

また、globalsから調べるだけの方法だと、そのモジュールでは定義していない関数も拾ってしまいます。

# test1.py

from glob import glob
my_max = max

print('globals() is\n', globals())
print('callable(glob) is', callable(glob))
print('callable(my_max) is', callable(my_max))

実行するとこうなります。

$ python test01.py
globals() is
 {'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x0000021C703476D0>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__file__': 'test01.py', '__cached__': None, 'glob': <function glob at 0x0000021C70605040>, 'my_max': <built-in function max>}
callable(glob) is True
callable(my_max) is True

自作のモジュールについて調べたいときは以下のようにやってください。

import my_module
import glob
import sys

print([k for k, v in vars(my_module).items() if type(v) == type(glob.glob) and v.__module__ == my_module.__name__])

現在のファイル中であればmy_module.__name__を'main'にしてください。
上記でglob.globを使っているのはfunctionインスタンスの代表としての意味です。

以上で大雑把なところはわかりますが、組み込みモジュールやパッケージの場合には他のことも考える必要があります。
また、メソッド、関数内で定義した関数、generatorなどは関数とは見なしていません。

Comments

[unknown_user]

ありがとうございます。わかりやすくご説明いただき大変助かりました。
確かに`callable`だと組み込み関数や外部モジュールの関数や`__call__`メソッドが含まれてしまいますね...
外部ファイルで定義した関数は
[k for k, v in vars(my_module).items() if callable(v) and v.__module__ == my_module.__name__]
実行ファイルで定義した関数は
[k for k, v in globals().items() if callable(v) and v.__module__ == '__main__']
で取得しようと思います。続きを読む ∨