Python object類(lèi)中的特殊方法代碼講解

更新時(shí)間：2020年03月06日 08:45:30 作者：風(fēng)間悠香

在本篇文章里小編給各位整理了關(guān)于Python object類(lèi)中的特殊方法代碼講解，需要的朋友們可以參考下。

python版本：3.8

class object:
 """ The most base type """

 # del obj.xxx或delattr(obj,'xxx')時(shí)被調(diào)用，刪除對(duì)象中的一個(gè)屬性
 def __delattr__(self, *args, **kwargs): # real signature unknown
 """ Implement delattr(self, name). """
 pass

 # 對(duì)應(yīng)dir(obj)，返回一個(gè)列表，其中包含所有屬性和方法名（包含特殊方法）
 def __dir__(self, *args, **kwargs): # real signature unknown
 """ Default dir() implementation. """
 pass

 # 判斷是否相等 equal ，在obj==other時(shí)調(diào)用。如果重寫(xiě)了__eq__方法，則會(huì)將__hash__方法置為None
 def __eq__(self, *args, **kwargs): # real signature unknown
 """ Return self==value. """
 pass

 # format(obj)是調(diào)用，實(shí)現(xiàn)如何格式化obj對(duì)象為字符串
 def __format__(self, *args, **kwargs): # real signature unknown
 """ Default object formatter. """
 pass

 # getattr(obj,'xxx')、obj.xxx時(shí)都會(huì)被調(diào)用，當(dāng)屬性存在時(shí)，返回值，不存在時(shí)報(bào)錯(cuò)（除非重寫(xiě)__getattr__方法來(lái)處理）。
 # 另外，hasattr(obj,'xxx')時(shí)也會(huì)被調(diào)用（估計(jì)內(nèi)部執(zhí)行了getattr方法）
 def __getattribute__(self, *args, **kwargs): # real signature unknown
 """ Return getattr(self, name). """
 pass

 # 判斷是否大于等于 greater than or equal，在obj>=other時(shí)調(diào)用
 def __ge__(self, *args, **kwargs): # real signature unknown
 """ Return self>=value. """
 pass

 # 判斷是否大于 greater than，在obj>other時(shí)調(diào)用
 def __gt__(self, *args, **kwargs): # real signature unknown
 """ Return self>value. """
 pass

 # 調(diào)用hash(obj)獲取對(duì)象的hash值時(shí)調(diào)用
 def __hash__(self, *args, **kwargs): # real signature unknown
 """ Return hash(self). """
 pass

 def __init_subclass__(self, *args, **kwargs): # real signature unknown
 """
 This method is called when a class is subclassed.

 The default implementation does nothing. It may be
 overridden to extend subclasses.
 """
 pass

 # object構(gòu)造函數(shù)，當(dāng)子類(lèi)沒(méi)有構(gòu)造函數(shù)時(shí)，會(huì)調(diào)用object的__init__構(gòu)造函數(shù)
 def __init__(self): # known special case of object.__init__
 """ Initialize self. See help(type(self)) for accurate signature. """
 pass

 # 判斷是否小于等于 less than or equal，在obj<=other時(shí)調(diào)用
 def __le__(self, *args, **kwargs): # real signature unknown
 """ Return self<=value. """
 pass

 # 判斷是否小于 less than，在obj<other時(shí)調(diào)用
 def __lt__(self, *args, **kwargs): # real signature unknown
 """ Return self<value. """
 pass

 # 創(chuàng)建一個(gè)cls類(lèi)的對(duì)象，并返回
 @staticmethod # known case of __new__
 def __new__(cls, *more): # known special case of object.__new__
 """ Create and return a new object. See help(type) for accurate signature. """
 pass

 # 判斷是否不等于 not equal,在obj!=other時(shí)調(diào)用
 def __ne__(self, *args, **kwargs): # real signature unknown
 """ Return self!=value. """
 pass

 def __reduce_ex__(self, *args, **kwargs): # real signature unknown
 """ Helper for pickle. """
 pass

 def __reduce__(self, *args, **kwargs): # real signature unknown
 """ Helper for pickle. """
 pass

 # 如果不重寫(xiě)__str__，則__repr__負(fù)責(zé)print(obj)和交互式命令行中輸出obj的信息
 # 如果重寫(xiě)了__str__，則__repr__只負(fù)責(zé)交互式命令行中輸出obj的信息
 def __repr__(self, *args, **kwargs): # real signature unknown
 """ Return repr(self). """
 pass

 # 使用setattr(obj,'xxx',value)、obj.xxx=value是被調(diào)用（注意，構(gòu)造函數(shù)初始化屬性也要調(diào)用）
 def __setattr__(self, *args, **kwargs): # real signature unknown
 """ Implement setattr(self, name, value). """
 pass

 # 獲取對(duì)象內(nèi)存大小
 def __sizeof__(self, *args, **kwargs): # real signature unknown
 """ Size of object in memory, in bytes. """
 pass

 # 設(shè)置print(obj)打印的信息，默認(rèn)是對(duì)象的內(nèi)存地址等信息
 def __str__(self, *args, **kwargs): # real signature unknown
 """ Return str(self). """
 pass

 @classmethod # known case
 def __subclasshook__(cls, subclass): # known special case of object.__subclasshook__
 """
 Abstract classes can override this to customize issubclass().

 This is invoked early on by abc.ABCMeta.__subclasscheck__().
 It should return True, False or NotImplemented. If it returns
 NotImplemented, the normal algorithm is used. Otherwise, it
 overrides the normal algorithm (and the outcome is cached).
 """
 pass
 # 某個(gè)對(duì)象是由什么類(lèi)創(chuàng)建的，如果是object，則是type類(lèi)<class 'type'>
 __class__ = None
 # 將對(duì)象中所有的屬性放入一個(gè)字典，例如{'name':'Leo','age':32}
 __dict__ = {}
 # 類(lèi)的doc信息
 __doc__ = ''
 # 類(lèi)屬于的模塊,如果是在當(dāng)前運(yùn)行模塊，則是__main__，如果是被導(dǎo)入，則是模塊名（即py文件名去掉.py）
 __module__ = ''

