有关 Python 内编写类的各种技巧和方法(构建和初始化、重载操作符、类描述、属性访问控制、自定义序列、反射机制、可调用对象、上下文管理、构建描述符对象、Pickling)。 你可以把它当作一个教程,进阶,或者使用参考;我希望它能够成为一份针对 Python 方法的用户友好指南。
内容目录
介绍
构建和初始化
使操作符在自定义类内工作
神奇方法——比较
神奇方法——数字
描述你的类
属性访问控制
制作自定义序列
反射
可调用对象
上下文管理
构建描述符对象
Pickling 你的对象
总结
附录:如何调用神奇方法
专门建立的Python学习扣QUN:⑦⑧④⑦⑤⑧②①④ 从零基础开始到Python各领域的项目实战教程、开发工具与电子书籍。与你分享企业当下对于python人才需求及学好python的高效技巧,不停更新最新教程!点击加入我们的 python学习圈
1.介绍
这份指南是几个月内最有价值的 Blog 投稿精华。它的主题是向大家讲述 Python 中的神奇方法。
何为神奇方法呢?它们是面向 Python 中的一切,是一些特殊的方法允许在自己的定义类中定义增加“神奇”的功能。它们总是使用双下划线(比如 __ init__ 或 __ lt__),但它们的文档没有很好地把它们表现出来。所有这些神奇方法都出现在Python的官方文档中,但内容相对分散,组织结构也显得松散。还有你会难以发现一个实例(虽然他们被设计很棒,在语言参考中被详细描述,可之后就会伴随着枯燥的语法描述等)。
所以,为了解决我认为在 Python 文档中的一大败笔,我打算用更多纯英语,实例驱动的文档来说明 Python 的神奇方法。然后我就开始花了几周的时间来写 blog,而现在我已经完成了它们,并将它们合订成一份指南。
我希望你喜欢它。把它当作一个教程,进阶,或者使用参考;我希望它能够成为一份针对 Python 方法的用户友好指南。
2.构建和初始化
相信大家都熟悉这个最基础的神奇方法 __ init__。它令你能自定义一个对象的初始化行为。而当我调用x=SomeClass() 时, init 并不是最先被调用的。实际上有一个叫做 new 的方法,事实上是它创建了实例,它传递任何参数给初始化程序来达到创建的目的。在对象生命周期结束时,调用 del。让我们更近地观察下这 3 个神奇方法吧:
- __ new__(cls,[…)
一个对象的实例化时 __ new__ 是第一个被调用的方法。在类中传递其他任何参数到 __ init__。__new__很少被使用,这样做确实有其目的,特别是当一个子类继承一个不可改变的类型(一个元组或一个字符串)时。我不打算再继续深入追求 new 的细节了,因为这不会产生多大用处,因为在 Python Docs 内已经涵盖了一份巨详细的说明了。
- __ init__(self,[…)
类的初始化。它会获得初始构建调用传过来的任何东西(举例来说就是,当我们调用x=SomeClass(10,‘foo’),__ init__ 就会把传过来的 10 和 ‘foo’ 作为参数。__init__在 Python 的类定义中几乎普遍被使用)
- __ del__(self)
如果 __ new__和 init 是对象的构造器,那么 del 就是析构器。它不实现声明为del x(这样的代码不会解释成 x. del())的行为。相反,它定义为当一个对象被垃圾回收时的行为。这可能对可能需要额外清理的对象相当有用,比如 sockets 或文件对象。但要小心,如果对象仍处于存活状态而当被解释退出时, del 没有保证就会被执行,因此这样的 del 不能作为良好的编码规范的替代。(就像当你完成操作总是要关闭一次连接。但事实上, del 几乎永远不会执行,就因为它处于不安全情况被调用了。使用时保持警惕!)
把上述这些内容合在一起,就成了一份 __ init__ 和 __ del__ 的实际使用用例:
from os.path import join
class FileObject:
'''对文件对象的包装,确保文件在关闭时得到删除'''
def __init__(self, filepath='~', filename='sample.txt'):
# 按filepath,读写模式打开名为filename的文件
self.file=open(join(filepath,filename), 'r+')
def __del__(self):
self.file.close()
del self.file
3.使操作符在自定义类内工作
使用 Python 神奇方法的优势之一就是它提供了一种简单的方式能让对象的行为像内建类型。这意味着你可以避免用丑陋,反直觉和非标准方法执行基本运算。在某些语言中,通常会这样做:
if instance.equals(other_instance):
# do something
你也应该在 Python 确实会这样做,但同时它会增加用户的疑惑以及不必要的冗长。不同的库可能会对相同的运算采用不同的命名,这使得用户比平常干了更多的事。依靠神奇方法的力量,你可以定义一个方法(比如 __ eq__),然后带代替我们真实的意图:
if instance == other_instance:
# do something
现在你看到的是神奇方法力量的一部分。绝大多数都允许我们定义为运算符本身的意义,当用在我们自己定义的类上就像它们是内建类型。
3.1 神奇方法——比较
Python 有一整套神奇方法被设计用来通过操作符实现对象间直观的比较,而非别扭的方法调用。它们同样提供了一套覆盖 Python 对象比较的默认行为(通过引用)。以下是这些方法的列表以及做法:
__ cmp__(self, other)
__ cmp__是神奇方法中最基础的一个。实际上它实现所有比较操作符行为(<,==,!=,等),但它有可能不按你想要的方法工作(例如,一个实例是否等于另一个这取决于比较的准则,以及一个实例是否大于其他的这也取决于其他的准则)。如果 self < other,那 cmp 应当返回一个负整数;如果 self == other,则返回 0;如果 self > other,则返回正整数。它通常是最好的定义,而不需要你一次就全定义好它们,但当你需要用类似的准则进行所有的比较时, cmp 会是一个很好的方式,帮你节省重复性和提高明确度。
__ eq__(self, other)
定义了相等操作符,==的行为。
__ ne__(self, other)
定义了不相等操作符,!= 的行为。
__ lt__(self, other)
定义了小于操作符,< 的行为。
__ gt__(self, other)
定义了大于操作符,> 的行为。
__ le__(self, other)
定义了小于等于操作符,<=的行为。
__ ge__(self, other)
定义了大于等于操作符,>= 的行为。
举一个例子,设想对单词进行类定义。我们可能希望能够按内部对 string 的默认比较行为,即字典序(通过字母)来比较单词,也希望能够基于某些其他的准则,像是长度或音节数。在本例中,我们通过单词长度排序,以下给出实现:
class Word(str):
'''单词类,比较定义是基于单词长度的'''
def __new__(cls, word):
# 注意,我们使用了__new__,这是因为str是一个不可变类型,
# 所以我们必须更早地初始化它(在创建时)
if ' ' in word:
print "单词内含有空格,截断到第一部分"
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)
现在,我们可以创建 2 个单词(通过 Word(‘foo’) 和 Word(‘bar’))并基于它们的长度进行比较了。注意,我们没有定义 __ eq__ 和 __ ne__。这是因为这可能导致某些怪异的行为(特别是当比较 Word(‘foo’) == Word(‘bar’) 将会得到 True 的结果)。基于单词长度的相等比较会令人摸不清头脑,因此我们就沿用了str 本身的相等比较的实现。
现在可能是一个好时机来提醒你一下,你不必重载每一