获取对象信息

廖雪峰 ... 2021-03-28 Python 大约 5 分钟

当我们拿到一个对象的引用时,如何知道这个对象是什么类型、有哪些方法呢?

# 使用 type()

首先,我们来判断对象类型,使用 type() 函数:

基本类型都可以用 type() 判断:

>>> type(123)
<class 'int'>
>>> type('str')
<class 'str'>
>>> type(None)
<type(None) 'NoneType'>
1
2
3
4
5
6

如果一个变量指向函数或者类,也可以用 type() 判断:

>>> type(abs)
<class 'builtin_function_or_method'>
>>> type(a)
<class '__main__.Animal'>
1
2
3
4

但是 type() 函数返回的是什么类型呢?它返回对应的 Class 类型。如果我们要在 if 语句中判断,就需要比较两个变量的 type 类型是否相同:

>>> type(123)==type(456)
True
>>> type(123)==int
True
>>> type('abc')==type('123')
True
>>> type('abc')==str
True
>>> type('abc')==type(123)
False
1
2
3
4
5
6
7
8
9
10

判断基本数据类型可以直接写 intstr 等,但如果要判断一个对象是否是函数怎么办?可以使用 types 模块中定义的常量:

>>> import types
>>> def fn():
...     pass
...
>>> type(fn)==types.FunctionType
True
>>> type(abs)==types.BuiltinFunctionType
True
>>> type(lambda x: x)==types.LambdaType
True
>>> type((x for x in range(10)))==types.GeneratorType
True
1
2
3
4
5
6
7
8
9
10
11
12

# 使用 isinstance()

对于 class 的继承关系来说,使用 type() 就很不方便。我们要判断 class 的类型,可以使用 isinstance() 函数。

我们回顾上次的例子,如果继承关系是:

object -> Animal -> Dog -> Husky
1

那么,isinstance() 就可以告诉我们,一个对象是否是某种类型。先创建 3 种类型的对象:

>>> a = Animal()
>>> d = Dog()
>>> h = Husky()
1
2
3

然后,判断:

>>> isinstance(h, Husky)
True
1
2

没有问题,因为 h 变量指向的就是 Husky 对象。

再判断:

>>> isinstance(h, Dog)
True
1
2

h 虽然自身是 Husky 类型,但由于 Husky 是从 Dog 继承下来的,所以,h 也还是 Dog 类型。换句话说,isinstance() 判断的是一个对象是否是该类型本身,或者位于该类型的父继承链上。

因此,我们可以确信,h 还是 Animal 类型:

>>> isinstance(h, Animal)
True
1
2

同理,实际类型是 Dogd 也是 Animal 类型:

>>> isinstance(d, Dog) and isinstance(d, Animal)
True
1
2

但是,d 不是 Husky 类型:

>>> isinstance(d, Husky)
False
1
2

能用 type() 判断的基本类型也可以用 isinstance() 判断:

>>> isinstance('a', str)
True
>>> isinstance(123, int)
True
>>> isinstance(b'a', bytes)
True
1
2
3
4
5
6

并且还可以判断一个变量是否是某些类型中的一种,比如下面的代码就可以判断是否是 list 或者 tuple:

>>> isinstance([1, 2, 3], (list, tuple))
True
>>> isinstance((1, 2, 3), (list, tuple))
True
1
2
3
4

提示

总是优先使用 isinstance() 判断类型,可以将指定类型及其子类“一网打尽”。

# 使用 dir()

如果要获得一个对象的所有属性和方法,可以使用 dir() 函数,它返回一个包含字符串的 list,比如,获得一个 str 对象的所有属性和方法:

>>> dir('ABC')
['__add__', '__class__',..., '__subclasshook__', 'capitalize', 'casefold',..., 'zfill']
1
2

类似 __xxx__ 的属性和方法在 Python 中都是有特殊用途的,比如 __len__ 方法返回长度。在 Python 中,如果你调用 len() 函数试图获取一个对象的长度,实际上,在 len()函数内部,它自动去调用该对象的 __len__() 方法,所以,下面的代码是等价的:

>>> len('ABC')
3
>>> 'ABC'.__len__()
3
1
2
3
4

我们自己写的类,如果也想用 len(myObj) 的话,就自己写一个 __len__() 方法:

>>> class MyDog(object):
...     def __len__(self):
...         return 100
...
>>> dog = MyDog()
>>> len(dog)
100
1
2
3
4
5
6
7

剩下的都是普通属性或方法,比如 lower() 返回小写的字符串:

>>> 'ABC'.lower()
'abc'
1
2

仅仅把属性和方法列出来是不够的,配合 getattr()setattr() 以及 hasattr(),我们可以直接操作一个对象的状态:

>>> class MyObject(object):
...     def __init__(self):
...         self.x = 9
...     def power(self):
...         return self.x * self.x
...
>>> obj = MyObject()
1
2
3
4
5
6
7

紧接着,可以测试该对象的属性:

>>> hasattr(obj, 'x') # 有属性'x'吗?
True
>>> obj.x
9
>>> hasattr(obj, 'y') # 有属性'y'吗?
False
>>> setattr(obj, 'y', 19) # 设置一个属性'y'
>>> hasattr(obj, 'y') # 有属性'y'吗?
True
>>> getattr(obj, 'y') # 获取属性'y'
19
>>> obj.y # 获取属性'y'
19
1
2
3
4
5
6
7
8
9
10
11
12
13

如果试图获取不存在的属性,会抛出 AttributeError 的错误:

>>> getattr(obj, 'z') # 获取属性'z'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'MyObject' object has no attribute 'z'
1
2
3
4

可以传入一个 default 参数,如果属性不存在,就返回默认值:

>>> getattr(obj, 'z', 404) # 获取属性'z',如果不存在,返回默认值404
404
1
2

也可以获得对象的方法:

>>> hasattr(obj, 'power') # 有属性'power'吗?
True
>>> getattr(obj, 'power') # 获取属性'power'
<bound method MyObject.power of <__main__.MyObject object at 0x10077a6a0>>
>>> fn = getattr(obj, 'power') # 获取属性'power'并赋值到变量fn
>>> fn # fn指向obj.power
<bound method MyObject.power of <__main__.MyObject object at 0x10077a6a0>>
>>> fn() # 调用fn()与调用obj.power()是一样的
81
1
2
3
4
5
6
7
8
9

# 小结

通过内置的一系列函数,我们可以对任意一个 Python 对象进行剖析,拿到其内部的数据。要注意的是,只有在不知道对象信息的时候,我们才会去获取对象信息。如果可以直接写:

sum = obj.x + obj.y
1

就不要写:

sum = getattr(obj, 'x') + getattr(obj, 'y')
1

一个正确的用法的例子如下:

def readImage(fp):
    if hasattr(fp, 'read'):
        return readData(fp)
    return None
1
2
3
4

假设我们希望从文件流 fp 中读取图像,我们首先要判断该 fp 对象是否存在 read 方法,如果存在,则该对象是一个流,如果不存在,则无法读取。hasattr() 就派上了用场。

请注意,在 Python 这类动态语言中,根据鸭子类型,有 read() 方法,不代表该 fp 对象就是一个文件流,它也可能是网络流,也可能是内存中的一个字节流,但只要 read() 方法返回的是有效的图像数据,就不影响读取图像的功能。