太好用！教你几招 Python 魔法方法的妙用

Jackpop

关注

发布于: 4 小时前

Python 是一种简单的编程语言，满足一个需求，可以有各种各样的实现方法。正是因为它可以通过各种串联满足很多复杂的逻辑，因此，对代码可读性关注度不高的开发者而言，会编写出很多复杂而令人难以理解的代码。

Python 语法本身虽然简单，但是要想实现可读性高，让其他开发者能够轻松理解的代码却是一项需要长时间学习和加强的技能。

而在这众多技能中，魔法方法（Magic Methods）便是其中一个很棒的选择，它允许用户在定义类的时候能够使用内置运算符和关键字，让使用类的方法更加直观明了。

魔法方法

如果你已经使用了一段时间 Python，那么一定了解或者接触过魔法方法。

魔法方法是一种以双下划线开头和结尾的一种特殊方法，在使用类的时候非常常见，例如，经常会用到的__init__。它的功能是作为构造函数，能够在类初始化时调用，你可以在初始化方法中定义一些初始化变量、初始化操作，当执行到类内部时，它会首先执行这些方法。

当然，魔法方法远不至于__init__，为了帮助大家理解 Python 魔法方法的价值，本文就以一个示例来开始本文的讲解。

下面通过实现一个名为TimePeriod的类，来看一下如何使用 Python 魔法方法使得代码更加清晰、可读性更高。

基础的`TimePeriod`类

下面TimePeriod主要实现 2 个方法：

时间的增加
时间的比较

基础的实现方法大多会是下面这样：

class TimePeriod:
    def __init__(self, hours=0, minutes=0):        self.hours = hours        self.minutes = minutes
    def add(self, other):        minutes = self.minutes + other.minutes        hours = self.hours + other.hours
        if minutes >= 60:            minutes -= 60            hours += 1
        return TimePeriod(hours, minutes)
    def greater_than(self, other):        if self.hours > other.hours:            returnTrue        elif self.hours < other.hours:            returnFalse        elif self.minutes > other.minutes:            returnTrue        else:            returnFalse

复制代码

实现add和greater_than两个方法，分别用于增加和对比时间大小。

或许，从这段代码中看不出有任何问题。接下来，我们使用这个类来看一下。

time_i_sleep = TimePeriod(9, 0)time_i_work = TimePeriod(0, 30)print(time_i_sleep.greater_than(time_i_work))# True

复制代码

这段代码在执行的时候没有任何问题，也不会报错。但是，如果你想要执行更为复杂的操作，例如，2 个时间段加和再和另外 2 个时间段的加和进行对比，类似于A+B与C+D进行比较，如果使用上述这个类，对比会是这样的：

time_i_sleep.add(time_i_watch_netflix).greater_than(time_i_work.add(time_i_do_chores))

复制代码

这样看上去是不是非常复杂？

即便是作为一名聪明的开发人员，把这段代码拆开执行，也会像下面这样复杂：

time_spent_unproductively = time_i_sleep.add(time_i_watch_netflix)time_spent_productively = time_i_work.add(time_i_do_chores)time_spent_unproductively.greater_than(time_spent_productively)

复制代码

魔法方法实现方式

其实在 Python 中，很容易就可以实现上述功能，Python 内置的有 2 个魔方方法__add__和__gt__分别对应于+和>运算。

现在，通过魔法方法来修改一下上面的类：

class TimePeriod:
    def __init__(self, hours=0, minutes=0):        self.hours = hours        self.minutes = minutes
    def __add__(self, other):        minutes = self.minutes + other.minutes        hours = self.hours + other.hours
        if minutes >= 60:            minutes -= 60            hours += 1
        return TimePeriod(hours, minutes)
    def __gt__(self, other):        if self.hours > other.hours:            returnTrue        elif self.hours < other.hours:            returnFalse        elif self.minutes > other.minutes:            returnTrue        else:            returnFalse

复制代码

现在，再来进行一下对比运算：

(time_i_sleep + time_i_watch_netflix) > (time_i_work + time_i_do_chores)

复制代码

这样看起来是不是更加容易理解和阅读了？

除此之外，你还可以加入更多魔法方法，实现更为丰富的功能。

例如，你想比较 2 个时间是否相等，会用到==运算，这时候你可以使用魔法方法__eq__，具体实现如下：

def __eq__(self, other):    return self.hours == other.hours and self.minutes == other.minutes

复制代码

Python 魔法方法不止有算术运算和和比较运算，还有其他很多丰富的功能。例如，__str__，可以创建易于理解类的字符串。

def __str__(self):    returnf"{self.hours} hours, {self.minutes} minutes"

复制代码

如果你需要，还可以通过__getitem__把类转化成字典：

def __getitem__(self, item):    if item == 'hours':        return self.hours    elif item == 'minutes':        return self.minutes    else:        raise KeyError()

复制代码

这样，可以把很多字典的优质特性加入到类中，可以像访问字典一样去访问类的属性。

其他

除了上述提到的一些魔法方法，Python 还有很多魔法方法值得使用。本文不再逐一举例，下面介绍一下一些常用方法的功能，需要的可以在以后编码中用一下。

__new__：初始化类的实例时会调用__init__方法，而在实际创建实例时会更早地调用__new__方法。
__call__：__call__方法允许我们的实例像方法或函数一样可调用。
__len__：这允许你自定义 Python 内置len()函数。
__repr__：这类似于__str__ 魔法方法，它允许你定义类的字符串表示形式。但是，区别在于__str__是针对最终用户的，它提供了一个更加用户友好的非正式字符串，而__repr__是针对开发人员的，并且可能包含有关类的内部状态的更复杂的信息。
__setitem__：前面示例中我们已经看过__getitem__方法，它主要用于获取键值，而__setitem__则用于设置键值。
__enter__和__exit__：这两种方法通常一起使用，可以将你的类用作上下文管理器，实现类似 Python 中with语句的功能。