在 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 中实现 , 的任何想法?
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__
属性,所以你只需要记住一个特殊的名称。
要从其中获取当前函数或方法的名称,请考虑:
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
my_function.func_name
函数还有其他有趣的属性。键入dir(func_name)
以列出它们。func_name.func_code.co_code
是编译后的函数,存储为字符串。
import dis
dis.dis(my_function)
将以几乎人类可读的格式显示代码。:)
如果你也对类方法感兴趣,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"
该函数将返回调用者的函数名。
def func_name():
import traceback
return traceback.extract_stack(None, 2)[0][2]
这就像 Albert Vonpupp 用一个友好的包装回答。
import inspect
def foo():
print(inspect.stack()[0][3])
在哪里
stack()[0]
是来电者
stack()[3]
是方法的字符串名称
我喜欢使用函数装饰器。我添加了一个类,它也对函数时间进行计时。假设 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():
您只想获取函数的名称,这是一个简单的代码。假设您定义了这些功能
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
作为@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)])
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]
将返回当前进程的详细信息。
我已经看到了一些使用装饰器的答案,尽管我觉得有些答案有点冗长。这是我用来记录函数名称以及它们各自的输入和输出值的东西。我在此处对其进行了调整,以仅打印信息而不是创建日志文件,并将其调整为适用于 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'}
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
尝试
import sys
fn_name = sys._getframe().f_code.co_name
进一步参考 https://www.oreilly.com/library/view/python-cookbook/0596001673/ch14s08.html
__name__
您可以使用特殊变量将函数的名称作为字符串获取。
def my_function():
pass
print(my_function.__name__) # prints "my_function"