Як отримати ім'я методу абонента в методі, що викликається?


187

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
"не бажано покладатися на це для виробничо-функціональних цілей." Чому ні?
beltsonata

25
@beltsonata це залежить від реалізації CPython, тому використання цього коду порушиться, якщо ви коли-небудь спробуєте використовувати PyPy, Jython або інші режими виконання. це добре, якщо ви просто розробляєте та налагоджуєте локально, але насправді не те, що потрібно у вашій виробничій системі.
robru

@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, у пошуку ресурсів, якщо не вихідний файл і файл [0] + файл [-1]! = ' <> ': IndexError: рядковий індекс поза діапазоном Чи можете ви, будь ласка, надати пропозицію. Дякую заздалегідь.
Pooja

Цей підхід дав мені помилку: KeyError: ' main '
Praxiteles

61

Здається, це працює чудово:

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

1
Здається, це набагато швидше, ніжinspect.stack
Кентвайт,

Однак він використовує захищений член, що, як правило, не рекомендується, оскільки він може вийти з ладу після того, як sysмодуль отримає важке рефакторинг.
filiprem

29

Я придумав трохи довшу версію, яка намагається створити повне ім'я методу, включаючи модуль та клас.

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)

Чудово, це спрацювало для мене в моєму коді реєстрації, де мене можуть викликати з багатьох місць. Дуже дякую.
little_birdie

1
Якщо ви також не видалите stack, він все ще просочується кадрами через кругові рефлекси, як пояснено в інспекційних документах
ankostis

@ankostis у вас є якийсь тестовий код, щоб довести це?
anatoly techtonik

1
Складно показати у коментарі ... Скопіюйте та вставте у редактор цей драйвовий код (набравши з пам’яті) та спробуйте обидві версії вашого коду: `` `import slabref class C: pass def kill (): print ('Killed' ) def leaking (): caller_name () local_var = C () слабый файл.фіналізувати (local_var, вбивати) протікання () print ("Local_var повинно бути вбито") `` `Ви повинні отримати:` `` Убитий Local_var повинен був бути вбито `` `, а не:` `Локальний_вар, мабуть, був убитий
Вбивство`

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

Я знайшов спосіб, якщо ви переходите через класи та хочете, щоб клас, метод належить до методу AND. Це вимагає трохи видобувної роботи, але це робить своє значення. Це працює в 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.