Python 获取类名和函数名
Python 获取当前位置所在的函数名和行号
C/C++程序调试中经常用到的几个宏：__FILE__、__FUNCTION__、__LINE__
Python程序遇到问题调试时也想用下这种方式，找了下网上资料，发现这个问题还有不少人问
Python中获取当前位置所在的函数名和行号，都封装在sys中，获取方法如下：
import sys
def get_cur_info():
print sys._getframe().f_code.co_filename # 当前文件名，可以通过__file__获得
print sys._getframe().f_code.co_name # 当前函数名
print sys._getframe().f_lineno # 当前行号
get_cur_info()
其他函数请参考：dir(sys._getframe()).
本文主要介绍了python 动态获取当前运行的类名和函数名的方法，
分别介绍使用内置方法、sys模块、修饰器、inspect模块等方法。
一、使用内置方法和修饰器方法获取类名、函数名
python中获取函数名的情况分为内部、外部
1、从函数外部获取函数名
使用指向函数的对象，然后用__name__属性
def a(): pass a.__name__
除此之外还可以：
getattr(a,'__name__')
a.__getattribute__('__name__')
完整示例：
def a():
print("hello, l love u")
print(a.__name__)
print(a.__getattribute__('__name__'))
print(getattr(a,'__name__'))
尽管有些脱裤子放屁，总之，从外部获取的方法是非常灵活的。
2、从函数内部获取函数名
需要用些技巧
1）使用sys模块的方法：（推荐）
def a(): print sys._getframe().f_code.co_name
f_code 和 co_name 可以参考python源码解析的pyc生成和命名空间章节。
2）使用修饰器的方法： （推荐）
使用修饰器就可以对函数指向一个变量，然后取变量对象的__name__方法。
def timeit(func): def run(*argv): print func.__name__ if argv: ret = func(*argv) else: ret = func() return ret return run @timeit def t(a): print a t(1)
修饰器的改进版：
使用修饰器就可以对函数指向一个变量，然后取变量对象的__name__方法。
def get_name(func):
def warper(*args, **kwargs):
print("the function name is {}".format(func.__name__))
result = func(*args, **kwargs)
return result
return warper
@get_name
def my_name():
print("hello")
@get_name
def your_name(name):
print("hello {}".format(name))
my_name()
your_name("mimvp.com")
运行结果：
the function name is my_name
hello
the function name is your_name
hello mimvp.com
二、使用inspect模块动态获取当前运行的函数名
import inspect def get_current_function_name(): return inspect.stack()[1][3] class MyClass: def function_one(self): print "%s.%s invoked"%(self.__class__.__name__, get_current_function_name()) if __name__ == "__main__": myclass = MyClass() myclass.function_one()
动态获取当前运行的函数名很方便，特别是对于一些debug系统来说
完整示例：
def timeit(func):
def run(*argv):
print("timeit: %s" % (func.__name__)) # timeit: func
if argv:
ret = func(*argv)
else:
ret = func()
return ret
return run
# @timeit
def func():
print("self name: %s" % (sys._getframe().f_code.co_name)) # self name: func
import inspect
def get_current_function_name():
return inspect.stack()[1][3]
class MyClass:
def function_one(self):
print("%s.%s invoked" % (self.__class__.__name__, get_current_function_name())) # MyClass.function_one invoked
if __name__ == '__main__':
print("%s : __main___" % (__file__.split(MIMVP_PROJECT_NAME)[1])) # /common/mimvptech.py : __main___
print("func.name: %s , getattr(a,'__name__'): %s" % (func.__name__, getattr(func, '__name__'))) # func.name: func , getattr(a,'__name__'): func
func()
myclass = MyClass()
myclass.function_one()
运行结果：
/common/mimvptech.py : __main___ func.name: func , getattr(a,'__name__'): func self name: func MyClass.function_one invoked
知识拓展与思考
Python中没办法直接取得当前的行号和函数名，不像C++和PHP中的 __FILE__，__LINE__，__FUNC__，__FUNCTION__
如果一个函数在不知道自己名字的情况下，怎么才能递归调用自己，获取类名、函数名。
从python的logging模块说起，logging中的format中是有如下选项的:
%(name)s Name of the logger (logging channel)
%(levelno)s Numeric logging level for the message (DEBUG, INFO,
WARNING, ERROR, CRITICAL)
%(levelname)s Text logging level for the message ("DEBUG", "INFO",
"WARNING", "ERROR", "CRITICAL")
%(pathname)s Full pathname of the source file where the logging
call was issued (if available)
%(filename)s Filename portion of pathname
%(module)s Module (name portion of filename)
%(lineno)d Source line number where the logging call was issued
(if available)
%(funcName)s Function name
%(created)f Time when the LogRecord was created (time.time()
return value)
%(asctime)s Textual time when the LogRecord was created
%(msecs)d Millisecond portion of the creation time
%(relativeCreated)d Time in milliseconds when the LogRecord was created,
relative to the time the logging module was loaded
(typically at application startup time)
%(thread)d Thread ID (if available)
%(threadName)s Thread name (if available)
%(process)d Process ID (if available)
%(message)s The result of record.getMessage(), computed just as
the record is emitted
也就是说，logging是能够获取到调用者的行号和函数名的，那会不会也可以获取到自己的行号和函数名呢？
我们来看一下源码，主要部分如下:
def currentframe():
"""Return the frame object for the caller's stack frame."""
try:
raise Exception
except:
return sys.exc_info()[2].tb_frame.f_back
def findCaller(self):
"""
Find the stack frame of the caller so that we can note the source
file name, line number and function name.
"""
f = currentframe()
#On some versions of IronPython, currentframe() returns None if
#IronPython isn't run with -X:Frames.
if f is not None:
f = f.f_back
rv = "(unknown file)", 0, "(unknown function)"
while hasattr(f, "f_code"):
co = f.f_code
filename = os.path.normcase(co.co_filename)
if filename == _srcfile:
f = f.f_back
continue
rv = (co.co_filename, f.f_lineno, co.co_name)
break
return rv
def _log(self, level, msg, args, exc_info=None, extra=None):
"""
Low-level logging routine which creates a LogRecord and then calls
all the handlers of this logger to handle the record.
"""
if _srcfile:
#IronPython doesn't track Python frames, so findCaller throws an
#exception on some versions of IronPython. We trap it here so that
#IronPython can use logging.
try:
fn, lno, func = self.findCaller()
except ValueError:
fn, lno, func = "(unknown file)", 0, "(unknown function)"
else:
fn, lno, func = "(unknown file)", 0, "(unknown function)"
if exc_info:
if not isinstance(exc_info, tuple):
exc_info = sys.exc_info()
record = self.makeRecord(self.name, level, fn, lno, msg, args, exc_info, func, extra)
self.handle(record)
简单解释一下，实际上是通过在currentframe函数中抛出一个异常，然后通过向上查找的方式，找到调用的信息。其中
rv = (co.co_filename, f.f_lineno, co.co_name)
上面三个值分别为文件名，行号，函数名。
可以去 sys — System-specific parameters and functions 来看一下代码中几个系统函数的说明
OK，如果已经看懂了源码，那获取当前位置的行号和函数名相信也非常清楚了，代码如下:
#!/usr/bin/python
# -*- coding: utf-8 -*-
'''
#=============================================================================
# Author: dantezhu - https://www.vimer.cn
# Email: zny2008@gmail.com
# FileName: xf.py
# Description: 获取当前位置的行号和函数名
# Version: 1.0
# LastChange: 2010-12-17 01:19:19
# History:
#=============================================================================
'''
import sys
def get_cur_info():
"""Return the frame object for the caller's stack frame."""
try:
raise Exception
except:
f = sys.exc_info()[2].tb_frame.f_back
return (f.f_code.co_name, f.f_lineno)
def callfunc():
print get_cur_info()
if __name__ == '__main__':
callfunc()
输入结果是:
('callfunc', 24)
符合预期！哈哈，OK！
现在应该不用再抱怨取不到行号和函数名了吧
其实，Python获取函数名、行号，也可以有更简单的方法，如下:
import sys
def get_cur_info():
print sys._getframe().f_code.co_name
print sys._getframe().f_back.f_code.co_name
get_cur_info()
调用结果是:
get_cur_info
<module>
另外，利用python的 inspect 模块中的 getframeinfo 也可以得到.
inspect.getframeinfo( frame [, context ])
- Get information about a frame or traceback object. A 5-tuple is returned, the last five elements of the frame’s frame record.
- Changed in version 2.6: Returns a named tuple Traceback(filename, lineno, function,code_context, index).
参考推荐：
Shell 参数含义 $0、$1、$2、${n}、$#、$@、$*、$?、 $_、$!、$$
版权所有: 本文系米扑博客原创、转载、摘录，或修订后发表，最后更新于 2020-11-17 11:31:40
侵权处理: 本个人博客，不盈利，若侵犯了您的作品权，请联系博主删除，莫恶意，索钱财，感谢！
转载注明: Python 获取类名和函数名 （米扑博客）