理解python的類實例化

英文原文來自Understanding Python Class Instantiation
PythonWeekly郵件中看到

讓我們以一個Foo類開始:

class Foo(object):
    def __init__(self, x, y=0):
        self.x = x
        self.y = y

當你實例化它(即創(chuàng)建該類的一個新的實例)時發(fā)生了什么迫像?

f = Foo(1, y=2)

Foo的調(diào)用到底調(diào)用了什么函數(shù)或方法呢劈愚?大多數(shù)新手甚至許多有經(jīng)驗的Python開發(fā)者會立刻回答:調(diào)用了__init__方法。如果你停下來仔細想1秒闻妓,你會發(fā)現(xiàn)這遠不是一個正確答案菌羽。

__init__并沒有返回一個對象,但是調(diào)用Foo(1, y=2)確實返回了一個對象由缆。而且注祖,__init__預(yù)期一個self參數(shù)猾蒂,但是當我們調(diào)用Foo(1, y=2)時這里并沒有這個參數(shù)。這里會有更復(fù)雜的工作是晨。在這篇文章中肚菠,讓我們探究下在Python中實例化一個類時到底發(fā)生了什么。

構(gòu)造順序

在Python中實例化一個對象包含了幾個階段罩缴,但它的妙處在于它們自身是Pythonic(python之禪)的——理解這些步驟使得我們對Python整體有多一點的了解蚊逢。Foo是一個類,但是Python中的類也是對象箫章!類烙荷、函數(shù)、方法以及實例都是對象檬寂,并且無論何時你將一對括號放在它們的名字后面時终抽,就會調(diào)用它們的__call__方法。所以Foo(1, y=2)是等價于Foo.__call__(1, y=2)的焰薄。__call__方法是定義在Foo的類中的拿诸。Foo的類是什么呢?

>>> Foo.__class__
<class 'type'>

所以Foo是類型type的一個對象并且調(diào)用__call__返回一個Foo類的對象塞茅。讓我們看下type中的__call__方法是什么樣的亩码。這個方法相當?shù)膹?fù)雜,但是我們嘗試盡量簡化它野瘦。在下面我粘貼了CPython CPyPy Python的實現(xiàn)描沟。我發(fā)想從源碼中尋找答案是很有趣的,但是你也可以直接看下面的簡化版:

CPython

源碼

