Python 中類的構造方法 __New__ 的妙用
Python 的類中,所有以雙下劃線__包起來的方法,叫魔術方法,魔術方法在類或對象的某些事件發出后可以自動執行,讓類具有神奇的魔力,比如常見的構造方法__new__、初始化方法__init__、析構方法__del__,今天來聊一聊__new__的妙用,主要分享以下幾點:
- __new__ 和 __init__ 的區別
- 應用1:改變內置的不可變類型
- 應用2:實現一個單例
- 應用3:客戶端緩存
- 應用4:不同文件不同的解密方法
- 應用5:Metaclasses
__new__ 和 __init__ 的區別
1、調用時機不同:new 是真正創建實例的方法,init 用于實例的初始化,new 先于 init 運行。
2、返回值不同,new 返回一個類的實例,而 init 不返回任何信息。
3、new 是 class 的方法,而 init 是對象的方法。
示例代碼:
- class A:
- def __new__(cls, *args, **kwargs):
- print("new", cls, args, kwargs)
- return super().__new__(cls)
- def __init__(self, *args, **kwargs):
- print("init", self, args, kwargs)
- def how_object_construction_works():
- x = A(1, 2, 3, x=4)
- print(x)
- print("===================")
- x = A.__new__(A, 1, 2, 3, x=4)
- if isinstance(x, A):
- type(x).__init__(x, 1, 2, 3, x=4)
- print(x)
- if __name__ == "__main__":
- how_object_construction_works()
上述代碼定義了一個類 A,在調用 A(1, 2, 3, x=4) 時先執行 new,再執行 init,等價于:
- x = A.__new__(A, 1, 2, 3, x=4)
- if isinstance(x, A):
- type(x).__init__(x, 1, 2, 3, x=4)
代碼的運行結果如下:
- new <class '__main__.A'> (1, 2, 3) {'x': 4}
- init <__main__.A object at 0x7fccaec97610> (1, 2, 3) {'x': 4}
- <__main__.A object at 0x7fccaec97610>
- ===================
- new <class '__main__.A'> (1, 2, 3) {'x': 4}
- init <__main__.A object at 0x7fccaec97310> (1, 2, 3) {'x': 4}
- <__main__.A object at 0x7fccaec97310>
new 的主要作用就是讓程序員可以自定義類的創建行為,以下是其主要應用場景:
應用1:改變內置的不可變類型
我們知道,元組是不可變類型,但是我們繼承 tuple ,然后可以在 new 中,對其元組的元素進行修改,因為 new 返回之前,元組還不是元組,這在 init 函數中是無法實現的。比如說,實現一個大寫的元組,代碼如下:
- class UppercaseTuple(tuple):
- def __new__(cls, iterable):
- upper_iterable = (s.upper() for s in iterable)
- return super().__new__(cls, upper_iterable)
- # 以下代碼會報錯,初始化時是無法修改的
- # def __init__(self, iterable):
- # print(f'init {iterable}')
- # for i, arg in enumerate(iterable):
- # self[i] = arg.upper()
- if __name__ == '__main__':
- print("UPPERCASE TUPLE EXAMPLE")
- print(UppercaseTuple(["hello", "world"]))
- # UPPERCASE TUPLE EXAMPLE
- # ('HELLO', 'WORLD')
應用2:實現一個單例
- class Singleton:
- _instance = None
- def __new__(cls, *args, **kwargs):
- if cls._instance is None:
- cls._instance = super().__new__(cls, *args, **kwargs)
- return cls._instance
- if __name__ == "__main__":
- print("SINGLETON EXAMPLE")
- x = Singleton()
- y = Singleton()
- print(f"{x is y=}")
- # SINGLETON EXAMPLE
- # x is y=True
應用3:客戶端緩存
當客戶端的創建成本比較高時,比如讀取文件或者數據庫,可以采用以下方法,同一個客戶端屬于同一個實例,節省創建對象的成本,這本質就是多例模式。
- class Client:
- _loaded = {}
- _db_file = "file.db"
- def __new__(cls, client_id):
- if (client := cls._loaded.get(client_id)) is not None:
- print(f"returning existing client {client_id} from cache")
- return client
- client = super().__new__(cls)
- cls._loaded[client_id] = client
- client._init_from_file(client_id, cls._db_file)
- return client
- def _init_from_file(self, client_id, file):
- # lookup client in file and read properties
- print(f"reading client {client_id} data from file, db, etc.")
- name = ...
- email = ...
- self.name = name
- self.email = email
- self.id = client_id
- if __name__ == '__main__':
- print("CLIENT CACHE EXAMPLE")
- x = Client(0)
- y = Client(0)
- print(f"{x is y=}")
- z = Client(1)
- # CLIENT CACHE EXAMPLE
- # reading client 0 data from file, db, etc.
- # returning existing client 0 from cache
- # x is y=True
- # reading client 1 data from file, db, etc.
應用4:不同文件不同的解密方法
先在腳本所在目錄創建三個文件:plaintext_hello.txt、rot13_hello.txt、otp_hello.txt,程序會根據不同的文件選擇不同的解密算法
- import codecs
- import itertools
- class EncryptedFile:
- _registry = {} # 'rot13' -> ROT13Text
- def __init_subclass__(cls, prefix, **kwargs):
- super().__init_subclass__(**kwargs)
- cls._registry[prefix] = cls
- def __new__(cls, path: str, key=None):
- prefix, sep, suffix = path.partition(":///")
- if sep:
- file = suffix
- else:
- file = prefix
- prefix = "file"
- subclass = cls._registry[prefix]
- obj = object.__new__(subclass)
- obj.file = file
- obj.key = key
- return obj
- def read(self) -> str:
- raise NotImplementedError
- class Plaintext(EncryptedFile, prefix="file"):
- def read(self):
- with open(self.file, "r") as f:
- return f.read()
- class ROT13Text(EncryptedFile, prefix="rot13"):
- def read(self):
- with open(self.file, "r") as f:
- text = f.read()
- return codecs.decode(text, "rot_13")
- class OneTimePadXorText(EncryptedFile, prefix="otp"):
- def __init__(self, path, key):
- if isinstance(self.key, str):
- self.key = self.key.encode()
- def xor_bytes_with_key(self, b: bytes) -> bytes:
- return bytes(b1 ^ b2 for b1, b2 in zip(b, itertools.cycle(self.key)))
- def read(self):
- with open(self.file, "rb") as f:
- btext = f.read()
- text = self.xor_bytes_with_key(btext).decode()
- return text
- if __name__ == "__main__":
- print("ENCRYPTED FILE EXAMPLE")
- print(EncryptedFile("plaintext_hello.txt").read())
- print(EncryptedFile("rot13:///rot13_hello.txt").read())
- print(EncryptedFile("otp:///otp_hello.txt", key="1234").read())
- # ENCRYPTED FILE EXAMPLE
- # plaintext_hello.txt
- # ebg13_uryyb.gkg
- # ^FCkYW_X^GLE
應用5:Metaclasses
metaclass 可以像裝飾器那樣定制和修改繼承它的子類,前文Python黑魔法之metaclass
本文轉載自微信公眾號「Python七號」,可以通過以下二維碼關注。轉載本文請聯系Python七號公眾號。