web-dev-qa-db-ja.com

呼び出されたメソッドで呼び出し元のメソッド名を取得する方法は？

Python：呼び出されたメソッドで呼び出し元のメソッド名を取得する方法は？

私には2つの方法があると仮定します：

def method1(self):
    ...
    a = A.method2()

def method2(self):
    ...

Method1に変更を加えたくない場合、method2で呼び出し元の名前（この例では名前はmethod1）を取得する方法は？

pythonintrospection
151
zs2020

inspect.getframeinfo およびinspectのその他の関連する関数が役立ちます：

>>> import inspect
>>> def f1(): f2()
... 
>>> def f2():
...   curframe = inspect.currentframe()
...   calframe = inspect.getouterframes(curframe, 2)
...   print('caller name:', calframe[1][3])
... 
>>> f1()
caller name: f1

この内省は、デバッグと開発を支援することを目的としています。生産機能の目的でこれに依存することはお勧めできません。

197
Alex Martelli

短いバージョン：

import inspect

def f1(): f2()

def f2():
    print 'caller name:', inspect.stack()[1][3]

f1()

（@Alexと Stefaan Lippen のおかげで）

81
Todd Owen

これはうまくいくようです：

import sys
print sys._getframe().f_back.f_code.co_name
49
Augiwan

モジュールとクラスを含む完全なメソッド名を作成しようとする、少し長いバージョンを思いつきました。

https://Gist.github.com/2151727 （rev 9cccbf）

# Public Domain, i.e. feel free to copy/paste
# Considered a hack in Python 2

import inspect

def caller_name(skip=2):
    """Get a name of a caller in the format module.class.method

       `skip` specifies how many levels of stack to skip while getting caller
       name. skip=1 means "who calls me", skip=2 "who calls my caller" etc.

       An empty string is returned if skipped levels exceed stack height
    """
    stack = inspect.stack()
    start = 0 + skip
    if len(stack) < start + 1:
      return ''
    parentframe = stack[start][0]    

    name = []
    module = inspect.getmodule(parentframe)
    # `modname` can be None when frame is executed directly in console
    # TODO(techtonik): consider using __main__
    if module:
        name.append(module.__name__)
    # detect classname
    if 'self' in parentframe.f_locals:
        # I don't know any way to detect call from the object method
        # XXX: there seems to be no way to detect static method call - it will
        #      be just a function call
        name.append(parentframe.f_locals['self'].__class__.__name__)
    codename = parentframe.f_code.co_name
    if codename != '<module>':  # top level usually
        name.append( codename ) # function or a method

    ## Avoid circular refs and frame leaks
    #  https://docs.python.org/2.7/library/inspect.html#the-interpreter-stack
    del parentframe, stack

    return ".".join(name)
25
anatoly techtonik

上記のものの融合のビット。しかし、ここに私の亀裂があります。

def print_caller_name(stack_size=3):
    def wrapper(fn):
        def inner(*args, **kwargs):
            import inspect
            stack = inspect.stack()

            modules = [(index, inspect.getmodule(stack[index][0]))
                       for index in reversed(range(1, stack_size))]
            module_name_lengths = [len(module.__name__)
                                   for _, module in modules]

            s = '{index:>5} : {module:^%i} : {name}' % (max(module_name_lengths) + 4)
            callers = ['',
                       s.format(index='level', module='module', name='name'),
                       '-' * 50]

            for index, module in modules:
                callers.append(s.format(index=index,
                                        module=module.__name__,
                                        name=stack[index][3]))

            callers.append(s.format(index=0,
                                    module=fn.__module__,
                                    name=fn.__name__))
            callers.append('')
            print('\n'.join(callers))

            fn(*args, **kwargs)
        return inner
    return wrapper

つかいます：

@print_caller_name(4)
def foo():
    return 'foobar'

def bar():
    return foo()

def baz():
    return bar()

def fizz():
    return baz()

fizz()

出力は

level :             module             : name
--------------------------------------------------
    3 :              None              : fizz
    2 :              None              : baz
    1 :              None              : bar
    0 :            __main__            : foo
10
migpok35

私はinspect.currentframe().f_back.f_code.co_nameを使用します。その使用は、主に3つのタイプのいずれかである以前の回答のいずれにも含まれていません。

  • 一部はinspect.stackを使用しますが、あまりにも slow であることが知られています。
  • 一部のユーザーは、sys._getframeを使用します。これは、先頭に下線が付いている内部プライベート関数であるため、その使用は暗黙的に推奨されていません。
  • inspect.getouterframes(inspect.currentframe(), 2)[1][3]を使用しますが、[1][3]がアクセスしているものは完全には不明です。
import inspect
import types
from typing import cast


def caller_name() -> str:
    """Return the calling function's name."""
    # Ref: https://stackoverflow.com/a/57712700/
    return cast(types.FrameType, inspect.currentframe()).f_back.f_code.co_name


if __== '__main__':
    def _test_caller_name() -> None:
        assert caller_name() == '_test_caller_name'
    _test_caller_name()

謝辞： answer に対する1313eまでの事前コメント。

2
Acumenus

クラスを横断していて、メソッドが属するクラスとメソッドが必要な場合の方法を見つけました。少しの抽出作業が必要ですが、それは重要です。これはPython 2.7.13で機能します。

import inspect, os

class ClassOne:
    def method1(self):
        classtwoObj.method2()

class ClassTwo:
    def method2(self):
        curframe = inspect.currentframe()
        calframe = inspect.getouterframes(curframe, 4)
        print '\nI was called from', calframe[1][3], \
        'in', calframe[1][4][0][6: -2]

# create objects to access class methods
classoneObj = ClassOne()
classtwoObj = ClassTwo()

# start the program
os.system('cls')
classoneObj.method1()
1
Michael Swartz
#!/usr/bin/env python
import inspect

called=lambda: inspect.stack()[1][3]

def caller1():
    print "inside: ",called()

def caller2():
    print "inside: ",called()

if __name__=='__main__':
    caller1()
    caller2()
shahid@shahid-VirtualBox:~/Documents$ python test_func.py 
inside:  caller1
inside:  caller2
shahid@shahid-VirtualBox:~/Documents$
0
Mohammad Shahid Siddiqui

ここで回答したような関数のリストを印刷できます https://stackoverflow.com/a/56897183/4039061

import inspect;print(*['\n\x1b[0;36;1m| \x1b[0;32;1m{:25}\x1b[0;36;1m| \x1b[0;35;1m{}'.format(str(x.function), x.filename+'\x1b[0;31;1m:'+str(x.lineno)+'\x1b[0m') for x in inspect.stack()])
0
MohitGhodasara