如何获取字符串形式的函数名称？

问题描述：

如何获取函数名称作为字符串？

def foo():
    pass

>>> name_of(foo)
"foo"

解决方案 1：

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__也有一个属性，所以你只需要记住一个特殊名称。

解决方案 2：

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

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，它可能会抱怨：

错误：“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

解决方案 3：

如果您也对类方法感兴趣，那么 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"

解决方案 4：

my_function.func_name

函数还有其他有趣的属性。输入dir(func_name)以列出它们。func_name.func_code.co_code是编译后的函数，以字符串形式存储。

import dis
dis.dis(my_function)

将以几乎人类可读的格式显示代码。:)

解决方案 5：

import inspect

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

在哪里

• stack()[0]是呼叫者

• stack()[3]是方法的字符串名称

解决方案 6：

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

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

这就像 Albert Vonpupp 的答案，带有一个友好的包装。

解决方案 7：

我喜欢使用函数装饰器。我添加了一个类，它还会计算函数时间。假设 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():

解决方案 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

解决方案 9：

作为@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)])

解决方案 10：

sys._getframe()不保证在所有 Python 实现中可用（参见参考），您可以使用traceback模块做同样的事情，例如。

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

   return funcName

调用stack[-1]将返回当前进程的详细信息。

解决方案 11：

我见过一些使用装饰器的答案，但我觉得有些有点冗长。这是我用来记录函数名称及其各自的输入和输出值的东西。我在这里对其进行了调整，使其只打印信息，而不是创建日志文件，并对其进行了调整以适用于 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'}

解决方案 12：

import inspect

def my_first_function():
    func_name = inspect.stack()[0][3]
    print(func_name)  # my_first_function

或者：

import sys

def my_second_function():
    func_name = sys._getframe().f_code.co_name
    print(func_name)  # my_second_function

解决方案 13：

您可以使用特殊变量以字符串形式获取函数名称__name__。

def my_function():
    pass

print(my_function.__name__) # prints "my_function"

解决方案 14：

尝试

import sys
fn_name = sys._getframe().f_code.co_name

进一步参考
https://www.oreilly.com/library/view/python-cookbook/0596001673/ch14s08.html