Python 的内置函数 vars

于日常开发期间，我们时常会有这样的需求，即迅速查看某一对象内容之中具备哪些属性以及与之对应的那些值。而恰好，Python里面内置的vars()函数就是用以解决此项需求的有效工具，它能够以字典的形式清晰明确地展示出对象的属性结构。熟悉并掌握这个函数，能够使你的调试效率得到显著的提升。

无参数调用查看当前局部变量

你不给vars()传入任何参数的情况下，它会返回当前所在函数局部作用域内的所有变量，这个功能在函数内部调试时特别有用，能一目了然看清当前有哪些局部变量以及它们的值 ，像在一个函数中间调用vars()，就能看到所有已定义参数和中间变量的快照。

于实际开发里头，此特性常常被用于迅速定位变量值出现异常的状况。假定你正处理一个数据处理函数，发觉中间结果有错误，在关键之处插入print(vars())便能够马上瞧见当下所有局部变量的状态。相较于逐个去打印变量，这般的方式更为高效且全面。

def example():
    x = 10
    y = 20
    print(vars())  # 输出局部变量字典 {'x': 10, 'y': 20}
example()

传入对象参数获取实例属性

将一个对象当作参数传递给vars()时，它会返回该对象的__dict__属性，此即这个对象实例所有属性所构成的字典，这个 Dictionary 里头，每个属性名作为键，属性值作为值，这对理解对象当下的状态极有帮助。

class MyClass:
    def __init__(self):
        self.a = 1
        self.b = 2
obj = MyClass()
print(vars(obj))  # 输出 {'a': 1, 'b': 2}

假设你拥有一个具备用户信息类特征的实例存在，其涵盖了姓名、年龄、邮箱等众多元素作为特有的属性，一旦执行vars(user)此行为，便能够获取到一个完整无缺的属性构造的字典。该字典属于动态性质的，在你对对象的属性实施了修改操作之后，再次去调用vars()这个做法，就可以目睹到更新过后的最终呈现结果。这样的一种实时性特质，使得vars()摇身一变成为动态调试过程当中的得力助手。

开发调试中的实际应用

于代码调试进程里，vars()能够使你迅速查看对象内部状况，而无需撰写诸多打印语句。当程序运行至某一断点处时，于交互式环境内直接输入vars(obj)便可看到全部属性。这较运用IDE的属性面板更为直观，因为你能够直接复制字典内容予以分析。

class Debuggable:
    def __init__(self, **kwargs):
        for k, v in kwargs.items():
            setattr(self, k, v)
    def show_state(self):
        print(vars(self))
dbg = Debuggable(name="test", value=100)
dbg.show_state()  # 输出 {'name': 'test', 'value': 100}

当处理第三方库返回的复杂对象之际，vars()的价值愈发显著，你无需去翻阅文档以了解该对象具备哪些属性，只需直接调用vars()，便能看到所有可用的属性名称以及当前值，这极大地降低了探索陌生代码库的学习成本，特别是在接手遗留项目之时。

动态属性管理的配合使用

有这样一种情况，vars()返回的那个字典，它是对于原对象属性所进行存储的真实引用，这其实就意味着，你能够直接去修改这样的一个字典，以此来改变对象的属性。然后呢，把getattr()和setattr()函数结合起来，你就能够实现极为灵活的动态属性操作。比如说，依据用户输入的字符串，动态地对对象的某个属性进行读取或者修改。

config = type('Config', (), {})()
vars(config)['timeout'] = 30  # 等价于 config.timeout = 30

当编写通用框架或者插件系统之际，这样一种动态特性，其用处极大。能够遍历经由vars(obj)返回的字典，针对特定类型的属性予以批量处理，举例来说，将所有属于字符串类型的属性值，全部转换为小写。相较于硬编码属性名这个方式，此种动态途径，使得代码更具通用性，更易于维护。

序列化前的数据准备

import json
data = vars(obj)  # 获取对象属性字典
json_str = json.dumps(data)  # 序列化为JSON

当把对象转变为JSON或者别的格式用以存储或者传输之际，vars()能够助你迅速获取到那需要被序列化的数据。直接去调用vars(obj)从而获取到属性字典之后，就能够把它交予json.dumps()去予以处理。跟manual构建字典相比较而言，此种方式不但简洁而且不容易出现遗漏属性的情况。

应当留意的是，vars()仅仅会返回实例属性，不会涵盖类属性或者方法。要是你所拥有的对象含有嵌套对象或者存在需要进行序列化的特殊类型时，则有可能还得进行递归处理。然而在绝大多数的简单数据容器类场景当中，vars()与序列化库搭配使用已然足够高效且便利。

底层实现与使用限制

若从底层实现方面来看的话，vars()实际上就是去调用了对象的__dict__ 属性，在Python里大多数自定义类的实例都会自动地去维护这个字典，以此来存储实例属性，然而直接利用vars()相较于去访问__dict__ 而言，更契合Python的优雅风格，并且代码的可读性也是更好的。

不过要留意，不是所有对象都能支持vars()操作。要是有个类定义了__slots__属性去优化内存使用，那这个类的实例就不存在__dict__属性，调用vars()就会抛出TypeError异常此外，像int、list、str等内置类型也没有__dict__属性，同样没办法使用vars()。

哪些场景之中你曾运用过vars()函数？是否碰到过因__slots__致使vars()没法发挥其功效的情形？欢迎在评论的区域分享你运用的经历，也千万不要忘记点赞并且转发给更多的Python开发者！

相关标签： # Python # 内置函数 # vars() # __dict__ # 动态属性