Python的魔法方法

1.简介

魔法方法是python内置方法,不需要主动调用。
魔法方法存在的目的是为了给python的解释器进行调用。
几乎每个魔法方法都有一个对应的内置函数,或者运算符。
当我们对这个对象使用这些内置函数或者运算符时,就会调用类中的对应魔法方法,可以理解为重写内置函数。

2.详细介绍

2.1 构造和初始化

_init_我们很熟悉了,它在对象初始化的时候调用,我们一般将它理解为"构造函数"。
实际上, 当我们实例化时,如:x = SomeClass(),其调用_init_并不是第一个执行的, _new_才是。所以准确来说,是_new_和_init_共同构成了"构造函数".

_new_是用来创建类并返回这个类的实例, 而_init_只是将传入的参数来初始化该实例.
_new_在创建一个实例的过程中必定会被调用,但_init_就不一定,比如通过pickle.load的方式反序列化一个实例时就不会调用_init_

_new_方法总是需要返回该类的一个实例,而_init_不能返回除了None的任何值。比如下面例子:

classFoo(object):

    def__init__(self):
        print 'foo __init__'
        return None  # 必须返回None,否则抛TypeError
    def__del__(self):
        print 'foo __del__'

实际中,你很少会用到_new_,除非你希望能够控制类的创建。
如果要讲解_new_,往往需要牵扯到metaclass(元类)的介绍。
对于new的重载,Python文档中也有了详细的介绍。

2.2 析构函数

在对象的生命周期结束时, _del_会被调用,可以将_del_理解为"析构函数".
_del_定义的是当一个对象进行垃圾回收时候的行为。

有一点容易被人误解, 实际上,x._del_() 并不是对于del x的实现,但是往往执行del x时会调用x._del_().

怎么来理解这句话呢? 继续用上面的Foo类的代码为例:

foo = Foo()
foo.__del__()
print foo
del foo
print foo  # NameError, foo is not defined

如果调用了foo._del_(),对象本身仍然存在. 但是调用了del foo, 就再也没有foo这个对象了.

请注意,如果解释器退出的时候对象还存在,就不能保证 _del_ 被确切的执行了。所以_del_并不能替代良好的编程习惯。
比如,在处理socket时,及时关闭结束的连接。

2.3 属性访问控制

总有人要吐槽Python缺少对于类的封装,比如希望Python能够定义私有属性,然后提供公共可访问的getter和 setter。Python其实可以通过魔术方法来实现封装。

_getattr_(self, name)

该方法定义了你试图访问一个不存在的属性时的行为。因此,重载该方法可以实现捕获错误拼写然后进行重定向, 或者对一些废弃的属性进行警告。

_setattr_(self, name, value)

_setattr_ 是实现封装的解决方案,它定义了你对属性进行赋值和修改操作时的行为。
不管对象的某个属性是否存在,它都允许你为该属性进行赋值,因此你可以为属性的值进行自定义操作。有一点需要注意,实现_setattr_时要避免"无限递归"的错误,下面的代码示例中会提到。

_delattr_(self, name)

_delattr_与_setattr_很像,只是它定义的是你删除属性时的行为。
实现_delattr_是同时要避免"无限递归"的错误。

_getattribute_(self, name)

_getattribute_定义了你的属性被访问时的行为,相比较,_getattr_只有该属性不存在时才会起作用。
因此,在支持_getattribute_的Python版本,调用_getattr_前必定会调用 _getattribute_。_getattribute_同样要避免"无限递归"的错误。
需要提醒的是,最好不要尝试去实现_getattribute_,因为很少见到这种做法,而且很容易出bug。

例子说明_setattr_的无限递归错误:

def__setattr__(self, name, value):
    self.name = value
    # 每一次属性赋值时, __setattr__都会被调用,因此不断调用自身导致无限递归了。

因此正确的写法应该是:

def__setattr__(self, name, value):
    self.__dict__[name] = value

_delattr_如果在其实现中出现del self.name 这样的代码也会出现"无限递归"错误,这是一样的原因。

下面的例子很好的说明了上面介绍的4个魔术方法的调用情况:

class Access(object):

    def__getattr__(self, name):
        print '__getattr__'
        return super(Access, self).__getattr__(name)

    def__setattr__(self, name, value):
        print '__setattr__'
        return super(Access, self).__setattr__(name, value)

    def__delattr__(self, name):
        print '__delattr__'
        return super(Access, self).__delattr__(name)

    def__getattribute__(self, name):
        print '__getattribute__'
        return super(Access, self).__getattribute__(name)

access = Access()
access.attr1 = True  # __setattr__调用
access.attr1  # 属性存在,只有__getattribute__调用
try:
    access.attr2  # 属性不存在, 先调用__getattribute__, 后调用__getattr__
except AttributeError:
    pass
del access.attr1  # __delattr__调用

2.4 描述符对象

我们从一个例子来入手,介绍什么是描述符,并介绍_get_,_set_, _delete_ 的使用。(放在这里介绍是为了跟上一小节介绍的魔术方法作对比)

我们知道,距离既可以用单位"米"表示,也可以用单位"英尺"表示。
现在我们定义一个类来表示距离,它有两个属性: 米和英尺。

class Meter(object):
    '''Descriptor for a meter.'''
    def__init__(self, value=0.0):
        self.value = float(value)
    def__get__(self, instance, owner):
        return self.value
    def__set__(self, instance, value):
        self.value = float(value)

class Foot(object):
    '''Descriptor for a foot.'''
    def__get__(self, instance, owner):
        return instance.meter * 3.2808
    def__set__(self, instance, value):
        instance.meter = float(value) / 3.2808

class Distance(object):
    meter = Meter()
    foot = Foot()

d = Distance()
print d.meter, d.foot  # 0.0, 0.0
d.meter = 1
print d.meter, d.foot  # 1.0 3.2808
d.meter = 2
print d.meter, d.foot  # 2.0 6.5616

在上面例子中,在还没有对Distance的实例赋值前, 我们认为meter和foot应该是各自类的实例对象, 但是输出却是数值。这是因为get发挥了作用.

我们只是修改了meter,并且将其赋值成为int,但foot也修改了。这是set发挥了作用.

描述器对象(Meter、Foot)不能独立存在, 它需要被另一个所有者类(Distance)所持有。
描述器对象可以访问到其拥有者实例的属性,比如例子中Foot的instance.meter。

在面向对象编程时,如果一个类的属性有相互依赖的关系时,使用描述器来编写代码可以很巧妙的组织逻辑。
在Django的ORM中, models.Model中的IntegerField等, 就是通过描述器来实现功能的。

一个类要成为描述器,必须实现get, set, delete 中的至少一个方法。下面简单介绍下:

get(self, instance, owner)

参数instance是拥有者类的实例。参数owner是拥有者类本身。get在其拥有者对其读值的时候调用。

set(self, instance, value)

set在其拥有者对其进行修改值的时候调用。

delete(self, instance)

delete在其拥有者对其进行删除的时候调用。

2.5 构造自定义容器(Container)

在Python中,常见的容器类型有: dict, tuple, list, string。
其中tuple, string是不可变容器,dict, list是可变容器。
可变容器和不可变容器的区别在于,不可变容器一旦赋值后,不可对其中的某个元素进行修改。
比如定义了l = [1, 2, 3]和t = (1, 2, 3)后, 执行l[0] = 0是可以的,但执行t[0] = 0则会报错。

如果我们要自定义一些数据结构,使之能够跟以上的容器类型表现一样,那就需要去实现某些协议。

这里的协议跟其他语言中所谓的"接口"概念很像,一样的需要你去实现才行,只不过没那么正式而已。

如果要自定义不可变容器类型,只需要定义_len_ 和 _getitem_方法;
如果要自定义可变容器类型,还需要在不可变容器类型的基础上增加定义_setitem_ 和 _delitem_
如果你希望你的自定义数据结构还支持"可迭代", 那就还需要定义_iter_

_len_(self)

需要返回数值类型,以表示容器的长度。该方法在可变容器和不可变容器中必须实现。

