Как получить имя метода вызывающего в вызываемом методе?


188

Python: Как получить имя метода вызывающего в вызываемом методе?

Предположим, у меня есть 2 метода:

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

def method2(self):
    ...

Если я не хочу вносить какие-либо изменения для method1, как получить имя вызывающей стороны (в данном примере имя method1) в method2?


3
Да. Теперь я просто хочу сгенерировать документацию и только для тестирования.
zs2020

Технология - это одно, а методология - другое.
zs2020

Ответы:


233

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

этот самоанализ призван помочь отладке и разработке; не рекомендуется полагаться на это в производственных целях.


18
«не рекомендуется полагаться на это в производственных целях». Почему нет?
Бельцоната

25
@beltsonata это зависит от реализации CPython, поэтому код, использующий это, сломается, если вы когда-нибудь попробуете использовать PyPy, Jython или другие среды выполнения. Это хорошо, если вы просто разрабатываете и отлаживаете локально, но не совсем то, что вам нужно в вашей производственной системе.
Робру

@EugeneKrevenets Помимо версии Python, я столкнулся с проблемой, связанной с созданием кода, который запускается под вторым циклом в течение нескольких минут после его появления. это крайне неэффективно
Дмитрий

Почему это не упоминается в документации по python3? docs.python.org/3/library/inspect.html Они бы хотя бы предупредили, если это плохо, верно?

1
Обидно, что это такой удар по производительности. Ведение журнала могло бы быть намного лучше с чем-то вроде этого (или CallerMemberName ).
StingyJack

92

Укороченная версия:

import inspect

def f1(): f2()

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

f1()

(с благодарностью @Alex и Stefaan Lippen )


Здравствуйте, я получаю ошибку ниже, когда я запускаю это: Файл "/usr/lib/python2.7/inspect.py", строка 528, в findource, если не sourcefile, и файл [0] + file [-1]! = ' <> ': IndexError: строковый индекс вне диапазона. Можете ли вы дать предложение. Спасибо заранее.
Пуджа

Такой подход дал мне ошибку: KeyError: « главный »
Праксителя

61

Это, кажется, работает просто отлично:

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

1
Кажется, это намного быстрее, чемinspect.stack
Кентвейт

Тем не менее, он использует защищенный элемент, который обычно не рекомендуется, потому что он может потерпеть неудачу после sysинтенсивного рефакторинга модуля.
филипрем

29

Я придумал немного более длинную версию, которая пытается создать полное имя метода, включая модуль и класс.

https://gist.github.com/2151727 (версия 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)

Круто, это хорошо сработало для меня в моем журнале регистрации кода, куда меня могут вызывать из разных мест. Огромное спасибо.
little_birdie

1
Если вы не удалите также stack, он все еще пропускает кадры из-за циклических ссылок, как объяснено в inspect-docs
ankostis

@ankostis у тебя есть тестовый код, чтобы доказать это?
анатолий техтоник

1
Сложно показать в комментарии ... Скопируйте и вставьте в редактор этот код (набрав из памяти) и попробуйте обе версии кода: `` `импортировать слабый класс C: pass def kill (): print ('Killed') ) def leaking (): caller_name () local_var = C () weakref.finalize (local_var, kill) leaking () print ("Local_var должно быть убито") `` `Вы должны получить:` `` Убитый Local_var должен быть убил `` `а не:` `` Local_var должно быть был убит убит `` `
ankostis

1
Потрясающие! Это сработало, когда другие решения потерпели неудачу! Я использую методы класса и лямбда-выражения, так что это сложно.
OSA

17

Я бы использовал inspect.currentframe().f_back.f_code.co_name. Его использование не было рассмотрено ни в одном из предыдущих ответов, которые в основном относятся к одному из трех типов:

  • Некоторые предыдущие ответы используют, inspect.stackно известно, что он слишком медленный .
  • В некоторых предыдущих ответах используется sys._getframeвнутренняя частная функция, учитывая ее начальное подчеркивание, поэтому ее использование не рекомендуется.
  • Один предыдущий ответ использует, inspect.getouterframes(inspect.currentframe(), 2)[1][3]но совершенно неясно, к чему [1][3]обращаются.
import inspect
from types import FrameType
from typing import cast


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


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

Обратите внимание, что cast(FrameType, frame)используется для удовлетворения mypy.


Подтверждение: предварительный комментарий 1313e для ответа .


10

Немного слияния материала выше. Но вот моя трещина в этом.

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

2
Это вызовет IndexError, если заданная глубина стека будет больше, чем фактическая. Используйте, modules = [(index, inspect.getmodule(stack[index][0])) for index in reversed(range(1, min(stack_size, len(inspect.stack()))))]чтобы получить модули.
jake77

1

Я нашел способ, если вы переходите между классами и хотите, чтобы класс принадлежал методу и методу. Требуется немного работы по извлечению, но это имеет смысл. Это работает в 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()

0
#!/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$
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.