Как получить имя функции в виде строки?

742

В Python, как я могу получить имя функции в виде строки, не вызывая функцию?

def my_function():
    pass

print get_function_name_as_string(my_function) # my_function is not in quotes

должен выводить "my_function".

Доступна ли такая функция в Python? Если нет, какие-либо идеи о том, как реализовать get_function_name_as_string, в Python?

Х10
источник

Ответы:

945
my_function.__name__

Использование __name__является предпочтительным методом, поскольку он применяется равномерно. В отличие от этого func_name, он работает и со встроенными функциями:

>>> import time
>>> time.time.func_name
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
AttributeError: 'builtin_function_or_method' object has no attribute 'func_name'
>>> time.time.__name__ 
'time'

Также двойные подчеркивания указывают читателю, что это особый атрибут. В качестве бонуса, классы и модули тоже имеют __name__атрибут, поэтому вы должны помнить только одно специальное имя.

user28409
источник
420
Потому что в некоторых случаях вы получаете некоторый объект функции в качестве аргумента вашей функции, и вам необходимо отобразить / сохранить / манипулировать именем этой функции. Возможно, вы генерируете документацию, текст справки, историю действий и т. Д. Поэтому нет, вы не всегда жестко программируете имя функции.
mbargiel
2
@mgargiel: Я хотел сказать следующее: предположим, у вас есть класс, который определяет 100 методов, где все методы являются только обертками, которые вызывают закрытый метод, передавая имя самой обертки. Что - то вроде этого: def wrapper(kwargs): super(ExtendedClass,self).call('wrapper', kwargs). У вас есть другой выбор, который: def wrapper(kwargs): super(ExtendedClass,self).call(sys._getframe().f_code.co_name, kwargs). Итак, ответ от Альберта Вонпуппа выглядит лучше для меня.
Ричард Гомес
19
@RichardGomes Один ответ подходит для получения имени внутри самой функции, другой - для получения его из ссылки на функцию. Вопрос ОП в письменном виде указывает на последнее.
Рассел Борогове
22
@RichardGomes На самом деле я пришел к этому вопросу в поисках решения этой проблемы. Проблема, которую я пытаюсь решить, - создать декоратор, который можно использовать для регистрации всех моих звонков.
Али-Хуссейн
23
Функции @RichardGomes являются первоклассными объектами, с ними может быть связано не только имя. Это не обязательно так f.__name__ == 'f'.
Вим
298

Чтобы получить имя текущей функции или метода изнутри, рассмотрим:

import inspect

this_function_name = inspect.currentframe().f_code.co_name

sys._getframeтакже работает вместо, inspect.currentframeхотя последний избегает доступа к частной функции.

Чтобы вместо этого получить имя вызывающей функции, рассмотрите f_backкак в inspect.currentframe().f_back.f_code.co_name.


Если также использовать mypy, он может жаловаться, что:

ошибка: элемент «Нет» из «Необязательно [FrameType]» не имеет атрибута «f_code»

Чтобы устранить вышеуказанную ошибку, рассмотрите:

import inspect
import types
from typing import cast

this_function_name = cast(types.FrameType, inspect.currentframe()).f_code.co_name
Альберт Вонпупп
источник
45
+1: это ответ, который я хотел бы увидеть. Другие ответы предполагают, что вызывающая сторона уже знает имя функции, что является ерундой в контексте этого вопроса.
Ричард Гомес
110
Ричард: нет, это не так. Вы предполагаете, что вызываете name или func_name для своей функции напрямую в той же области, в которой она была определена, что очень часто не соответствует действительности. Имейте в виду, что функции являются объектами - их можно передавать в качестве аргументов другим функциям, сохранять в списках / комментариях для последующего поиска или выполнения и т. Д.
mbargiel
11
@paulus_almighty, копаться в кадрах стека не кажется мне абстрактным! На самом деле, это как бы противоположность абстрактному. См. Подробное описание реализации в документации. Не все реализации Python будут включать в себя sys._getframe- он напрямую связан с внутренностями CPython.
senderle
6
Это работает только внутри функции, но вопрос указывает, что функция не должна вызываться.
user2357112 поддерживает Monica
5
В случае, если вы хотите обернуть вашу функцию во что-то более удобное и легко запоминающееся, вам нужно извлечь подобный кадр 1 sys._getframe(1).f_code.co_name, чтобы вы могли определить подобную функцию get_func_name()и ожидать получить желаемое имя вызывающей функции.
m3nda
44
my_function.func_name

Есть и другие забавные свойства функций. Напечатайте, dir(func_name)чтобы перечислить их. func_name.func_code.co_codeявляется скомпилированной функцией, хранящейся в виде строки.

import dis
dis.dis(my_function)

отобразит код в почти читаемом формате. :)

Маркус Жардеро
источник
4
В чем разница между f .__ name__ и f.func_name?
Федерико А. Рампони
14
Сэм: имена являются частными, __names особенными, есть концептуальная разница.
Мэтью Тревор
11
В случае, если кто-то озадачен предыдущим ответом Мэтью, система комментариев интерпретирует некоторые двойные подчеркивания как код для жирного шрифта. Сообщение, которое следует убирать с помощью backtick, должно __names__быть закрытым, __namesособенным.
gwideman
12
На самом деле, я думаю, что правильные _namesявляются частными (подчеркивание до, просто соглашение), __names__специальными (двойное подчеркивание до и после). Не уверен, что двойное подчеркивание раньше имеет какое-либо значение, формально или как соглашение.
МестреЛион
8
func_nameбольше не существует в python3, поэтому вам нужно использовать, func.__name__если вы хотите совместимость
Daenyth
34

