Python中class內置方法__init__與__new__作用與區別探究

来源:https://www.cnblogs.com/AcAc-t/archive/2022/09/25/python_builtint_new_init_meaning.html
-Advertisement-
Play Games

七牛雲文件上傳 @RequestMapping("/upload") public Result upload(MultipartFile imgFile) { try { //獲取原始文件名 String originalFilename = imgFile.getOriginalFilename ...


背景

最近嘗試瞭解Django中ORM實現的原理,發現其用到了metaclass(元類)這一技術,進一步又涉及到Python class中有兩個特殊內置方法__init__與__new__,決定先嘗試探究一番兩者的具體作用與區別。
PS: 本文中涉及的類均為Python3中預設的新式類,對應Python2中則為顯式繼承了object的class,因為未繼承object基類的舊式類並沒有這些內置方法。

__init__方法作用

凡是使用Python自定義過class就必然要和__init__方法打交道,因為class實例的初始化工作即由該函數負責,實例各屬性的初始化代碼一般都寫在這裡。事實上之前如果沒有認真瞭解過class實例化的詳細過程,會很容易誤認為__init__函數就是class的構造函數,負責實例創建(記憶體分配)、屬性初始化工作,但實際上__init__只是負責第二步的屬性初始化工作,第一步的記憶體分配工作另有他人負責--也就是__new__函數。

__new__方法作用

__new__是一個內置staticmethod,其首個參數必須是type類型--要實例化的class本身,其負責為傳入的class type分配記憶體、創建一個新實例並返回該實例,該返回值其實就是後續執行__init__函數的入參self,大體執行邏輯其實可以從Python的源碼typeobject.c中定義的type_call函數看出來:

 955 static PyObject *
 956 type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
 957 {
 958     PyObject *obj;
 959
 960     if (type->tp_new == NULL) {
 961         PyErr_Format(PyExc_TypeError,
 962                      "cannot create '%.100s' instances",
 963                      type->tp_name);
 964         return NULL;
 965     }
 ...
 974     obj = type->tp_new(type, args, kwds); # 這裡先執行tp_new分配記憶體、創建對象返回obj
 975     obj = _Py_CheckFunctionResult((PyObject*)type, obj, NULL);
 ...
 992     type = Py_TYPE(obj); # 這裡獲取obj的class類型,並判定有tp_init則執行該初始化函數
 993     if (type->tp_init != NULL) {
 994         int res = type->tp_init(obj, args, kwds);
 995         if (res < 0) {
 996             assert(PyErr_Occurred());
 997             Py_DECREF(obj);
 998             obj = NULL;
 999         }
1000         else {
1001             assert(!PyErr_Occurred());
1002         }
1003     }
1004     return obj;
1005 }

執行代碼class(*args, **kwargs) 時,其會先調用type_new函數分配記憶體創建實例並返回為obj,而後通過Py_TYPE(obj)獲取其具體type,再進一步檢查type->tp_init不為空則執行該初始化函數。

__init__ && __new__聯繫

上面已經明確__new__負責記憶體分配創建好實例,__init__負責實例屬性的相關初始化工作,乍看上去對於實例屬性的初始化代碼完全可以也放在__new__之中,即__new__同時負責對象創建、屬性初始化,省去多定義一個__init__函數的工作,那為什麼要把這兩個功能拆分開來呢?
stackoverflow上有一個回答感覺比較合理:

As to why they're separate (aside from simple historical reasons): __new__ methods require a bunch of boilerplate to get right (the initial object creation, and then remembering to return the object at the end). __init__ methods, by contrast, are dead simple, since you just set whatever attributes you need to set.

大意是__new__方法自定義要求保證實例創建、並且必須記得返回實例對象的一系列固定邏輯正確,而__init__方法相當簡單隻需要設置想要設置的屬性即可,出錯的可能性就很小了,絕大部分場景用戶完全只需要更改__init__方法,用戶無需感知__new__的相關邏輯。
另外對於一個實例理論上是可以通過多次調用__init__函數進行初始化的,但是任何實例都只可能被創建一次,因為每次調用__new__函數理論上都是創建一個新實例返回(特殊情況如單例模式則只返迴首次創建的實例),而不會存在重新構造已有實例的情況。
針對__init__可被多次調用的情況,mutable和immutable對象會有不同的行為,因為immutable對象從語義上來說首次創建、初始化完成後就不可以修改了,所以後續再調用其__init__方法應該無任何效果才對,如下以list和tuple為例可以看出:

In [1]: a = [1, 2, 3]; print(id(a), a)
4590340288 [1, 2, 3]
# 對list實例重新初始化改變其取值為[4, 5]
In [2]: a.__init__([4, 5]); print(id(a), a)
4590340288 [4, 5]

In [3]: b = (1, 2, 3); print(id(b), b)
4590557296 (1, 2, 3)
# 對tuple實例嘗試重新初始化並無任何效果,符合對immutable類型的行為預期
In [4]: b.__init__((4, 5)); print(id(b), b)
4590557296 (1, 2, 3)

這裡可以看出將實例創建、初始化工作獨立拆分後的一個好處是:要自定義immutable class時,就應該自定義該類的__new__方法,而非__init__方法,對於immutable class的定義更方便了。

使用__new__的場景

上面已經說過對於絕大部分場景自定義__init__函數初始化實例已經能cover住需求,完全不需要再自定義__new__函數,但是終歸是有一些“高端”場景需要自定義__new__的,經過閱讀多篇資料,這裡大概總結出了兩個主要場景舉例如下。

定義、繼承immutable class

之前已經說過__int__與__new__的拆分使immutable class的定義更加方便了,因為只需要自定義僅在創建時會調用一次的__new__方法即可保證後面任意調用其__init__方法也不會有副作用。
而如果是繼承immutable class,要自定義對應immutable 實例的實例化過程,也只能通過自定義__new__來實現,更改__init__是沒有用的,如下嘗試定義一個PositiveTuple,其繼承於tuple,但是會將輸入數字全部轉化為正數。
首先嘗試自定義__init__的方法:

In [95]: class PositiveTuple(tuple):
    ...:     def __init__(self, *args, **kwargs):
    ...:         print('get in init one, self:', id(self), self)
    ...:         # 直接通過索引賦值的方式會報: PositiveTuple' object does not support item assignment
    ...:         # for i, x in enumerate(self):
    ...:         #     self[i] = abs(x)
    ...:         # 只能嘗試對self整體賦值
    ...:         self = tuple(abs(x) for x in self)
    ...:         print('get in init two, self:', id(self), self)
    ...:

In [96]: t = PositiveTuple([-3, -2, 5])
get in init one, self: 4590714416 (-3, -2, 5)
get in init two, self: 4610402176 (3, 2, 5)

In [97]: print(id(t), t)
4590714416 (-3, -2, 5)

可以看到雖然在__init__中重新對self進行了賦值,其實只是相當於新生成了一個tuple對象4610402176,t指向的依然是最開始生成好的實例4590714416。
如下為使用自定義__new__的方法:

In [128]: class PositiveTuple(tuple):
     ...:     def __new__(cls, *args, **kwargs):
     ...:         self = super().__new__(cls, *args, **kwargs)
     ...:         print('get in init one, self:', id(self), self)
     ...:         # 直接通過索引賦值的方式會報: PositiveTuple' object does not support item assignment
     ...:         # for i, x in enumerate(self):
     ...:         #     self[i] = abs(x)
     ...:         # 只能嘗試對self整體賦值
     ...:         self = tuple(abs(x) for x in self)
     ...:         print('get in init two, self:', id(self), self)
     ...:         return self
     ...:
     ...:
In [129]: t = PositiveTuple([-3, -2, 5])
get in init one, self: 4621148432 (-3, -2, 5)
get in init two, self: 4611736752 (3, 2, 5)

In [130]: print(id(t), t)
4611736752 (3, 2, 5)

可以看到一開始調用super.__new__時其實已經創建了一個實例4621148432,而後通過新生成一個全部轉化為正數的tuple 4611736752賦值後返回,最終返回的實例t也就最終需要的全正數tuple。

使用metaclass

另一個使用__new__函數的場景是metaclass,這是一個號稱99%的程式員都可以不用瞭解的“真高端”技術,也是Django中ORM實現的核心技術,目前本人也還在摸索、初學之中,這裡推薦廖老師的一篇文章科普:https://www.liaoxuefeng.com/wiki/1016959663602400/1017592449371072 ,以後有機會再單獨寫一篇blog探究。
轉載請註明出處,原文地址: https://www.cnblogs.com/AcAc-t/p/python_builtint_new_init_meaning.html

參考

https://stackoverflow.com/a/4859181/11153091
https://www.liaoxuefeng.com/wiki/1016959663602400/1017592449371072
https://xxhs-blog.readthedocs.io/zh_CN/latest/how_to_be_a_rich_man.html
https://blog.csdn.net/luoweifu/article/details/82732313
https://www.cnblogs.com/wdliu/p/6757511.html

簽名:擁抱開源,擁抱自由
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一 、Ribbon概述 Netflixfa 發佈的一個負載均衡器,有助於控制HTTP和TCP客戶端行為。在SpringCloud中,Ribbon提供了客戶端負載均衡的功能,Ribbon自動從服務註冊中心Eureka中讀取到的服務提供者的列表信息(動態獲取服務列表方式),在調用服務節點提供的服務時,基 ...
  • 簡介 對於大部分系統來說,創建對象包括申請記憶體、給成員變數賦值等過程,這些操作耗費的時間基本可以忽略不計。 如果對象中的數據需要經過複雜的計算才能得到(比如排序、計算哈希值),或者需要從 RPC、網路、資料庫、文件系統等非常慢速的 IO 中讀取,這其中耗費的時間有時是無法容忍的。 如果對象的創建成本 ...
  • 建造者模式 介紹 建造者模式註重的是部件構建的過程,意在通過一步一步地精確構造出一個複雜的對象。 可以將建造者模式理解為,假設我們有一個對象需要建立,這個對象是由多個組件(Component)組合而成,每個組件的建立都比較複雜,但運用組件來建立所需的組件對象非常簡單,所以我們就可以將構建複雜組件的步 ...
  • 在創建型模式中,工廠模式是我們日常使用最為頻繁的設計模式之一。工廠模式可細分為簡單工廠模式、工廠方法模式、抽象工廠模式。 簡單工廠模式 模式簡介 簡單工廠模式:根據參數返回不同類的實例,這些類通常具有共同的父類。 簡單工廠模式包括三個角色: 工廠 (Factory):用於創建所需產品,提供靜態工廠方 ...
  • 編程教材 《R語言實戰·第2版》Robert I. Kabacoff 課程教材《商務與經濟統計·原書第13版》 (安德森) P48、案例2-1 Pelican 商店 PS C:\Users\小能喵喵喵\Desktop\R\homework\1_Pelican> tree /f C:. │ pelic ...
  • 安裝最新版 R-4.2.1 R: The R Project for Statistical Computing (r-project.org) 有大量鏡像供選擇下載,找中國地區鏡像下載會快一點。安裝一口氣Next到底。 https://cran.rstudio.com/bin/windows/Rt ...
  • 簡述 類型:結構型 目的:降低對象創建時大量屬性也隨之被新建而帶來的性能上的消耗 話不多說,我們看一個案例。 優化案例 最初版v0 現在需要採購一批辦公用的電腦,以下是Computer類的定義。 class Computer { private String sn; // 序列號,電腦的唯一識別碼 ...
  • 探索密碼學的奇妙之旅。介紹分組密碼常用模式CFB密文反饋模式的相關理論。並基於AES標準,使用golang crypto包的cipher模塊實現了加密、解密字元串的過程。 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...