文/IT可达鸭

图/IT可达鸭、网络

前言

每个学习python的人都会对这些原生的数据结构有一定的了解，python底层给我们提供了多种多样的原生数据结构，例如：list、set、dict等等。同样的，原生数据结构所定义的基本方法，也是大家所熟悉的，例如：len()、str()、int()等等。当然还有，我们最最熟悉的比较操作符，例如：>=、==、<=等等。还有运算操作符、容器操作等等。

魔术方法

我现在告诉你，其实上面这些原生数据结构、操作符、运算符都可以自定义，而且非常简单。在一些有趣的源码中，为了程序设计方便，会使用一些自定义的数据结构。如果你有阅读python源码的习惯，也会碰到一些奇怪的函数定义，实际调用方法却是常用原生方法。

举个例子

刚好最近在做项目，需要用到自定义的数据结构，就拿出这块代码来给大家分享一下。为了让初学者能更好的理解，我把业务相关的代码都去除，做一个简单的学习例子。

场景

在开发中，我们发现set() 这个数据结构无序的。就是不同时刻去遍历 set() 里面的数据，都会输出不同的结果。

s = {'a', 'b', 'c'}
print(s)

第一次输出： {'c', 'b', 'a'}
第二次输出： {'a', 'b', 'c'}
第三次输出： {'c', 'a', 'b'}

需求

这里提出一个需求，设计一个像set() 一样的数据结构，但是它必须是有序的。

实现

首先设计一个类，这里我们用 list() 来实现。分别实现三个功能：添加元素、删除元素、对元素进行排序。

class SetOrder(object):
    def __init__(self, value=None) -> None:
        self._value = list()
        if value is not None:
            if isinstance(value, list) or isinstance(value, set):
                for item in value:
                    self.push(item)
                self.order()


    # 添加元素
    def push(self, item):
        if item not in self._value:
            self._value.append(item)


    # 删除元素
    def pop(self, item):
        if item in self._value:
            self._value.remove(item)


    # 对元素进行排序
    def order(self, reverse=False):
        self._value.sort(reverse=revers

对象 set_order 初始化后，调用一下原生的str()。

s = {'a', 'b', 'c'}
set_order = SetOrder(s)
print(str(set_order))  # 调用str()函数

输出结果：

<__main__.SetOrder object at 0x000002B86A788710>

很明显，这个并不是我们要的结果。我们要的是，输出集合里面的所有元素，而不是它的内存地址。那么，我们要怎么做呢？就是使用python的魔术方法，也就是函数重载。类的代码修改如下：

class SetOrder(object):


    ......
      
    # 定义当被 str() 调用时的行为
    def __str__(self):
        return ",".join([str(i) for i in self._value])

再次调用str()函数

s = {'a', 'b', 'c'}
set_order = SetOrder(s)
print(str(set_order))  # 调用str()函数

输出结果：

a,b,c

同样道理，我们对 len()、in 或not in、比较操作符==，进行重载。

class SetOrder(object):


    ......


    # 定义当被 len() 调用时的行为
    def __len__(self):
        return len(self._value)


    # 定义当使用成员测试运算符（in 或 not in）时的行为
    def __contains__(self, item):
        return item in self._value


    # 比较操作符  ==
    def __eq__(self, other):
        if len(self) != len(other):
            return False


        for item in self._value:
            if item not in other:
                return False
        return 

接下来，我们来逐个验证魔术方法的调用。

新建两个有序set(), 并输出str()

print("新建两个有序set(): set_order, order, 并初始化：")
set_order = SetOrder({'a', 'b', 'c'})
print(str(set_order))


other = SetOrder(['a', 'b', 'c', 'd', 'a'])
print(str(other))

str()的输出结果：

新建两个有序set(): set_order, order, 并初始化：
a,b,c
a,b,c,d

测试比较操作符

print("比较操作符")
print("set_order == other: ", set_order == other)
other.pop('d')
print("set_order == other: ", set_order == other)

比较操作符的输出结果：

比较操作符
set_order == other:  False
set_order == other:  True

测试 in 和 not in 操作符

print(" in 和 not in 操作符")
print('d 是否存在： ', 'd' in other)
print('d 是否存在： ', 'd' not in other)

in 和 not in 操作符 的输出结果

in 和 not in 操作符
d 是否存在：  False
d 是否存在：  True

Python中所有的魔术方法均在官方文档中有相应描述，但是官方的描述比较模糊。如果没有一个简单明了的例子，刚入门的小伙伴很难理解。

以上，对几个常用的魔术方法做了示例。如果大家在学习过程中有遇到双下划线包起来的方法，可能就是魔术方法，可以通过本文了解如何使用魔术方法。其余的魔术方法，使用方式都是大同小异。

结语

学习python，不需要一杯奶茶钱，只需要你点个关注。如果觉得小编的文章对你有帮助，记得点个赞，顺便帮我分享出去。有什么不明白的地方，欢迎在下方评论，或私信小编。最后，感谢大家的阅读，祝大家生活愉快。

本文由 IT可达鸭 原创，欢迎关注，带你一起长知识！