Python魔法方法(持续更新)

Python魔法方法(持续更新)

简介

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

__len__方法

__len__魔法方法是可以使得len()方法使用在对象上，下面这个例子是模拟扑克牌

import collections
card = collections.namedtuple('card', ["rank", 'suit'])
class FrenchDeck:
    ranks = [ str(n) for n in range(2, 11)] + list("JQKA")
    suits = 'spades diamonds clubs hearts'.split()

    def __init__(self):
        self._cards = [card(rank, suit) for suit in self.suits for rank in self.ranks]

    def __len__(self):
        return len(self._cards)

>>> fd = FrenchDeck()
>>> len(fd)  # 可以直接使用len函数查看fd对象的长度
52

namedtuple()方法作用是返回一个只携带属性的对象，如果你需要一个对象，同时这个对象中只有少量属性那么可以尝试使用这个方法。下面是官方文档给的例子，可以通过下标的形式取得属性

>>> # Basic example
>>> Point = namedtuple('Point', ['x', 'y'])
>>> p = Point(11, y=22)     # instantiate with positional or keyword arguments
>>> p[0] + p[1]             # indexable like the plain tuple (11, 22)
33
>>> x, y = p                # unpack like a regular tuple
>>> x, y
(11, 22)
>>> p.x + p.y               # fields also accessible by name
33
>>> p                       # readable __repr__ with a name=value style
Point(x=11, y=22)

__getitem__方法

__getitem__拥有此方法的对象可以通过的使用列表的形式进行对象操作，如：切片，下标取值

class FrenchDeck:
    ranks = [ str(n) for n in range(2, 11)] + list("JQKA")
    suits = 'spades diamonds clubs hearts'.split()

    def __init__(self):
        self._cards = [card(rank, suit) for suit in self.suits for rank in self.ranks]

    def __len__(self):
        return len(self._cards)

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

>>> fd[0]
card(rank='2', suit='spades')
>>> fd[0:2]
[card(rank='2', suit='spades'), card(rank='3', suit='spades')]
>>> for i in fd:
            print(i)
card(rank='2', suit='spades')
card(rank='3', suit='spades')
card(rank='4', suit='spades')
card(rank='5', suit='spades')
........

特别注意，虽然可以通过循环的形式取出对象中值，但并不代表它是一个可迭代对象，即使你在方法中返回的是字符串也可以循环，不过字符串循环会一直无限循环下去，直到你手动停止。主要原因是，因为在使用Obj[key]时，python解释器自动帮你调用了__getitem__(self,item)方法，所以只要不使用item这个参数，无论你传什么参数都不会报错，返回什么值是有你决定的

>>> isinstance(fd, collections.Iterable)
False

class A:

    def __getitem__(self, item):
        print("我被调用了")
        return item
if __name__ == '__main__':
    a = A()
    print(a["aaaa"])
# output 
# 我被调用了
# aaaa

__abs__方法

__abs__拥有此方法的可以直接使用abs()方法， 下面这个列子是模拟二维向量

from math import hypot
class Vector:

    def __init__(self, x=0, y=0):
        self.x = x
        self.y = y
        
    def __abs__(self):
        # hypot返回x和y的平方和的平方根
        return hypot(self.x, self.y)

>>> abs(Vector(1, 2)) # 返回向量(1, 2)的模
2.23606797749979

__add__方法

拥有此方法的可以使得类的实例进行相加，类似重载运算符

from math import hypot
class Vector:

    def __init__(self, x=0, y=0):
        self.x = x
        self.y = y
        
    def __abs__(self):
        # hypot返回x和y的平方和的平方根
        return hypot(self.x, self.y)
    
    def __add__(self, other):
        x = self.x + other.x
        y = self.y + other.y
        return Vector(x, y)
    
    def __repr__(self):
        # 相当于java中的toString方法, 稍后会讲这个方法
        return "Vector(%s, %s)" % (self.x, self.y)

>>> v1 = Vector(1, 2)
>>> v2 = Vector(3, 1)
>>> v1 + v2
Vector(4, 3)

即我可以通过修改类中的__add__方法来重载+运算符