Python获取变量名称

(Owed by: 春夜喜雨 http://blog.csdn.net/chunyexiyu)

参考文档:  https://stackoverflow.com/questions/18425225/getting-the-name-of-a-variable-as-a-string/18425523 

当我们希望获取变量名称的时候，从python语法上确实没有给予特别的支持，不能像C/C++使用宏定义的方式来做。

例如C++宏定义里面使用#就可以获取到相应的名称字符串了

#define outputVar(var) { cout<<#var<<"="<<var<<endl;}

对于Python的话，暂时应该是没有支持这个语法的，如何来实现呢？下面是相关的代码与解析：

我个人认为最优的方案是方案三, 方案三可以支持一些形如a.val的情况.

方案一，使用Inspect库

首先：引入Inspect库，通过inspect.stack()获取相关的栈信息

Stack信息形如：
FrameInfo(frame=<frame at 0x00538B48, file 'E:\\python\\test.py', line 8, code retrieve_name>, filename='E:\\python\\test.py', lineno=8, function='retrieve_name', code_context=['    print(inspect.stack())\n'], index=0), 
FrameInfo(frame=<frame at 0x01E77C90, file 'E:\\python\\test.py', line 18, code outputVar>, filename='E:\\python\\test.py', lineno=18, function='outputVar', code_context=['    print("output: {}".format(retrieve_name(var)).center(50, "-"))\n'], index=0), 
FrameInfo(frame=<frame at 0x010B4340, file 'E:\\python\\test.py', line 22, code <module>>, filename='E:\\python\\test.py', lineno=22, function='<module>', code_context=['outputVar(pairs)\n'], index=0), 
FrameInfo(frame=<frame at 0x00B37C70, file 'D:\\python3.7\\lib\\idlelib\\run.py', line 474, code runcode>, filename='D:\\python3.7\\lib\\idlelib\\run.py', lineno=474, function='runcode', code_context=['                exec(code, self.locals)\n'], index=0), 
FrameInfo(frame=<frame at 0x0104BBC8, file 'D:\\python3.7\\lib\\idlelib\\run.py', line 144, code main>, filename='D:\\python3.7\\lib\\idlelib\\run.py', lineno=144, function='main', code_context=['                ret = method(*args, **kwargs)\n'], index=0), 
FrameInfo(frame=<frame at 0x00681C30, file '<string>', line 1, code <module>>, filename='<string>', lineno=1, function='<module>', code_context=None, index=None)

然后：查找栈变量信息，从顶向下，一层一层的解析栈中的变量元素fi.frame.f_locals.items。不过第一层肯定是本函数的，不能使用，最少需要从第一层往上找，或者直接把stack倒序reversed来找。例如，我采用从第二层开始找，inspect.stack() [2:]，因为我这边有二次封装输出函数。

FrameInfo逐项信息：第一层是本函数的，第二层是调用函数的，第三层...
frame=<frame at 0x00538B48, file 'E:\\python\\test.py', line 8, code retrieve_name>, 
filename='E:\\python\\test.py', 
lineno=8, 
function='retrieve_name', 
code_context=['    print(inspect.stack())\n'], 
index=0), 

最后：识别变量，f_locals.items是变量名称与指向信息的组合，借用输入参数来判定is和指向信息是否一致，一致的话，把变量名称返回。

Items形如：
('__name__', '__main__')
('__doc__', None)
('__package__', None)
('__loader__', <class '_frozen_importlib.BuiltinImporter'>)
('__spec__', None)
('__annotations__', {})
('__builtins__', <module 'builtins' (built-in)>)
('__file__', 'E:\\python\\test.py')
('re', <module 're' from 'D:\\python3.7\\lib\\re.py'>)
('inspect', <module 'inspect' from 'D:\\python3.7\\lib\\inspect.py'>)
('sys', <module 'sys' (built-in)>)
('str', '')
('pairs', [''])
('retrieve_name', <function retrieve_name at 0x01E764B0>)
('outputVar', <function outputVar at 0x01E764F8>)

整个实现如下：调用时使用outputVar可以输出形如 abc=123 的打印效果。

#从堆栈第3层开始查找返回变量名称
def retrieve_name(var):
    for fi in inspect.stack()[2:]:
        for item in fi.frame.f_locals.items():
            if (var is item[1]):
                return item[0]    
    return ""

#输出函数
def outputVar(var):
    print("{} = {}".format(retrieve_name(var),var))

方案二，使用sys库获取

使用sys库获取栈信息，具体的思路和上面一致。

只是遍历frame时，通过sys库直接遍历，免去了一层封装。

def retrieve_name_ex(var):
    frame = sys._getframe(2)
    while(frame):
        for item in frame.f_locals.items():
            if (var is item[1]):
                    return item[0]
        frame = frame.f_back
    return ""

def outputVar(var):
    print("{} = {}".format(retrieve_name_ex(var),var))   

方案三, 从代码中获取名称

尝试方案一二发现一个比较致命的问题, 当变量是复杂类型的时候, 支持的不好, 形如a[1], b.val的情况, 这种情况, 变量是a, b, 而a[1], b.val的指向并非在locals中有直接给出, 这就尴尬了.

所以想到了一种新的主意, 从代码行中获取, stack中有相关的调用函数信息, 也收集了代码行的信息, 这个时候, 如果从代码行获取信息的话, 大多数情况下应该都没有什么大碍了! （方法也在stackoverflow中发布了下）

代码如下: 注意, 使用时使用 outputVar 函数, 因为代码中用的第二层栈对应的代码.

#Owed by: http://blog.csdn.net/chunyexiyu
#direct get the input name from called function code
def retrieve_name_ex(var):
    stacks = inspect.stack()
    try:
        callFunc = stacks[1].function
        code = stacks[2].code_context[0]
        startIndex = code.index(callFunc)
        startIndex = code.index("(", startIndex + len(callFunc)) + 1
        endIndex = code.index(")", startIndex)
        return code[startIndex:endIndex].strip()
    except:
        return ""
def outputVar(var):
    print("{} = {}".format(retrieve_name_ex(var),var))

 (Owed by: 春夜喜雨 http://blog.csdn.net/chunyexiyu)