Эта функция возвращает имя функции вызывающей стороны.

def func_name():
    import traceback
    return traceback.extract_stack(None, 2)[0][2]

Это как ответ Альберта Вонпуппа с дружелюбной оберткой.

Demyn
источник
1
У меня был «<модуль>» в индексе [2], но сработало следующее: traceback.extract_stack (None, 2) [0] [- 1]
emmagras
3
для меня это не работает, но это работает: traceback.extract_stack () [- 1] [2]
mike01010
Это работает, если изменить первый индекс на 1, вы должны научиться отлаживать, прежде чем комментировать ... traceback.extract_stack (None, 2) [1] [2]
Jcc.Sanabria
29

Если вы также заинтересованы в методах класса, Python 3.3+ имеет __qualname__в дополнение к __name__.

def my_function():
    pass

class MyClass(object):
    def method(self):
        pass

print(my_function.__name__)         # gives "my_function"
print(MyClass.method.__name__)      # gives "method"

print(my_function.__qualname__)     # gives "my_function"
print(MyClass.method.__qualname__)  # gives "MyClass.method"
ляпис
источник
20

Мне нравится использовать функцию декоратор. Я добавил класс, который также умножает время функции. Предположим, что gLog - это стандартный python logger:

class EnterExitLog():
    def __init__(self, funcName):
        self.funcName = funcName

    def __enter__(self):
        gLog.debug('Started: %s' % self.funcName)
        self.init_time = datetime.datetime.now()
        return self

    def __exit__(self, type, value, tb):
        gLog.debug('Finished: %s in: %s seconds' % (self.funcName, datetime.datetime.now() - self.init_time))

def func_timer_decorator(func):
    def func_wrapper(*args, **kwargs):
        with EnterExitLog(func.__name__):
            return func(*args, **kwargs)

    return func_wrapper

так что теперь все, что вам нужно сделать с вашей функцией, это украсить ее и вуаля

@func_timer_decorator
def my_func():
radato
источник
16
import inspect

def foo():
   print(inspect.stack()[0][3])

где

  • stack () [0] вызывающий

  • stack () [3] строковое имя метода

Ма Гуовей
источник
1
Легко и просто. stack()[0]всегда будет вызывающим, [3]строковое имя метода.
КОНТУР
15

В качестве продолжения ответа @ Demyn я создал несколько служебных функций, которые выводят имя текущей функции и аргументы текущей функции:

import inspect
import logging
import traceback

def get_function_name():
    return traceback.extract_stack(None, 2)[0][2]

def get_function_parameters_and_values():
    frame = inspect.currentframe().f_back
    args, _, _, values = inspect.getargvalues(frame)
    return ([(i, values[i]) for i in args])

def my_func(a, b, c=None):
    logging.info('Running ' + get_function_name() + '(' + str(get_function_parameters_and_values()) +')')
    pass

logger = logging.getLogger()
handler = logging.StreamHandler()
formatter = logging.Formatter(
    '%(asctime)s [%(levelname)s] -> %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(logging.INFO)

my_func(1, 3) # 2016-03-25 17:16:06,927 [INFO] -> Running my_func([('a', 1), ('b', 3), ('c', None)])
Джим Г.
источник
15

sys._getframe()не гарантируется, что он будет доступен во всех реализациях Python ( см. ссылку ), вы можете использовать tracebackмодуль, чтобы сделать то же самое, например.

import traceback
def who_am_i():
   stack = traceback.extract_stack()
   filename, codeline, funcName, text = stack[-2]

   return funcName

Вызов stack[-1]возвратит текущие детали процесса.

sandyc
источник
Извините, если sys._getframe()не определено, то traceback.extract_stackтакже не работает. Последний обеспечивает грубый расширенный набор функциональных возможностей первого; Вы не можете ожидать увидеть одно без другого. А на самом деле в IronPython 2.7 extract_stack()всегда возвращается []. -1
SingleNegationElimination
8

Вы просто хотите получить имя функции, вот простой код для этого. скажем, у вас есть эти функции определены

def function1():
    print "function1"

def function2():
    print "function2"

def function3():
    print "function3"
print function1.__name__

выход будет function1

Теперь скажем, у вас есть эти функции в списке

a = [function1 , function2 , funciton3]

чтобы получить название функции

for i in a:
    print i.__name__

выход будет

функция1
функция2
функция3

Мохсин Ашраф
источник
5

Я видел несколько ответов, в которых использовались декораторы, хотя некоторые из них были немного многословны. Вот что я использую для регистрации имен функций, а также их соответствующих входных и выходных значений. Я адаптировал его здесь, чтобы просто напечатать информацию, а не создавал файл журнала, и адаптировал его для применения к конкретному примеру OP.

def debug(func=None):
    def wrapper(*args, **kwargs):
        try:
            function_name = func.__func__.__qualname__
        except:
            function_name = func.__qualname__
        return func(*args, **kwargs, function_name=function_name)
    return wrapper

@debug
def my_function(**kwargs):
    print(kwargs)

my_function()

Вывод:

{'function_name': 'my_function'}
NL23codes
источник
1
Что мне нравится в этом, в отличие от всех остальных, это то, что просто добавив debugфункцию, вы можете добавить функциональность, просто добавив декоратор к любой функции, которая вам нужна или вы хотите напечатать имя функции. Это кажется самым простым и наиболее адаптируемым.
spareTimeCoder