二、常用特殊方法解釋

1.__getattribute__方法

1）什么時(shí)候被調(diào)用

這個(gè)特殊方法是在我們使用類(lèi)的對(duì)象進(jìn)行obj.屬性名或getattr(obj,屬性名)來(lái)取對(duì)象屬性的值的時(shí)候被調(diào)用。例如：

class Foo(object):
 def __init__(self):
 self.name = 'Alex'

 def __getattribute__(self, item):
 print("__getattribute__ in Foo")
 return object.__getattribute__(self, item)


if __name__ == '__main__':
 f = Foo()
 print(f.name) # name屬性存在 或者 getattr(f,name)
 print(f.age) # age屬性不存在

不管屬性是否存在，__getattribute__方法都會(huì)被調(diào)用。如果屬性存在，則返回該屬性的值，如果屬性不存在，則返回None。

注意，我們?cè)谑褂胔asattr(obj,屬性名)來(lái)判斷某個(gè)屬性是否存在時(shí)，__getattribute__方法也會(huì)被調(diào)用。

2）與__getattr__的區(qū)別

我們?cè)陬?lèi)的實(shí)現(xiàn)中，可以重寫(xiě)__getattr__方法，那么__getattr__方法和__getattribute__方法有什么區(qū)別？

我們知道__getattribute__方法不管屬性是否存在，都會(huì)被調(diào)用。而__getattr__只在屬性不存在時(shí)調(diào)用，默認(rèn)會(huì)拋出 AttributeError: 'Foo' object has no attribute 'age' 這樣的錯(cuò)誤，但我們可以對(duì)其進(jìn)行重寫(xiě)，做我們需要的操作：

class Foo(object):
 def __init__(self):
 self.name = 'Alex'

 def __getattribute__(self, item):
 print("__getattribute__ in Foo")
 return object.__getattribute__(self, item)

 def __getattr__(self, item):
 print("%s不存在,但我可以返回一個(gè)值" % item)
 return 54


if __name__ == '__main__':
 f = Foo()
 print(f.name) # name屬性存在
 print(f.age) # age屬性不存在,但__getattr__方法返回了54，所以這里打印54。

返回結(jié)果：

__getattribute__ in Foo
Alex
__getattribute__ in Foo
age不存在,但我可以返回一個(gè)值
54

我們看到，f.name和f.age都調(diào)用了__getattribute__方法，但是只有f.age時(shí)調(diào)用了__getattr__方法。所以，我們可以利用__getattr__做很多事情，例如從類(lèi)中的一個(gè)字典中取值，或者處理異常等。

2.__setattr__方法

當(dāng)我們執(zhí)行obj.name='alex'或setattr(obj,屬性名,屬性值)，即為屬性賦值時(shí)被調(diào)用。