static PyObject *
type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
    PyObject *obj;

    if (type->tp_new == NULL) {
        PyErr_Format(PyExc_TypeError,
                     "cannot create '%.100s' instances",
                     type->tp_name);
        return NULL;
    }

    obj = type->tp_new(type, args, kwds);
    obj = _Py_CheckFunctionResult((PyObject*)type, obj, NULL);
    if (obj == NULL)
        return NULL;

    /* Ugly exception: when the call was type(something),
       don't call tp_init on the result. */
    if (type == &PyType_Type &&
        PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
        (kwds == NULL ||
         (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
        return obj;

    /* If the returned object is not an instance of type,
       it won't be initialized. */
    if (!PyType_IsSubtype(Py_TYPE(obj), type))
        return obj;

    type = Py_TYPE(obj);
    if (type->tp_init != NULL) {
        int res = type->tp_init(obj, args, kwds);
        if (res < 0) {
            assert(PyErr_Occurred());
            Py_DECREF(obj);
            obj = NULL;
        }
        else {
            assert(!PyErr_Occurred());
        }
    }
    return obj;
}
PyPy

源碼

def descr_call(self, space, __args__):
    promote(self)
    # invoke the __new__ of the type
    if not we_are_jitted():
        # note that the annotator will figure out that self.w_new_function
        # can only be None if the newshortcut config option is not set
        w_newfunc = self.w_new_function
    else:
        # for the JIT it is better to take the slow path because normal lookup
        # is nicely optimized, but the self.w_new_function attribute is not
        # known to the JIT
        w_newfunc = None
    if w_newfunc is None:
        w_newtype, w_newdescr = self.lookup_where('__new__')
        if w_newdescr is None:    # see test_crash_mro_without_object_1
            raise oefmt(space.w_TypeError, "cannot create '%N' instances",
                        self)
        w_newfunc = space.get(w_newdescr, self)
        if (space.config.objspace.std.newshortcut and
            not we_are_jitted() and
            isinstance(w_newtype, W_TypeObject)):
            self.w_new_function = w_newfunc
    w_newobject = space.call_obj_args(w_newfunc, self, __args__)
    call_init = space.isinstance_w(w_newobject, self)

    # maybe invoke the __init__ of the type
    if (call_init and not (space.is_w(self, space.w_type) and
        not __args__.keywords and len(__args__.arguments_w) == 1)):
        w_descr = space.lookup(w_newobject, '__init__')
        if w_descr is not None:    # see test_crash_mro_without_object_2
            w_result = space.get_and_call_args(w_descr, w_newobject,
                                               __args__)
            if not space.is_w(w_result, space.w_None):
                raise oefmt(space.w_TypeError,
                            "__init__() should return None")
    return w_newobject

如果我們忽略錯誤檢查鞭光,那么對于常規(guī)類的實例化它大致等同如下:

def __call__(obj_type, *args, **kwargs):
    obj = obj_type.__new__(*args, **kwargs)
    if obj is not None and issubclass(obj, obj_type):
        obj.__init__(*args, **kwargs)
    return obj

__new__方法為對象分配了內(nèi)存空間吏廉,構(gòu)建它為一個“空"對象然后__init__方法被調(diào)用來初始化它。
總的來說:

  1. Foo(*args, **kwargs)等價于Foo.__call__(*args, **kwargs)
  2. 既然Foo是一個type的實例惰许,Foo.__call__(*args, **kwargs)實際調(diào)用的是type.__call__(Foo, *args, **kwargs)
  3. type.__call__(Foo, *args, **kwargs)調(diào)用type.__new__(Foo, *args, **kwargs)席覆,然后返回一個對象。
  4. obj隨后通過調(diào)用obj.__init__(*args, **kwargs)被初始化。
  5. obj被返回。

定制

現(xiàn)在我們將注意力轉(zhuǎn)移到__new__方法上搏熄。本質(zhì)上,它是負責實際對象的創(chuàng)建的方法生巡。我們不會具體探究__new__方法的底層實現(xiàn)細節(jié)。它的要點是它會為對象分配空間并返回該對象见妒。有趣的是孤荣,一旦你意識到__new__做了什么,你可以用它來定制有趣的實例創(chuàng)建方式。值得注意的是盐股,盡管__new__是一個靜態(tài)方法钱豁,但你不需要用@staticmethod來聲明它——它是Python解釋器的特例。

一個精彩的展現(xiàn)__new__方法的力量的例子就是用它來實現(xiàn)一個單例類:

class Singleton(object):
    _instance = None
    
    def __new__(cls, *args, **kwargs):
        if cls._instance is None:
            cls._instance = super().__new__(cls, *args, **kwargs)
        return cls._instance

然后使用它:

>>> s1 = Singleton()
... s2 = Singleton()
... s1 is s2
True

注意在這個單例類的實現(xiàn)中遂庄,__init__方法會在每次我們調(diào)用Singleton()時被調(diào)用寥院,所以要小心處理劲赠。
另外一個相似的例子是實現(xiàn)Borg design pattern

class Borg(object):
    _dict = None

    def __new__(cls, *args, **kwargs):
        obj = super().__new__(cls, *args, **kwargs)
        if cls._dict is None:
            cls._dict = obj.__dict__
        else:
            obj.__dict__ = cls._dict
        return obj

然后:

>>> b1 = Borg()
... b2 = Borg()
... b1 is b2
False
>>> b1.x = 8
... b2.x
8

最后的提醒——上面的例子展示了__new__的力量涛目,但是只是說明你可以使用它,而不是意味著你應(yīng)該這么做:

__new__是Python中最容易被濫用的特性凛澎。它晦澀難懂霹肝,又缺陷叢生,并且?guī)缀趺總€用例都被我發(fā)現(xiàn)有更好的解決方案(使用其它的Python工具)塑煎。但是沫换,當你確實需要__new__時,它令人難以置信的強大并且值得去理解最铁。
—— Arion Sprague, Python’s Hidden New

在python中讯赏,一個問題的最佳解決方案是用__new__的情況是罕見的。麻煩的是如果你手里有把錘子冷尉,任何問題看起來都會像是釘子了 —— 那么你可能會突然遇到很多__new__能解決的問題漱挎。但是我們應(yīng)該更傾向于更好的設(shè)計而不是使用一個全新的工具。__new__并不總是更好的雀哨。

參考

補充

如果 Foo 定義了一個 __call__方法磕谅,Foo(*args, **kwargs) 并不等于Foo.__call__(*args, **kwargs):

>>> class Foo:
...   def __call__(self):
...     print('running __call__')
...
>>> Foo()
<__main__.Foo object at 0x000000000227ABE0>
>>> Foo.__call__()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: __call__() missing 1 required positional argument: 'self'
In this case, __call__ is used to call instances of the class :

>>> Foo()()
running __call__
>>>
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市雾棺,隨后出現(xiàn)的幾起案子膊夹,更是在濱河造成了極大的恐慌,老刑警劉巖捌浩,帶你破解...
    沈念sama閱讀 218,284評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件放刨,死亡現(xiàn)場離奇詭異,居然都是意外死亡尸饺,警方通過查閱死者的電腦和手機进统,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來侵佃,“玉大人麻昼,你說我怎么就攤上這事〔霰玻” “怎么了抚芦?”我有些...
    開封第一講書人閱讀 164,614評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我叉抡,道長尔崔,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,671評論 1 293
  • 正文 為了忘掉前任褥民,我火速辦了婚禮季春,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘消返。我一直安慰自己载弄,他們只是感情好,可當我...
    茶點故事閱讀 67,699評論 6 392
  • 文/花漫 我一把揭開白布撵颊。 她就那樣靜靜地躺著宇攻,像睡著了一般。 火紅的嫁衣襯著肌膚如雪倡勇。 梳的紋絲不亂的頭發(fā)上逞刷,一...
    開封第一講書人閱讀 51,562評論 1 305
  • 那天,我揣著相機與錄音妻熊,去河邊找鬼夸浅。 笑死,一個胖子當著我的面吹牛扔役,可吹牛的內(nèi)容都是我干的帆喇。 我是一名探鬼主播,決...
    沈念sama閱讀 40,309評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼厅目,長吁一口氣:“原來是場噩夢啊……” “哼番枚!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起损敷,我...
    開封第一講書人閱讀 39,223評論 0 276
  • 序言:老撾萬榮一對情侶失蹤葫笼,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后拗馒,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體路星,經(jīng)...
    沈念sama閱讀 45,668評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,859評論 3 336
  • 正文 我和宋清朗相戀三年诱桂,在試婚紗的時候發(fā)現(xiàn)自己被綠了洋丐。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,981評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡挥等,死狀恐怖友绝,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情肝劲,我是刑警寧澤迁客,帶...
    沈念sama閱讀 35,705評論 5 347
  • 正文 年R本政府宣布郭宝,位于F島的核電站,受9級特大地震影響掷漱,放射性物質(zhì)發(fā)生泄漏粘室。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,310評論 3 330
  • 文/蒙蒙 一卜范、第九天 我趴在偏房一處隱蔽的房頂上張望衔统。 院中可真熱鬧,春花似錦海雪、人聲如沸锦爵。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至刺彩,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間枝恋,已是汗流浹背创倔。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留焚碌,地道東北人畦攘。 一個月前我還...
    沈念sama閱讀 48,146評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像十电,于是被迫代替她去往敵國和親知押。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,933評論 2 355

推薦閱讀更多精彩內(nèi)容