5.6. 专用类方法 · Dive Into Python

# 5.6. 专用类方法 * 5.6.1\. 获得和设置数据项除了普通的类方法，Python 类还可以定义专用方法。专用方法是在特殊情况下或当使用特别语法时由 Python 替你调用的，而不是在代码中直接调用 (像普通的方法那样)。就像你在[上一节](userdict.html "5.5. 探索 UserDict：一个封装类")所看到的，普通的方法对在类中封装字典很有帮助。但是只有普通方法是不够的，因为除了对字典调用方法之外，还有很多事情可以做的。例如，你可以通过一种没有包括明确方法调用的语法来[获得](../native_data_types/index.html#odbchelper.dict.define "例 3.1. 定义 Dictionary")和[设置](../native_data_types/index.html#odbchelper.dict.modify "例 3.2. 修改 Dictionary")数据项。这就是专用方法产生的原因：它们提供了一种方法，可以将非方法调用语法映射到方法调用上。 ## 5.6.1. 获得和设置数据项 ## 例 5.12. `__getitem__` 专用方法 ``` def __getitem__(self, key): return self.data[key] ``` ``` >>> f = fileinfo.FileInfo("/music/_singles/kairo.mp3") >>> f {'name':'/music/_singles/kairo.mp3'} >>> f.__getitem__("name") '/music/_singles/kairo.mp3' >>> f["name"] '/music/_singles/kairo.mp3' ``` | | | | --- | --- | | \[1\] | `__getitem__` 专用方法很简单。像普通的方法 `clear`，`keys` 和 `values` 一样，它只是重定向到字典，返回字典的值。但是怎么调用它呢？哦，你可以直接调用 `__getitem__`，但是在实际中你其实不会那样做：我在这里执行它只是要告诉你它是如何工作的。正确地使用 `__getitem__` 的方法是让 Python 来替你调用。 | | \[2\] | 这个看上去就像你用来[得到一个字典值](../native_data_types/index.html#odbchelper.dict.define "例 3.1. 定义 Dictionary")的语法，事实上它返回你期望的值。下面是隐藏起来的一个环节：暗地里，Python 已经将这个语法转化为 `f.__getitem__("name")` 的方法调用。这就是为什么 `__getitem__` 是一个专用类方法的原因，不仅仅是你可以自已调用它，还可以通过使用正确的语法让 Python 来替你调用。 | 当然，Python 有一个与 `__getitem__` 类似的 `__setitem__` 专用方法，参见下面的例子。 ## 例 5.13. `__setitem__` 专用方法 ``` def __setitem__(self, key, item): self.data[key] = item ``` ``` >>> f {'name':'/music/_singles/kairo.mp3'} >>> f.__setitem__("genre", 31) >>> f {'name':'/music/_singles/kairo.mp3', 'genre':31} >>> f["genre"] = 32 >>> f {'name':'/music/_singles/kairo.mp3', 'genre':32} ``` | | | | --- | --- | | \[1\] | 与 `__getitem__` 方法一样，`__setitem__` 简单地重定向到真正的字典 `self.data` ，让它来进行工作。并且像 `__getitem__` 一样，通常你不会直接调用它，当你使用了正确的语法，Python 会替你调用 `__setitem__` 。 | | \[2\] | 这个看上去像正常的字典语法，当然除了 `f` 实际上是一个类，它尽可能地打扮成一个字典，并且 `__setitem__` 是打扮的一个重点。这行代码实际上暗地里调用了 `f.__setitem__("genre", 32)`。 | `__setitem__` 是一个专用类方法，因为它可以让 Python 来替你调用，但是它仍然是一个类方法。就像在 `UserDict` 中定义 `__setitem__` 方法一样容易，我们可以在子类中重新定义它，对父类的方法进行覆盖。这就允许我们定义出在某些方面像字典一样动作的类，但是可以定义它自已的行为，超过和超出内置的字典。这个概念是本章中我们正在学习的整个框架的基础。每个文件类型可以拥有一个处理器类，这些类知道如何从一个特殊的文类型得到元数据。只要知道了某些属性 (像文件名和位置)，处理器类就知道如何自动地得到其它的属性。它的实现是通过覆盖 `__setitem__` 方法，检查特别的关键字，然后当找到后加入额外的处理。例如，`MP3FileInfo` 是 `FileInfo` 的子类。在设置了一个 `MP3FileInfo` 类的 `name` 时，并不只是设置 `name` 关键字 (像父类 `FileInfo` 所做的)，它还要在文件自身内进行搜索 MP3 的标记然后填充一整套关键字。下面的例子将展示其工作方式。 ## 例 5.14. 在 `MP3FileInfo` 中覆盖 `__setitem__` ``` def __setitem__(self, key, item): if key == "name" and item: self.__parse(item) FileInfo.__setitem__(self, key, item) ``` | | | | --- | --- | | \[1\] | 注意我们的 `__setitem__` 方法严格按照与父类方法相同的形式进行定义。这一点很重要，因为 Python 将替你执行方法，而它希望这个函数用确定个数的参数进行定义。(从技术上说，参数的名字没有关系，只是个数。) | | \[2\] | 这里就是整个 `MP3FileInfo` 类的难点：如果给 `name` 关键字赋一个值，我们还想做些额外的事情。 | | \[3\] | 我们对 `name` 所做的额外处理封装在了 `__parse` 方法中。这是定义在 `MP3FileInfo` 中的另一个类方法，则当我们调用它时，我们用 `self` 对其限定。仅是调用 `__parse` 将只会看成定义在类外的普通方法，调用 `self.__parse` 将会看成定义在类中的一个类方法。这不是什么新东西，你用同样的方法来引用[数据属性](userdict.html#fileinfo.userdict.normalmethods "例 5.10. UserDict 常规方法")。 | | \[4\] | 在做完我们额外的处理之后，我们需要调用父类的方法。记住，在 Python 中不会自动为你完成，需手工执行。注意，我们在调用直接父类，`FileInfo`，尽管它没有 `__setitem__` 方法。没问题，因为 Python 将会沿着父类树走，直到它找到一个拥有我们正在调用方法的类，所以这行代码最终会找到并且调用定义在 `UserDict` 中的 `__setitem__`。 | > 注意 > 当在一个类中存取数据属性时，你需要限定属性名：`self._attribute_`。当调用类中的其它方法时，你属要限定方法名：`self._method_`。 ## 例 5.15. 设置 `MP3FileInfo` 的 `name` ``` >>> import fileinfo >>> mp3file = fileinfo.MP3FileInfo() >>> mp3file {'name':None} >>> mp3file["name"] = "/music/_singles/kairo.mp3" >>> mp3file {'album': 'Rave Mix', 'artist': '***DJ MARY-JANE***', 'genre': 31, 'title': 'KAIRO****THE BEST GOA', 'name': '/music/_singles/kairo.mp3', 'year': '2000', 'comment': 'http://mp3.com/DJMARYJANE'} >>> mp3file["name"] = "/music/_singles/sidewinder.mp3" >>> mp3file {'album': '', 'artist': 'The Cynic Project', 'genre': 18, 'title': 'Sidewinder', 'name': '/music/_singles/sidewinder.mp3', 'year': '2000', 'comment': 'http://mp3.com/cynicproject'} ``` | | | | --- | --- | | \[1\] | 首先，我们创建了一个 `MP3FileInfo` 的实例，没有传递给它文件名。(我们可以不用它，因为 `__init__` 方法的 `filename` 参数是[可选的](../power_of_introspection/optional_arguments.html "4.2. 使用可选参数和命名参数")。) 因为 `MP3FileInfo` 没有它自已的 `__init__` 方法，Python 沿着父类树走，发现了 `FileInfo` 的 `__init__` 方法。这个 `__init__` 方法手工调用了 `UserDict` 的 `__init__` 方法，然后设置 `name` 关键字为 `filename`，它为 `None`，因为我们还没有传入一个文件名。所以，`mp3file` 最初看上去像是有一个关键字的字典，`name` 的值为 `None`。 | | \[2\] | 现在真正有趣的开始了。设置 `mp3file` 的 `name` 关键字触发了 `MP3FileInfo` 上的 `__setitem__` 方法 (而不是 `UserDict` 的)，这个方法注意到我们正在用一个真实的值来设置 `name` 关键字，接着调用 `self.__parse`。尽管我们完全还没有研究过 `__parse` 方法，从它的输出你可以看出，它设置了其它几个关键字：`album`、`artist`、`genre`、`title`、`year` 和 `comment`。 | | \[3\] | 修改 `name` 关键字将再次经受同样的处理过程：Python 调用 `__setitem__`，`__setitem__`调用 `self.__parse`，`self.__parse` 设置其它所有的关键字。 |