【python】打印输出变量名

一、前言

1.1 需求分析

  Python 中打印变量名是一个很常见的操作。通常，为了使变量值易于分辨，通常会连带其名称一起打印：

print("x:", x)

  但当变量多的时候，这种写法就显得很冗杂！

print("a:", a)
print("b:", b)
print("c:", c)
print("c:", d)

  如何在打印值的时候顺带着打印变量名称呢？这听起来很容易，但其实并非轻而易举！

1.2 工具简介

  Python 内置的 globals()、locals() 函数返还当前的全局信息、局部信息的字典，其中就含有变量名与变量值的键值对，使用值的比较即可确定变量名。
  inspect 是 Python 的内置库，提供了许多有用的函数来获取、检查和操作对象的信息，如 inspect.isclass(obj) 判断对象是否是一个类、inspect.currentframe() 返回当前框架的信息。

二、globals & locals

2.1 全局使用

  在全局范围内使用 globas() 和 locals() 具有相同的效果：

a = {'abc': 123}
b = 456
c = '789'
d = [10, 11, 12]

print('globals:', globals())
print('\nlocals:', locals())
print('\n')
print(globals() == locals())
print(globals() is locals())

  它们的结构都是：

{'__name__': '__main__', 
'__doc__': None,
'__package__': None, 
'__loader__': <_frozen_importlib_external.SourceFileLoader object at 0x000002088A2A4FD0>, 
'__spec__': None, 
'__annotations__': {}, 
'__builtins__': <module 'builtins' (built-in)>, 
'__file__': 'D:\\PycharmProjects\\BERT_pytorch_cpu\\speeding\\var_name_demo.py', '__cached__': None, 
'a': {'abc': 123}, 
'b': 456, 
'c': '789', 
'd': [10, 11, 12]}

  下面我们可以编写函数来实现获取函数名称并打印：

def my_print(x):
    for var_name, var_val in globals().items():
        if var_val is x:
            print(f"{var_name}: {x}")
            return
    print("variable not found!")

a = {'abc': 123}

my_print(a)

注意：此处 “var_val is x” 不能改写为 “var_val == x”
  打印的结果为：

a: {'abc': 123}

  如果将上述函数中的 globals 改为 locals，返回的结果将会是：

x: {'abc': 123}

  这是因为在 my_print 这个函数内，空间已经切换为局部空间，globals 和 locals 已经不再一致！

2.2 局部使用

  在局部空间 f 函数内，打印 globals() 和 locals()：

a = 1

def f():
    a = [2]
    print('globals:', globals())
    print('\nlocals:', locals())
    print('\n')
    print(globals() == locals())
    print(globals() is locals())

f()

  此时 globals() 和 locals() 已经完全不同：

  locals() 此时为：

{'a': [2]}

2.3 内外分工

  在 f() 函数内部可以通过 locals() 返回局部变量 b 的名称，在外部则可以通过 globals() 返回变量 a 的名称：

def globals_print(x):
    for var_name, var_val in globals().items():
        if var_val is x:
            print(f"{var_name}: {x}")
            return
    print("variable not found!")
    return

a = 1

def f():
    def locals_print(x):
        nonlocal local_info
        for var_name, var_val in local_info.items():
            if var_val is x:
                print(f"{var_name}: {x}")
                return
        print("variable not found!")
        return

    b = [2]
    local_info = locals()
    locals_print(b)


f()
globals_print(a)

  此时返回的结果为：

b: [2]
a: 1

  这样内部的变量名 b 通过 locals_print 可以打印， 外部的变量名 a 通过 globals_print 可以打印。
  这样虽然能实现想要的功能，但是 locals_print 是作为内部函数出现的，而且能不能把两个函数融合成一个呢？接下来介绍的 inspect 库能帮上忙！

三、inspect

  inspect 作为 Python 自带的内置库，无需另外安装，可直接 import 导入。

import inspect

def inspect_print(x):
    frame = inspect.currentframe()
    for var_name, var_val in frame.f_back.f_locals.items():
        if var_val is x:
            print(f"{var_name}: {x}")
            return
    print("variable not found!")

a = 1

def f():
    b = [2]
    inspect_print(b)

f()
inspect_print(a)

  这里定义的 inspect_print 函数既可以在全局空间内打印全局变量 a 的名称，又能在局部空间打印局部变量 b 的名称。

b: [2]
a: 1

四、问题

4.1 局部空间缺乏全局变量信息

  上述的 inspect_print 函数在局部空间内无法找到全局变量的信息，如在 局部空间 f() 函数内打印全局变量 a：

def inspect_print(x):
    frame = inspect.currentframe()
    for var_name, var_val in frame.f_back.f_locals.items():
        if var_val is x:
            print(f"{var_name}: {x}")
            return
    print("variable not found!")

a = 1

def f():
    inspect_print(a)

f()

  打印的结果为：

variable not found!

4.2 存在多变量识别错误的风险

  Python 是通过地址来判断 “is” 的，即 “x is y” 为 True 等价于 x 和 y 的地址相同。这样会导致对于多个指向同一地址的变量 x、y，我们无法判断哪一个是 x，哪一个是 y：

import inspect

def inspect_print(x):
    frame = inspect.currentframe()
    for var_name, var_val in frame.f_back.f_locals.items():
        if var_val is x:
            print(f"{var_name}: {x}")
            return
    print("variable not found!")

a = 1
b = 1

inspect_print(a)
inspect_print(b)

  此时的结果为：

a: 1
a: 1

五、完整代码

#!/usr/bin/env python
# -*- coding:utf-8 -*-
# @FileName  : var_name_demo.py
# @Time      : 2024/1/10 16:09
# @Author    : Carl.Zhang
# Function   : var_name_demo


# def my_print(x):
#     for var_name, var_val in globals().items():
#     # for var_name, var_val in locals().items():
#         if var_val is x:
#             print(f"{var_name}: {x}")
#             return
#     print("variable not found!")
#     return

#
#
# a = {'abc': 123}
# b = 456
# c = '789'
# d = [10, 11, 12]
#
# print('globals:', globals())
# print('\nlocals:', locals())
# print('\n')
# print(globals() == locals())
# print(globals() is locals())

# my_print(a)

# _____________________________________________________

# def globals_print(x):
#     for var_name, var_val in globals().items():
#         if var_val is x:
#             print(f"{var_name}: {x}")
#             return
#     print("variable not found!")
#     return
#
#
# a = 1
#
#
# def f():
#     def locals_print(x):
#         nonlocal local_info
#         for var_name, var_val in local_info.items():
#             if var_val is x:
#                 print(f"{var_name}: {x}")
#                 return
#         print("variable not found!")
#         return
#
#     a = [2]
#     local_info = locals()
#     locals_print(a)
#
#
# f()
# globals_print(a)

# _____________________________________________________

import inspect


def inspect_print(x):
    frame = inspect.currentframe()
    for var_name, var_val in frame.f_back.f_locals.items():
        if var_val is x:
            print(f"{var_name}: {x}")
            return
    print("variable not found!")


a = 1


# b = 1
def f():
    c = 1
    inspect_print(c)


f()
inspect_print(a)
# inspect_print(b)

更多 python 的使用方法和应用，敬请关注后续更新~