《零基础入门学习Python》第046讲：魔法方法：描述符（Property的原理）

0. 请写下这一节课你学习到的内容：格式不限，回忆并复述是加强记忆的好方式！

常言道：“无规矩不成方圆”，讲的是万事万物的发展都要在一定的规则下去运行，只有遵循一定的协议去做，事情才能够按照正确的道路去发展。我们今天要谈的是 定制容器，想要成功的实现容器的定制，我们要先谈一谈协议，那么什么是协议呢？

（1）协议是什么？

协议（Protlcols）与其他编程语言中的接口很相似，它规定你在哪些地方必须定义哪些东西。然而，在Python中的协议就显得不那么正式了。事实上，Python中的协议更像是一种指南，一种建议。

例如，我们之前谈到的鸭子类型（DuckTyping）：当看到一只鸟走起来像鸭子、游泳起来像鸭子、叫起来也像鸭子，那么这只鸟就可以被称为鸭子。

Python就是这样，它并不会严格要求你要怎样去做，而是靠你自觉和经验去把事情做得更好。

（2）定制容器

在Python中，序列类型（例如：列表，元组，字符串）或者映射类型（例如：字典）都是属于容器类型，它们都是里面存放各式各样的对象。那么这一节课我们就来谈定制容器。

我们需要知道的是有关定义容器的协议。这里有两种区分：

如果说你希望定制的容器是不可变的话（例如元组、字符串），你只需要定义  __len__() 和 __getitem__() 方法。

如果说你希望定制的容器是可变的话，那么除了 需要定义  __len__() 和 __getitem__() 方法之外，你还需要定义 __setitem__() 和 __delitem__() 两个方法。

有关Python魔法方法的讲解如果忘了的，可以看一下->Python魔法方法详解。

（3）练习

编写一个不可改变的自定义列表，要求记录列表中每个元素被访问的次数。

参数是可变数量的 （*args），因为我们不知道用户要传入多少个数据，我们把用户输入的数据初始化为一个列表，self.values 就是一个列表，我们通过列表推导式的形式把数据存放到 self.values 这个列表中。另外，还需要记录列表中每个元素被访问的次数，我们立刻会想到字典，我们把每个元素在列表中的下标作为字典的键，然后值就是累计的访问次数。我们定义 self.count 这个字典，初始化可以使用 fromkeys ，并把所有下标对应的Key所对应的值初始化为0。我们这是一个不可变的容器，所以需要定义  __len__() 和 __getitem__() 方法，  __len__() 就直接是返回 len(self.values) 的值，__getitem__() 中的 key 就是对应的下标，我们这里是获取key对应的值，所以需要返回self.values[key]，另外，对应着访问了它一次，所以对应的 self.count[key] 加1。

1. class CountList:

2. def __init__(self, *args):

3. self.values = [x for x in args]

4. self.count = {}.fromkeys(range(len(self.values)), 0)

6. def __len__(self):

7. return len(self.values)

9. def __getitem__(self, key):

10. self.count[key] += 1

11. return self.values[key]

验证运行：

1. >>> c1 = CountList(1, 3, 5, 7, 9)

2. >>> c2 = CountList(2, 4, 6, 8, 10)

3. >>> c1.count

4. {0: 0, 1: 0, 2: 0, 3: 0, 4: 0}

5. >>> c2.count

6. {0: 0, 1: 0, 2: 0, 3: 0, 4: 0}

7. >>> c1[1]

8. 3

9. >>> c1.count

10. {0: 0, 1: 1, 2: 0, 3: 0, 4: 0}

11. >>> c1[2] + c2[2]

12. 11

13. >>> c1.count

14. {0: 0, 1: 1, 2: 1, 3: 0, 4: 0}

15. >>> c2.count

16. {0: 0, 1: 0, 2: 1, 3: 0, 4: 0}

---

测试题（笔试，不能上机哦~）

0. 你知道 Python 基于序列的三大容器类指的是什么吗？

答：无疑是列表（List），元组（Tuple）和字符串（String）啦。G

1. Python 允许我们自己定制容器，如果你想要定制一个不可变的容器（像 String），你就不能定义什么方法？

答：如果你想要定制一个不可变的容器（像 String），你就不能定义像 __setitem__() 和 __delitem__() 这些会修改容器中的数据的方法。

2. 如果希望定制的容器支持 reversed() 内置函数，那么你应该定义什么方法？

答：应该定义 __reversed__() 方法，提供对内置函数 reversed() 的支持。

3. 既然是容器，必然要提供能够查询“容量”的方法，那么请问需要定义什么方法呢？

答：在 Python 中，我们通过 len() 内置函数来查询容器的“容量”，所以容器应该定义 __len__() 方法。L

4. 通过定义哪些方法使得容器支持读、写和删除的操作？

答：读 —— __getitem__()，写 —— __setitem__()，删除 —— __delitem__(),"u

5. 为什么小甲鱼说“在 Python 中的协议就显得不那么正式”？

答：在 Python 中，协议更像是一种指南。这有点像我们之前在课后作业中提到的“鸭子类型”（忘了的朋友请戳：鸭子类型（duck typing）_来自江南的你的博客-CSDN博客） —— 当看到一只鸟走起来像鸭子、游泳起来像鸭子、叫起来也像鸭子，那么这只鸟就可以被称为鸭子。Python就是这样，并不会严格地要求你一定要怎样去做，而是让你靠着自觉和经验把事情做好！

---

动动手（一定要自己动手试试哦~）

0. 根据课堂上的例子，定制一个列表，同样要求记录列表中每个元素被访问的次数。

这一次我们希望定制的列表功能更加全面一些，比如支持 append()、pop()、extend() 原生列表所拥有的方法。你应该如何修改呢？

要求1：实现获取、设置和删除一个元素的行为（删除一个元素的时候对应的计数器也会被删除）
要求2：增加 counter(index) 方法，返回 index 参数所指定的元素记录的访问次数
要求3：实现 append()、pop()、remove()、insert()、clear() 和 reverse() 方法（重写这些方法的时候注意考虑计数器的对应改变）

今天只有一道动动手的题目，但在写代码的时候要时刻考虑到你的列表增加了计数器功能，所以请务必要考虑周全再提交答案。

附课堂上的例子：

1. class CountList:

2. def __init__(self, *args):

3. self.values = [x for x in args]

4. self.count = {}.fromkeys(range(len(self.values)), 0)

6. def __len__(self):

7. return len(self.values)

9. def __getitem__(self, key):

10. self.count[key] += 1

11. return self.values[key]

代码清单：

1. class CountList(list):

2. def __init__(self, *args):

3. super().__init__(args)

4. self.count = []

5. for i in args:

6. self.count.append(0)

8. def __len__(self):

9. return len(self.count)

11. def __getitem__(self, key):

12. self.count[key] += 1

13. return super().__getitem__(key)

15. def __setitem__(self, key, value):

16. self.count[key] += 1

17. super().__setitem__(key, value)

19. def __delitem__(self, key):

20. del self.count[key]

21. super().__delitem__(key)

23. def counter(self, key):

24. return self.count[key]

26. def append(self, value):

27. self.count.append(0)

28. super().append(value)

30. def pop(self, key=-1):

31. del self.count[key]

32. return super().pop(key)

34. def remove(self, value):

35. key = super().index(value)

36. del self.count[key]

37. super().remove(value)

39. def insert(self, key, value):

40. self.count.insert(key, 0)

41. super().insert(key, value)

43. def clear(self):

44. self.count.clear()

45. super().clear()

47. def reverse(self):

48. self.count.reverse()

49. super().reverse()