Python强大的自省机制详解

目录

• 何为自省
• dir()函数
• type()函数和id()函数
• inspect模块
• getmembers(object, predicate=None)函数
• signature(obj, *, follow_wrapped=True)函数
• getmodule(object)函数
• getsource(object)函数
• getsourcelines(object)函数
• ismodule()、isclass()、ismethod()、isfunction()、isgenerator()函数等等
• hasattr()函数和getattr()函数
• 总结

何为自省

在计算机编程领域里，自省是一种能力，是通过一定机制在程序运行时获知对象的类型及对象的内部结构，Python的自省能力还是很强大的，因为Python中一切皆对象，我们不仅可以获取对象的类型，还可以获取对象内部的属性。下面就来介绍一下Python中一些提供强大自省能力的方法。

dir()函数

它是用于自省的最重要的函数之一。它以列表的形式返回一个对象所拥有的全部属性和方法，如果dir()不传任何参数，默认是查找当前命名空间有什么对象。

user = {"nickname": "tigeriaf", "level": 2}
print(dir(user))

执行结果为：

上面的dir()自省输出了一个字典对象的所有方法的名字。当我们记不太清某个对象的某个方法的名字时，使用这个是非常有帮助的。

type()函数和id()函数

type()函数返回一个对象的类型。例如：

print(type('tigeriaf'))
# 结果输出为 <class 'str'>
print(type(2))
# 结果输出为 <class 'int'>
print(type([1, 2, 3]))
# 结果输出为 <class 'list'>

id()函数返回对象的唯一标识符，是一个整数，在CPython中id()函数用于获取对象的内存地址。例如：

print(id('tigeriaf'))

# 结果输出为 51064768

inspect模块

inspect是Python的标准库，提供了更加强大的自省能力，提供了很多函数帮助获取对象的信息，例如模块、类、方法、函数、回溯、帧对象以及代码对象。
该模块提供了4种主要的功能：类型检查、获取源代码、检查类与函数、检查解释器的调用堆栈。下面介绍一下其中的几个常用的方法：

getmembers(object, predicate=None)函数

是基于dir()实现的，返回一个包含对象的所有成员的(name, value)列表。返回的内容比对象的__dict__包含的内容多。predicate是可选的参数，被此函数判断为True的成员才被返回。

例如：

import inspect
print(inspect.getmembers(list))

signature(obj, *, follow_wrapped=True)函数

将返回一个inspect.Signature类型的对象，值为这个函数的所有参数。

getmodule(object)函数

返回定义对象的模块。

getsource(object)函数

返回对象的源代码。

getsourcelines(object)函数

返回一个元组，元组第一项为对象源代码行的列表，第二项是第一行源代码的行号。 例如：

import inspect
def test(a: int):
    print(a)
print(inspect.signature(test))
print(inspect.getmodule(test))
print(inspect.getsource(test))
print(inspect.getsourcelines(test))

执行结果如下：

ismodule()、isclass()、ismethod()、isfunction()、isgenerator()函数等等

一系列判断对象类型的方法，大都是封装了isinstance(object, types.FunctionType)之类语句的函数。

如果平时的开发中对模块、类的操作比较多，那么inspect模块一定要学习一下。

hasattr()函数和getattr()函数

dir()函数会返回某个对象所有属性的列表，但是如果只想测试一个或多个属性是否存在，就需要hasattr()函数和 getattr()函数来完成了，它们的功能分别为判断对象是否有某个属性、获得某个属性值。 例如：

class MyObj:
    def __init__(self):
        self.name = 'my_obj'
        self.a = 1
        self.b = [1, 2, 3]
myobj = MyObj()
print(getattr(myobj, "name"))
print(getattr(myobj, "b"))
print(hasattr(myobj, "a"))
print(hasattr(myobj, "c"))

执行结果为：

总结

其实Python对自省有着很大的支持，Python中还有很多这里没提到的其他方法也能有助于自省，有兴趣的话，你会慢慢发现它们的。

本篇文章就到这里了，希望能够给你带来帮助，也希望您能够多多关注我们的更多内容!