class Foo(object):
 def __init__(self):
  self.name = 'Alex'

 # obj.xxx = value時(shí)調(diào)用
 def __setattr__(self, key, value):
  print('setattr')
  return object.__setattr__(self, key, value)


if __name__ == '__main__':
 f = Foo()
 f.name = 'Jone' # 打印setattr
 print(f.name)

如果__setattr__被重寫(xiě)（不調(diào)用父類(lèi)__setattr__的話）。則使用obj.xxx=value賦值就無(wú)法工作了。

特別注意，在類(lèi)的構(gòu)造函數(shù)中對(duì)屬性進(jìn)行初始化賦值時(shí)也是調(diào)用了該方法：

class Foo(object):
 def __init__(self):
  self.name = 'Alex' # 這里也要調(diào)用__setattr__
　　...

當(dāng)我們需要重寫(xiě)__setattr__方法的時(shí)候，就要注意初始化時(shí)要使用object類(lèi)的__setattr__來(lái)初始化：

class Local(object):
 def __init__(self):
  # 這里不能直接使用self.DIC={}，因?yàn)開(kāi)_setattr__被重寫(xiě)了
  object.__setattr__(self, 'DIC', {})

 def __setattr__(self, key, value):
  self.DIC[key] = value

 def __getattr__(self, item):
  return self.DIC.get(item, None)


if __name__ == '__main__':
 obj = Local()
 obj.name = 'Alex' # 向DIC字典中存入值
 print(obj.name) # 從DIC字典中取出值

3.__delattr__方法

這個(gè)方法對(duì)應(yīng)del obj.屬性名和delattr(obj,屬性名)兩種操作時(shí)被調(diào)用。即，刪除對(duì)象中的某個(gè)屬性。

if hasattr(f,'xxx'): # 判斷f對(duì)象中是否存在屬性xxx
 delattr(f, 'xxx') # 如果存在則刪除。當(dāng)xxx不存在時(shí)刪除會(huì)報(bào)錯(cuò)
 # del f.xxx # 同上

4.__dir__方法

對(duì)應(yīng)dir(obj)獲取對(duì)象中所有的屬性名，包括所有的屬性和方法名。

f = Foo()
print(f.__dir__()) # ['name', '__module__', '__init__', '__setattr__', '__getattribute__', '__dir__', '__dict__', '__weakref__', '__doc__', '__repr__', '__hash__', '__str__', '__delattr__', '__lt__', '__le__', '__eq__', '__ne__', '__gt__', '__ge__', '__new__', '__reduce_ex__', '__reduce__', '__subclasshook__', '__init_subclass__', '__format__', '__sizeof__', '__class__']

返回一個(gè)列表。

5.__eq__和__hash__

__eq__是判斷obj==other的時(shí)候調(diào)用的，默認(rèn)調(diào)用的是object繼承下去的__eq__。

f1 = Foo()
f2 = f1
print(f1 == f2) # True
print(f1 is f2) # True
print(hash(f1) == hash(f2)) # True

默認(rèn)情況下，f1 == f2,f1 is f2,hash(f1)==hash(f2)都應(yīng)該同時(shí)為T(mén)rue（或不相等，同為False）。

如果我們重寫(xiě)了__eq__方法，例如兩個(gè)對(duì)象的比較變成比較其中的一個(gè)屬性：

class Foo(object):
 def __init__(self):
  self.name = 'Alex' # 這里也要調(diào)用__
  self.ccc = object.__class__
 def __eq__(self, other):
  return self.name==other.name

即，如果self.name==other.name，則認(rèn)為對(duì)象相等。

f1 = Foo()
f2 = Foo()
print(f1 == f2) # True
print(f1 is f2) # False
print(hash(f1) == hash(f2)) # 拋出異常TypeError錯(cuò)誤

為什么hash會(huì)拋出異常，這是因?yàn)槿绻覀冊(cè)谀硞€(gè)類(lèi)中重寫(xiě)了__eq__方法，則默認(rèn)會(huì)將__hash__=None。所以，當(dāng)我們調(diào)用hash(obj)時(shí)，__hash__方法無(wú)法執(zhí)行。

總結(jié)：

當(dāng)我們實(shí)現(xiàn)的類(lèi)想成為不可hash的類(lèi)，則可以重寫(xiě)__eq__方法，然后不重寫(xiě)__hash__，__hash__方法會(huì)被置None，該類(lèi)的對(duì)象就不可hash了。

