如何获得一个函数名作为字符串?


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中实现的任何想法?


Answers:


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 2013年

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)。因此,阿尔伯特·冯普普(Albert Vonpupp)的回答对我来说看起来更好。
理查德·戈麦斯

19
@RichardGomes一个答案适合于在函数本身中获取名称,另一个答案适合于从函数引用中获取名称。OP的书面问题表明了后者。
罗素·博罗戈夫

22
@RichardGomes实际上,我来到了这个问题,正在寻找解决方案。我要解决的问题是创建一个装饰器,该装饰器可用于记录我的所有呼叫。
阿里·侯赛因

23
@RichardGomes函数是一流的对象,绑定到它们的名称不仅仅可以是名称。不一定是这样f.__name__ == 'f'
2014年

298

要从内部获取当前函数或方法的名称,请考虑:

import inspect

this_function_name = inspect.currentframe().f_code.co_name

sys._getframeinspect.currentframe尽管后者避免访问私有功能,但它也可以代替。

要获取调用函数的名称,请考虑f_back中的inspect.currentframe().f_back.f_code.co_name


如果还使用mypy,它可能会抱怨:

错误:“ Optional [FrameType]”的项目“ None”没有属性“ 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 '16

6
这仅在函数内部有效,但问题指定不应调用该函数。
user2357112支持Monica's

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有什么区别?
Federico A. Ramponi,

14
山姆:名字是私人的,__名字是特殊的,在概念上有所不同。
马修·特雷弗

11
如果有人对Matthew的前面的答案感到困惑,则注释系统会将一些双下划线解释为粗体代码。带有反引号的转义符,消息应显示为:__names__是私有的,__names是特殊的。
gwideman 2014年

12
实际上,我认为正确的是_names私有的(之前的单个下划线,只是一个约定),__names__是特殊的(之前和之后的双下划线)。不知道之前的双下划线在正式意义上还是作为约定具有任何意义。
MestreLion 2014年

8
func_name在python3中不再存在,因此func.__name__如果需要兼容性,则需要使用
Daenyth

34

该函数将返回调用者的函数名称。

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

就像阿尔伯特·冯普普(Albert Vonpupp)用友好的包装纸回答的那样。


1
我在索引[2]处有“ <模块>”,但以下工作正常:traceback.extract_stack(None,2)[0] [-1]
emmagras 2014年

3
对我来说,这是行不通的,但这是有效的:traceback.extract_stack()[-1] [2]
mike01010 2014年

如果将第一个索引更改为1,这将起作用,您应该在注释之前学习调试... traceback.extract_stack(None,2)[1] [2]
Jcc.Sanabria '18

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 13'Aug 31'1

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__

输出将为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'}

1
与所有其他debug功能相反,我对此的喜欢是,只需添加功能一次,就可以通过简单地将装饰器添加到所需的任何功能或要打印功能名称的功能来添加功能。这似乎是最简单,最适应的。
spareTimeCoder
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.