_getitem_(self, key)

当你执行self[key]的时候,调用的就是该方法。该方法在可变容器和不可变容器中也都必须实现。
调用的时候,如果key的类型错误,该方法应该抛出TypeError;
如果没法返回key对应的数值时,该方法应该抛出ValueError。

_setitem_(self, key, value)

当你执行self[key] = value时,调用的是该方法。

_delitem_(self, key)

当你执行del self[key]的时候,调用的是该方法。

_iter_(self)

该方法需要返回一个迭代器(iterator)。当你执行for x in container: 或者使用iter(container)时,该方法被调用。

_reversed_(self)

如果想要该数据结构被內建函数reversed()支持,就还需要实现该方法。

_contains_(self, item)

如果定义了该方法,那么在执行item in container 或者 item not in container时该方法就会被调用。
如果没有定义,那么Python会迭代容器中的元素来一个一个比较,从而决定返回True或者False。

_missing_(self, key)

dict字典类型会有该方法,它定义了key如果在容器中找不到时触发的行为。
比如d = {'a': 1}, 当你执行d[notexist]时,d.missing('notexist')就会被调用。

下面举例,使用上面讲的魔术方法来实现Haskell语言中的一个数据结构。

# -*- coding: utf-8 -*-
class FunctionalList:
    ''' 实现了内置类型list的功能,并丰富了一些其他方法: head, tail, init, last, drop, take'''

    def __init__(self, values=None):
        if values is None:
            self.values = []
        else:
            self.values = values

    def _len__(self):
        return len(self.values)

    def __getitem__(self, key):
        return self.values[key]

    def __setitem__(self, key, value):
        self.values[key] = value

    def __delitem__(self, key):
        del self.values[key]

    def __iter__(self):
        return iter(self.values)

    def __reversed__(self):
        return FunctionalList(reversed(self.values))

    def append(self, value):
        self.values.append(value)
    def head(self):
        # 获取第一个元素
        return self.values[0]
    def tail(self):
        # 获取第一个元素之后的所有元素
        return self.values[1:]
    def init(self):
        # 获取最后一个元素之前的所有元素
        return self.values[:-1]
    def last(self):
        # 获取最后一个元素
        return self.values[-1]
    def drop(self, n):
        # 获取所有元素,除了前N个
        return self.values[n:]
    def take(self, n):
        # 获取前N个元素
        return self.values[:n]

我们再举个例子,实现Perl语言的AutoVivification,它会在你每次引用一个值未定义的属性时为你自动创建数组或者字典。

class AutoVivification(dict):
    """Implementation of perl's autovivification feature."""
    def __missing__(self, key):
        value = self[key] = type(self)()
        return value

weather = AutoVivification()
weather['china']['guangdong']['shenzhen'] = 'sunny'
weather['china']['hubei']['wuhan'] = 'windy'
weather['USA']['California']['Los Angeles'] = 'sunny'
print weather

# 结果输出:{'china': {'hubei': {'wuhan': 'windy'}, 'guangdong': {'shenzhen': 'sunny'}}, 'USA': {'California': {'Los Angeles': 'sunny'}}}
在Python中,关于自定义容器的实现还有更多实用的例子,但只有很少一部分能够集成在Python标准库中,比如Counter,OrderedDict等

2.6 上下文管理

with声明是从Python2.5开始引进的关键词。你应该遇过这样子的代码:

with open('foo.txt') as bar:
    # do something with bar

在with声明的代码段中,我们可以做一些对象的开始操作和清除操作,还能对异常进行处理。
这需要实现两个魔术方法:_enter_ 和 _exit_。

_enter_(self)

_enter_会返回一个值,并赋值给as关键词之后的变量。在这里,你可以定义代码段开始的一些操作。

_exit_(self, exception_type, exception_value, traceback)

