Python 中常用的魔术方法

Illustrations by Nikita Pilyukshin

概述

python中特殊方法（魔术方法）是被python解释器调用的，我们自己不需要调用它们，我们统一使用内置函数来使用。例如：特殊方法__len__()实现后，我们只需使用len()方法即可；也有一些特殊方法的调用是隐式的，例如：for i in x: 背后其实用的是内置函数iter(x)。

下面将介绍一些常用特殊方法和实现。通过实现一个类来说明

常用特殊方法及实现

• __len__()

一般返回数量，使用len()方法调用。在__len__()内部也可使用len()函数

class Zarten():
    def __init__(self, age):
        self.age = age
        self.brother = ['zarten_1', 'zarten_2']

    def __len__(self):
        return len(self.brother) #可直接使用len()
        # return self.age

z = Zarten(18)



    
print(len(z))

• __str__()

对象的字符串表现形式，与__repr__()基本一样，微小差别在于：

1、__str__()用于给终端用户看的，而__repr__()用于给开发者看的，用于调试和记录日志等。

2、在命令行下，实现__str_()后，直接输入对象名称会显示对象内存地址；而实现`repr()后，跟print（对象）效果一样。

3、若这2个都实现，会调用__str_()，一般在类中至少实现__repr__()

class Zarten():
    def __repr__(self):
        return 'my name is Zarten_1'

    def __str__(self):
        return 'my name is Zarten_2'

z = Zarten()
print(z)

my name is Zarten_2

• __iter__()

返回一个可迭代对象，一般跟__next__()一起使用

class Zarten():
    def __init__(self, brother_num):
        self.brother_num = brother_num
        self.count = 0

    def __iter__(self):
        return self

    


    
def __next__(self):
        if self.count >= self.brother_num:
            raise StopIteration
        else:
            self.count += 1
            return 'zarten_' + str(self.count)


zarten = Zarten(5)
for i in zarten:
    print(i)

• __getitem__()

此特殊方法返回数据，也可以替代__iter_()和__next__()方法，也可支持切片

class Zarten():
    def __init__(self):
        self.brother = ['zarten_1','zarten_2','zarten_3','zarten_4','zarten_5',]

    def __getitem__(self, item):
        return self.brother[item]

zarten = Zarten()
print(zarten[2])
print


    
(zarten[1:3])

for i in zarten:
    print(i)

• __new__()

__new__()用来构造一个类的实例，第一个参数是cls，一般情况下不会使用。而__init__()用来初始化实例，所以__new__()比__init___()先执行。

若__new__()不返回，则不会有任何对象创建，__init___()也不会执行；

若__new__()返回别的类的实例，则__init___()也不会执行；

用途：可使用__new___()实现单例模式

class Zarten():
    def __new__(cls, *args, **kwargs):
        print('__new__')
        return super().__new__(cls)

    def __init__(self, name, age):
        print('__init__')
        self.name = name
        self.age = age

    def __repr__(self):
        return 'name: %s  age:%d' % (self.name,self.age)




    
zarten = Zarten('zarten', 18)
print(zarten)

__new__
__init__
name:zarten   age:18

使用__new__()实现单例模式

class Zarten():
    _singleton = None

    def __new__(cls, *args, **kwargs):
        print('__new__')
        if not cls._singleton:
            cls._singleton = super().__new__(cls)
        return cls._singleton

    def __init__(self, name, age):
        print('__init__')
        self.name = name
        self.age = age

    def __repr__(self):
        return 'name: %s  age:%d' % (self.


    
name,self.age)

zarten = Zarten('zarten', 18)
zarten_1 = Zarten('zarten_1', 19)
print(zarten)
print(zarten_1)
print(zarten_1 == zarten)

__new__
__init__
__new__
__init__
name:zarten_1 age:19
name:zarten_1 age:19
True

• __call__()

实现后对象可变成可调用对象，此对象可以像函数一样调用，例如：自定义函数，内置函数，类都是可调用对象，可用callable()判断是否是可调用对象

class Zarten():

    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __call__(self):
        print('name:%s  age:%d' % (self.name, self.age))


z = Zarten(


    
'zarten', 18)
print(callable(z))
z()

• __enter__()

一个上下文管理器的类，必须要实现这2个特殊方法：__enter_()和__exit__()，使用with语句来调用。

使用__enter__()返回对象，使用__exit__()关闭对象

class Zarten():

    def __init__(self, file_name, method):
        self.file_obj = open(file_name, method)

    def __enter__(self):
        return self.file_obj

    def __exit__(self, exc_type, exc_val, exc_tb):
        self.file_obj.close()
        print('closed')


with Zarten('e:\\test.txt', 'r') as f:
    r = f.read()
    print(r)

• __add__()

加法运算符重载以及__radd__()反向运算符重载

当对象作加法时，首先会在“+”左边对象查找__add__()，若没找到则在“+”右边查找__radd__()

class Zarten():

    def __init__(self, age):
        self.age = age

    def __add__(self, other):
        return self.age + other

    def __radd__(self, other):
        return  self.age + other



z = Zarten(18)
print(z + 10)
print(20 + z)

• __del__() 

对象生命周期结束时调用，相当于析构函数

class Zarten():

    def __init__(self, age):
        self.age = age

    def __del__(self):
        print('__del__')


z = Zarten(18)

特殊（魔术）方法汇总一览表

▼ 点击成为社区注册会员          「在看」 一下，一起PY！