Як отримати ім'я функції у вигляді рядка?


740

Як в 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?


Відповіді:


944
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__атрибут, тож вам запам’яталося лише одне спеціальне ім’я.


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

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, то можна поскаржитися, що:

помилка: Елемент "None" у "Необов'язково [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
Річард: ні, це не так. ВИ припускаєте, що ви називаєте ім'я або ім'я_функції_файлу у своїй функції безпосередньо в тому ж обсязі, який було визначено, що дуже часто не так. Майте на увазі, що функції є об'єктами - їх можна передавати як аргументи іншим функціям, зберігати у списках / диктовах для пізніших пошуків чи виконання тощо.
mbargiel

11
@paulus_almighty, копання в кадри стека не здається мені абстрактним! Насправді це свого роду протилежне абстрактному. Дивіться примітку щодо детальної реалізації в документах. Не всі реалізації Python включатимуть sys._getframe- це безпосередньо пов'язане з внутрішніми можливостями CPython.
senderle

6
Це працює лише всередині функції, але питання вказує, що функцію не слід викликати.
user2357112 підтримує Моніку

5
Якщо ви хочете перетворити свою функцію на щось більш зручне і легке запам’ятати, вам доведеться отримати кадр 1 на кшталт sys._getframe(1).f_code.co_name, тож ви можете визначити функцію як get_func_name()і очікувати отримання потрібного імені функції, яка викликала.
м3нда

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
Сам: імена приватні, __імена спеціальні, є концептуальна різниця.
Меттью Тревор

11
Якщо когось спантеличить попередня відповідь Метью, система коментарів інтерпретувала деякі подвійні підкреслення як код для жирних. Повідомлення повинне писати: __names__приватні, __namesспеціальні.
gwideman

12
Насправді, я вважаю, що правильним є _namesприватне (окреме підкреслення раніше, просто умова), __names__особливе (подвійне підкреслення до і після). Не впевнений, чи подвійне підкреслення раніше має якесь значення, формально чи як умова.
MestreLion

8
func_nameбільше не існує в python3, тому вам потрібно використовувати func.__name__сумісність
Daenyth

34

Ця функція поверне ім'я функції абонента.

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

Це як відповідь Альберта Вонпуппа з доброзичливою обгорткою.


1
Я мав "<module>" в індексі [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:

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():

15

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

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

   return funcName

Заклик до stack[-1]поверне поточну інформацію про процес.


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

15
import inspect

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

де

  • stack () [0] абонента

  • stack () [3] назва рядка методу


1
Простий і простий. stack()[0]завжди буде викликом, [3]ім'я рядка методу.
kontur

14

Як розширення відповіді @ 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)])

8

Ви просто хочете отримати назву функції. Тут є простий код для цього. скажімо, у вас визначені ці функції

def function1():
    print "function1"

def function2():
    print "function2"

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

вихід буде функцією1

Тепер скажімо, що ви маєте ці функції у списку

a = [function1 , function2 , funciton3]

щоб отримати назву функцій

for i in a:
    print i.__name__

вихід буде

function1
function2
function3


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'}

1
Що мені подобається в цьому, на відміну від усіх інших, це те, що додавши debugфункцію, як тільки ви зможете додати функціональність, просто додавши декоратор до будь-якої функції, яка вам потрібна, або ви хочете роздрукувати ім'я функції. Здається, це найпростіше і найбільш адаптується.
запаснийTimeCoder
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.