_exit_定义了代码段结束后的一些操作,可以这里执行一些清除操作,或者做一些代码段结束后需要立即执行的命令,比如文件的关闭,socket断开等。如果代码段成功结束,那么exception_type, exception_value, traceback 三个参数传进来时都将为None。如果代码段抛出异常,那么传进来的三个参数将分别为: 异常的类型,异常的值,异常的追踪栈。
如果_exit_返回True, 那么with声明下的代码段的一切异常将会被屏蔽。
如果_exit_返回None, 那么如果有异常,异常将正常抛出,这时候with的作用将不会显现出来。

举例说明:

该示例中,IndexError始终会被隐藏,而TypeError始终会抛出。

classDemoManager(object):

    def __enter__(self):
        pass

    def __exit__(self, ex_type, ex_value, ex_tb):
        if ex_type is IndexError:
            print ex_value.__class__
            return True
        if ex_type is TypeError:
            print ex_value.__class__
            return  # return None

with DemoManager() as nothing:
    data = [1, 2, 3]
    data[4]  # raise IndexError, 该异常被__exit__处理了

with DemoManager() as nothing:
    data = [1, 2, 3]
    data['a']  # raise TypeError, 该异常没有被__exit__处理

'''
输出:
<type 'exceptions.IndexError'>
<type 'exceptions.TypeError'>
Traceback (most recent call last):
  ...
'''

2.7 对象的序列化

Python对象的序列化操作是pickling进行的。pickling非常的重要,以至于Python对此有单独的模块pickle,还有一些相关的魔术方法。使用pickling, 你可以将数据存储在文件中,之后又从文件中进行恢复。

下面举例来描述pickle的操作。从该例子中也可以看出,如果通过pickle.load 初始化一个对象, 并不会调用_init_方法。

# -*- coding: utf-8 -*-
from datetime import datetime
import pickle

class Distance(object):

    def__init__(self, meter):
        print 'distance __init__'
        self.meter = meter

data = {
    'foo': [1, 2, 3],
    'bar': ('Hello', 'world!'),
    'baz': True,
    'dt': datetime(2016, 10, 01),
    'distance': Distance(1.78),
}
print ('before dump:', data)
with open('data.pkl', 'wb') as jar:
    pickle.dump(data, jar)  # 将数据存储在文件中

del data
print 'data is deleted!'

with open('data.pkl', 'rb') as jar:
    data = pickle.load(jar)  # 从文件中恢复数据
print ('after load:', data)

值得一提,从其他文件进行pickle.load操作时,需要注意有恶意代码的可能性。另外,Python的各个版本之间,pickle文件可能是互不兼容的。

pickling并不是Python的內建类型,它支持所有实现pickle协议(可理解为接口)的类。pickle协议有以下几个可选方法来自定义Python对象的行为。

_getinitargs_(self)

如果你希望unpickle时,_init_方法能够调用,那么就需要定义_getinitargs_, 该方法需要返回一系列参数的元组,这些参数就是传给_init_的参数。

该方法只对old-style class有效。所谓old-style class,指的是不继承自任何对象的类,往往定义时这样表示: class A:, 而非class A(object):

_getnewargs_(self)

跟_getinitargs_很类似,只不过返回的参数元组将传值给_new_

_getstate_(self)

在调用pickle.dump时,默认是对象的_dict_属性被存储,如果你要修改这种行为,可以在_getstate_方法中返回一个state。state将在调用pickle.load时传值给_setstate_

_setstate_(self, state)

一般来说,定义了_getstate_,就需要相应地定义_setstate_来对_getstate_返回的state进行处理。

_reduce_(self)

如果pickle的数据包含了自定义的扩展类(比如使用C语言实现的Python扩展类)时,就需要通过实现reduce方法来控制行为了。由于使用过于生僻,这里就不展开继续讲解了。

令人容易混淆的是,我们知道, reduce()是Python的一个內建函数, 需要指出_reduce_并非定义了reduce()的行为,二者没有关系。

_reduce_ex_(self)

_reduce_ex_ 是为了兼容性而存在的, 如果定义了_reduce_ex, 它将代替_reduce 执行。

下面的代码示例很有意思,我们定义了一个类Slate(中文是板岩的意思)。这个类能够记录历史上每次写入给它的值,但每次pickle.dump时当前值就会被清空,仅保留了历史。

# -*- coding: utf-8 -*-
import pickle
import time