默認(rèn)提供的__hash__方法（hash(obj)）對(duì)于值相同的變量（類(lèi)型有限制，有些類(lèi)型不能hash，例如List），同解釋器下hash值相同，而不同解釋器下hash值不同。所以，如果我們想要hash一個(gè)目標(biāo)，應(yīng)該使用hashlib模塊。

hash和id的區(qū)別，理論上值相同的兩個(gè)對(duì)象hash值應(yīng)該相同，而id可能不同（必須是同一個(gè)對(duì)象，即內(nèi)存地址相同，id才相同。id(obj)是obj的唯一標(biāo)識(shí)。）

6.__gt__、__lt__、__ge__、__le__

這幾個(gè)都是用于比較大小的，我們可以對(duì)其進(jìn)行重寫(xiě)，來(lái)自定義對(duì)象如何比較大?。ɡ缰槐容^對(duì)象中其中一個(gè)屬性的值）。

7.__str__和__repr__

__str__用于定義print(obj)時(shí)打印的內(nèi)容。

class Foo(object):
 def __init__(self):
  self.name = 'Alex'

 def __str__(self):
  return "我是Foo"


if __name__ == '__main__':
 f1 = Foo()
 print(f1) # 打印 我是Foo

在命令行下：

>>> class Foo(object):
...  def __str__(self):
...    return "我是Foo"
...
>>> f1 = Foo()
>>> print(f1)
我是Foo
>>> f1
<__main__.Foo object at 0x0000023BF701C550>

可以看到，使用__str__的話，print可以打印我們指定的值，而命令行輸出則是對(duì)象的內(nèi)存地址。

__repr__用于同時(shí)定義python命令行輸出obj的內(nèi)容，以及print(obj)的打印內(nèi)容（前提是沒(méi)有重寫(xiě)__str__）。

class Foo(object):
 def __init__(self):
  self.name = 'Alex'

 def __repr__(self):
  return "我是Foo"


if __name__ == '__main__':
 f1 = Foo()
 print(f1) # 打印 我是Foo

在命令行下：

>>> class Foo(object):
...  def __repr__(self):
...    return "我是Foo"
...
>>> f1 = Foo()
>>> print(f1)
我是Foo
>>> f1
我是Foo

可以看到，我們只重寫(xiě)了__repr__，但是print和直接輸出都打印了我們指定的值。

當(dāng)我們同時(shí)重寫(xiě)__str__和__repr__時(shí)：

>>> class Foo():
...  def __str__(self):
...    return "我是Foo---str"
...  def __repr__(self):
...    return "我是Foo---repr"
...
>>> f1 = Foo()
>>> print(f1)
我是Foo---str
>>> f1
我是Foo---repr

可以看到，在同時(shí)重寫(xiě)兩個(gè)方法時(shí)，__str__負(fù)責(zé)print的信息，而__repr__負(fù)責(zé)命令行直接輸出的信息。

8.__new__方法

9.__sizeof__方法

10.__class__、__dict__、__module__、__doc__屬性

__class__：返回該生成該對(duì)象的類(lèi)

print(f1.__class__) # <class '__main__.Foo'>

__dict__：返回該對(duì)象的所有屬性組成的字典

print(f1.__dict__) # {'name': 'Alex'} 只有一個(gè)屬性name

__module__：返回該對(duì)象所處模塊

class Foo(object):
 def __init__(self):
  self.name = 'Alex'


if __name__ == '__main__':
 f1 = Foo()
 print(f1.__module__) # 打印__main__

如果該對(duì)象對(duì)應(yīng)的類(lèi)在當(dāng)前運(yùn)行的模塊，則打印__main__。

import test3

f = test3.Foo()
print(f.__module__) # 打印test3

如果對(duì)象對(duì)應(yīng)的類(lèi)在其他模塊，則打印模塊名。

__doc__：類(lèi)的注釋

class Foo(object):
 """
 這是一個(gè)類(lèi)，名叫Foo
 """
 def __init__(self):
  self.name = 'Alex'


if __name__ == '__main__':
 f1 = Foo()
 print(f1.__doc__) # 打印 這是一個(gè)類(lèi)，名叫Foo

到此這篇關(guān)于Python object類(lèi)中的特殊方法代碼講解的文章就介紹到這了,更多相關(guān)Python object類(lèi)中的特殊方法內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: