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

如何将函数的名称作为字符串获取?

def foo():pass
>>> name_of(foo)"foo"
762454 次浏览
my_function.func_name

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

import disdis.dis(my_function)

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

my_function.__name__

使用__name__是首选方法,因为它统一应用。与func_name不同,它也适用于内置函数:

>>> import time>>> time.time.func_nameTraceback (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__属性,所以你只需要记住一个特殊的名称。

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

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 inspectimport typesfrom typing import cast
this_function_name = cast(types.FrameType, inspect.currentframe()).f_code.co_name

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

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

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

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

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

这就像Albert Vonpupp用友好的包装器回答。

作为@Demyn的回答的扩展,我创建了一些实用函数来打印当前函数的名称和当前函数的参数:

import inspectimport loggingimport traceback
def get_function_name():return traceback.extract_stack(None, 2)[0][2]
def get_function_parameters_and_values():frame = inspect.currentframe().f_backargs, _, _, 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)])

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

如果你也对类方法感兴趣,Python 3.3+除了__name__之外还有__qualname__

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"

您只需要获取函数的名称,这里有一个简单的代码。假设你定义了这些函数

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__

输出将是

函数1
函数2
函数3

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

在哪里

  • stack()[0]是调用者

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

我已经看到了一些使用装饰器的答案,尽管我觉得其中一些有点冗长。这是我用于记录函数名称以及它们各自的输入和输出值的东西。我在这里对其进行了调整,以仅打印信息而不是创建日志文件,并对其进行了调整以应用于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
@debugdef my_function(**kwargs):print(kwargs)
my_function()

输出:

{'function_name': 'my_function'}

试试看

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

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

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_nameprint(func_name)  # my_second_function

您可以使用特殊的__name__变量将函数的名称作为字符串获取。

def my_function():pass
print(my_function.__name__) # prints "my_function"