classSlate:
    '''Class to store a string and a changelog, and forget its value when pickled.'''
    def__init__(self, value):
        self.value = value
        self.last_change = time.time()
        self.history = []

    defchange(self, new_value):
        # 修改value, 将上次的valeu记录在history
        self.history.append((self.last_change, self.value))
        self.value = new_value
        self.last_change = time.time()

    defprint_changes(self):
        print 'Changelog for Slate object:'
        for k, v in self.history:
            print '%s    %s' % (k, v)

    def__getstate__(self):
        # 故意不返回self.value和self.last_change,
        # 以便每次unpickle时清空当前的状态,仅仅保留history
        return self.history

    def__setstate__(self, state):
        self.history = state
        self.value, self.last_change = None, None

slate = Slate(0)
time.sleep(0.5)
slate.change(100)
time.sleep(0.5)
slate.change(200)
slate.change(300)
slate.print_changes()  # 与下面的输出历史对比
with open('slate.pkl', 'wb') as jar:
    pickle.dump(slate, jar)
del slate  # delete it
with open('slate.pkl', 'rb') as jar:
    slate = pickle.load(jar)
print 'current value:', slate.value  # None
print slate.print_changes()  # 输出历史记录与上面一致

2.8 运算符相关的魔术方法

运算符相关的魔术方法实在太多了,也很好理解,不打算多讲。在其他语言里,也有重载运算符的操作,所以我们对这些魔术方法已经很了解了。

2.8.1 比较运算符

_cmp_(self, other)

如果该方法返回负数,说明self < other; 返回正数,说明self > other; 返回0说明self == other。
强烈不推荐来定义_cmp_, 取而代之, 最好分别定义_lt_等方法从而实现比较功能。
_cmp_在Python3中被废弃了。

_eq_(self, other)

定义了比较操作符==的行为.

_ne_(self, other)

定义了比较操作符!=的行为.

_lt_(self, other)

定义了比较操作符<的行为.

_gt_(self, other)

定义了比较操作符>的行为.

_le_(self, other)

定义了比较操作符<=的行为.

_ge_(self, other)

定义了比较操作符>=的行为.

下面我们定义一种类型Word, 它会使用单词的长度来进行大小的比较, 而不是采用str的比较方式。
但是为了避免 Word('bar') == Word('foo') 这种违背直觉的情况出现,并没有定义_eq_, 因此Word会使用它的父类(str)中的_eq_来进行比较。

下面的例子中也可以看出: 在编程语言中, 如果a >=b and a <= b, 并不能推导出a == b这样的结论。

# -*- coding: utf-8 -*-
class Word(str):
    '''存储单词的类,定义比较单词的几种方法'''
    def__new__(cls, word):
        # 注意我们必须要用到__new__方法,因为str是不可变类型
        # 所以我们必须在创建的时候将它初始化
        if ' ' in word:
            print "Value contains spaces. Truncating to first space."
            word = word[:word.index(' ')]  # 单词是第一个空格之前的所有字符
        return str.__new__(cls, word)

    def__gt__(self, other):
        return len(self) > len(other)
    def__lt__(self, other):
        return len(self) < len(other)
    def__ge__(self, other):
        return len(self) >= len(other)
    def__le__(self, other):
        return len(self) <= len(other)

print 'foo < fool:', Word('foo') < Word('fool')  # True
print 'foolish > fool:', Word('foolish') > Word('fool')  # True
print 'bar >= foo:', Word('bar') >= Word('foo')  # True
print 'bar <= foo:', Word('bar') <= Word('foo')  # True
print 'bar == foo:', Word('bar') == Word('foo')  # False, 用了str内置的比较方法来进行比较
print 'bar != foo:', Word('bar') != Word('foo')  # True

2.8.2 一元运算符和函数

_pos_(self)

实现了'+'号一元运算符(比如+some_object)

_neg_(self)

实现了'-'号一元运算符(比如-some_object)

_invert_(self)

实现了号(波浪号)一元运算符(比如some_object)

_abs_(self)

实现了abs()內建函数.

_round_(self, n)

实现了round()内建函数. 参数n表示四舍五进的精度.

_floor_(self)

实现了math.floor(), 向下取整.

_ceil_(self)

实现了math.ceil(), 向上取整.

_trunc_(self)

实现了math.trunc(), 向0取整.

2.8.3 算术运算符

_add_(self, other)

实现了加号运算.

_sub_(self, other)

实现了减号运算.

_mul_(self, other)

实现了乘法运算.

_floordiv_(self, other)

实现了//运算符.

_div_(self, other)

实现了/运算符. 该方法在Python3中废弃. 原因是Python3中,division默认就是true division.

_truediv_(self, other)

实现了true division. 只有你声明了from future import division该方法才会生效.

_mod_(self, other)

实现了%运算符, 取余运算.

_divmod_(self, other)

实现了divmod()內建函数.

_pow_(self, other)

实现了**操作. N次方操作.

_lshift_(self, other)

实现了位操作<<.

_rshift_(self, other)

实现了位操作>>.

_and_(self, other)

实现了位操作&.

_or_(self, other)

实现了位操作|

_xor_(self, other)

实现了位操作^

2.8.4 反算术运算符

这里只需要解释一下概念即可。
假设针对some_object这个对象:

some_object + other
上面的代码非常正常地实现了some_object的_add_方法。那么如果遇到相反的情况呢?

other + some_object
这时候,如果other没有定义_add方法,但是some_object定义了_radd, 那么上面的代码照样可以运行。
这里的_radd(self, other)就是_add(self, other)的反算术运算符。

所以,类比的,我们就知道了更多的反算术运算符, 就不一一展开了:

_rsub(self, other)
_rmul
(self, other)
_rmul(self, other)
_rfloordiv
(self, other)
_rdiv(self, other)
_rtruediv
(self, other)
_rmod(self, other)
_rdivmod
(self, other)
_rpow(self, other)
_rlshift
(self, other)
_rrshift(self, other)
_rand
(self, other)
_ror(self, other)
_rxor
(self, other)

2.8.5 增量赋值

这也是只要理解了概念就容易掌握的运算。举个例子:

x = 5
x += 1 # 这里的+=就是增量赋值,将x+1赋值给了x
因此对于a += b, _iadd_ 将返回a + b, 并赋值给a。
所以很容易理解下面的魔术方法了:

_iadd(self, other)
_isub
(self, other)
_imul(self, other)
_ifloordiv
(self, other)
_idiv(self, other)
_itruediv
(self, other)
_imod(self, other)
_ipow
(self, other)
_ilshift(self, other)
_irshift
(self, other)
_iand(self, other)
_ior
(self, other)
_ixor_(self, other)

2.8.6 类型转化

__int__(self)

实现了类型转化为int的行为.

__long__(self)

实现了类型转化为long的行为.

__float__(self)

实现了类型转化为float的行为.

__complex__(self)

实现了类型转化为complex(复数, 也即1+2j这样的虚数)的行为.

__oct__(self)

实现了类型转化为八进制数的行为.

__hex__(self)

实现了类型转化为十六进制数的行为.

__index__(self)

在切片运算中将对象转化为int, 因此该方法的返回值必须是int。用一个例子来解释这个用法。

class Thing(object):
    def__index__(self):
        return 1

thing = Thing()
list_ = ['a', 'b', 'c']
print list_[thing]  # 'b'
print list_[thing:thing]  # []

上面例子中, list_[thing]的表现跟list_[1]一致,正是因为Thing实现了__index__方法。

可能有的人会想,list_[thing]为什么不是相当于list_[int(thing)]呢? 通过实现Thing的__int__方法能否达到这个目的呢?

显然不能。如果真的是这样的话,那么list_[1.1:2.2]这样的写法也应该是通过的。
而实际上,该写法会抛出TypeError: slice indices must be integers or None or have an __index__ method

下面我们再做个例子,如果对一个dict对象执行dict_[thing]会怎么样呢?

dict_ = {1: 'apple', 2: 'banana', 3: 'cat'}
print dict_[thing]  # raise KeyError

这个时候就不是调用__index__了。虽然listdict都实现了__getitem__方法, 但是它们的实现方式是不一样的。
如果希望上面例子能够正常执行, 需要实现Thing的__hash____eq__方法.

classThing(object):
    def__hash__(self):
        return 1
    def__eq__(self, other):
        return hash(self) == hash(other)

dict_ = {1: 'apple', 2: 'banana', 3: 'cat'}
print dict_[thing]  # apple

__coerce__(self, other)

实现了混合模式运算。

要了解这个方法,需要先了解coerce()内建函数: 官方文档上的解释是, coerce(x, y)返回一组数字类型的参数, 它们被转化为同一种类型,以便它们可以使用相同的算术运算符进行操作。如果过程中转化失败,抛出TypeError。

比如对于coerce(10, 10.1), 因为10和10.1在进行算术运算时,会先将10转为10.0再来运算。因此coerce(10, 10.1)返回值是(10.0, 10.1).

__coerce__在Python3中废弃了。

2.8.7其他魔术方法

还没讲到的魔术方法还有很多,但有些我觉得很简单,或者很少见,就不再累赘展开说明了。

__str__(self)

对实例使用str()时调用。

__repr__(self)

对实例使用repr()时调用。str()和repr()都是返回一个代表该实例的字符串,主要区别在于: str()的返回值要方便人来看,而repr()的返回值要方便计算机看。

__unicode__(self)

对实例使用unicode()时调用。unicode()与str()的区别在于: 前者返回值是unicode, 后者返回值是str。unicode和str都是basestring的子类。

当你对一个类只定义了__str__但没定义__unicode__时,__unicode__会根据__str__的返回值自动实现,即return unicode(self.__str__());
但返回来则不成立。

class StrDemo2:
    def__str__(self):
        return 'StrDemo2'

class StrDemo3:
    def__unicode__(self):
        return u'StrDemo3'

demo2 = StrDemo2()
print (str(demo2))  # StrDemo2
print (unicode(demo2))  # StrDemo2

demo3 = StrDemo3()
print (str(demo3))  # <__main__.StrDemo3 instance>
print (unicode(demo3))  # StrDemo3
__format__(self, formatstr)

"Hello, {0:abc}".format(a)等价于format(a, "abc"), 等价于a.format("abc")。

这在需要格式化展示对象的时候非常有用,比如格式化时间对象。

__hash__(self)

对实例使用hash()时调用, 返回值是数值类型。

__nonzero__(self)

对实例使用bool()时调用, 返回True或者False。
你可能会问, 为什么不是命名为__bool__? 我也不知道。
我只知道该方法在Python3中改名为__bool__了。

__dir__(self)

对实例使用dir()时调用。通常实现该方法是没必要的。

__sizeof__(self)

对实例使用sys.getsizeof()时调用。返回对象的大小,单位是bytes。

__instancecheck__(self, instance)

对实例调用isinstance(instance, class)时调用。 返回值是布尔值。它会判断instance是否是该类的实例。

__subclasscheck__(self, subclass)

对实例使用issubclass(subclass, class)时调用。返回值是布尔值。它会判断subclass否是该类的子类。

__copy__(self)

对实例使用copy.copy()时调用。返回"浅复制"的对象。

__deepcopy__(self, memodict={})

对实例使用copy.deepcopy()时调用。返回"深复制"的对象。

__call__(self, [args...])

该方法允许类的实例跟函数一样表现:

classXClass:
    def__call__(self, a, b):
        return a + b

defadd(a, b):
    return a + b

x = XClass()
print 'x(1, 2)', x(1, 2)
print 'callable(x)', callable(x)  # True
print 'add(1, 2)', add(1, 2)
print 'callable(add)', callable(add)  # True

2.8.8 Python3中的差异

  • Python3中,str与unicode的区别被废除了,因而unicode没有了,取而代之地出现了bytes.
  • Python3中,division默认就是true division, 因而div废弃.
  • coerce因存在冗余而废弃.
  • cmp因存在冗余而废弃.
  • nonzero改名为bool.
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341