5.5.?探索 UserDict：一個封裝類 · Dive Into Python

# 5.5.?探索 `UserDict`：一個封裝類如你所見，`FileInfo` 是一個有著像字典一樣的行為方式的類。為了進一步揭示這一點，讓我們看一看在 `UserDict` 模塊中的 `UserDict` 類，它是我們的 `FileInfo` 類的父類。它沒有什么特別的，也是用 Python 寫的，并且保存在一個 `.py` 文件里，就像我們其他的代碼。特別之處在于，它保存在你的 Python 安裝目錄的 `lib` 目錄下。 > 提示 > 在 Windows 下的 ActivePython IDE 中，你可以快速打開在你的庫路徑中的任何模塊，使用 File->Locate... (****Ctrl**-L**)。 ## 例?5.9.?定義 `UserDict` 類 ``` class UserDict: def __init__(self, dict=None): self.data = {} if dict is not None: self.update(dict) ``` | | | | --- | --- | | \[1\] | 注意 `UserDict` 是一個基類，不是從任何其他類繼承而來。 | | \[2\] | 這就是我們[在 `FileInfo` 類中進行了覆蓋](defining_classes.html#fileinfo.class.example "例?5.4.?定義 FileInfo 類")的 `__init__` 方法。注意這個父類的參數列表與子類不同。很好，每個子類可以擁有自已的參數集，只要使用正確的參數調用父類就可以了。這里父類有一個定義初始值的方法 (通過在 `dict` 參數中傳入一個字典)，這一方法我們的 `FileInfo` 沒有用上。 | | \[3\] | Python 支持數據屬性 (在 Java 和 Powerbuilder 中叫做 “實例變量”，在 C++ 中叫 “數據成員”)，它是由某個特定的類實例所擁有的數據。在本例中，每個 `UserDict` 實例將擁有一個 `data` 數據屬性。要從類外的代碼引用這個屬性，需要用實例的名字限定它，`_instance_.data`，限定的方法與你用模塊的名字來限定函數一樣。要在類的內部引用一個數據屬性，我們使用 `self` 作為限定符。習慣上，所有的數據屬性都在 `__init__` 方法中初始化為有意義的值。然而，這并不是必須的，因為數據屬性，像局部變量一樣，當你首次賦給它值的時候[突然產生](../native_data_types/declaring_variables.html "3.4.?變量聲明")。 | | \[4\] | `update` 方法是一個字典復制器：它把一個字典中的鍵和值全部拷貝到另一個字典。這個操作_并不_ 事先清空目標字典，如果一些鍵在目標字典中已經存在，則它們將被覆蓋，那些鍵名在目標字典中不存在的則不改變。應該把 `update` 看作是合并函數，而不是復制函數。 | | \[5\] | 這個語法你可能以前沒看過 (我還沒有在這本書中的例子中用過它)。這是一條 `if` 語句，但是沒有在下一行有一個縮近塊，而只是在冒號后面，在同一行上有單條語句。這完全是合法的，它只是當你在一個塊中僅有一條語句時的一個簡寫。(它就像在 C++ 中沒有用大括號包括的單行語句。) 你可以用這種語法，或者可以在后面的行寫下縮近代碼，但是不能對同一個塊同時用兩種方式。 | > 注意 > Java 和 Powerbuilder 支持通過參數列表的重載，_也就是_ 一個類可以有同名的多個方法，但這些方法或者是參數個數不同，或者是參數的類型不同。其它語言 (最明顯如 PL/SQL) 甚至支持通過參數名的重載，_也就是_ 一個類可以有同名的多個方法，這些方法有相同類型，相同個數的參數，但參數名不同。Python 兩種都不支持，總之是沒有任何形式的函數重載。一個 `__init__` 方法就是一個 `__init__` 方法，不管它有什么樣的參數。每個類只能有一個 `__init__` 方法，并且如果一個子類擁有一個 `__init__` 方法，它_總是_ 覆蓋父類的 `__init__` 方法，甚至子類可以用不同的參數列表來定義它。 > 注意 > Python 的原作者 Guido 是這樣解釋方法覆蓋的：“子類可以覆蓋父類中的方法。因為方法沒有特殊的優先級設置，父類中的一個方法在調用同類中的另一方法時，可能其實調用到的卻是一個子類中覆蓋父類同名方法的方法。 (C++ 程序員可能會這樣想：所有的 Python 方法都是虛函數。)”如果你不明白 (它令我頗感困惑)，不必在意。我想我要跳過它。\[3\] > 小心 > 應該總是在 `__init__` 方法中給一個實例的所有數據屬性賦予一個初始值。這樣做將會節省你在后面調試的時間，不必為捕捉因使用未初始化 (也就是不存在) 的屬性而導致的 `AttributeError` 異常費時費力。 ## 例?5.10.?`UserDict` 常規方法 ``` def clear(self): self.data.clear() def copy(self): if self.__class__ is UserDict: return UserDict(self.data) import copy return copy.copy(self) def keys(self): return self.data.keys() def items(self): return self.data.items() def values(self): return self.data.values() ``` | | | | --- | --- | | \[1\] | `clear` 是一個普通的類方法，可以在任何時候被任何人公開調用。注意，`clear` 像所有的類方法一樣 (常規的或專用的)，使用 `self` 作為它的第一個參數。(記住，當你調用方法時，不用包括 `self`；這件事是 Python 替你做的。) 還應注意這個封裝類的基本技術：將一個真正的字典 (`data`) 作為數據屬性保存起來，定義所有真正字典所擁有的方法，并且將每個類方法重定向到真正字典上的相應方法。(你可能已經忘了，字典的 `clear` 方法[刪除它的所有關鍵字](../native_data_types/index.html#odbchelper.dict.del "例?3.5.?從 dictionary 中刪除元素")和關鍵字相應的值。) | | \[2\] | 真正字典的 `copy` 方法會返回一個新的字典，它是原始字典的原樣的復制 (所有的鍵-值對都相同)。但是 `UserDict` 不能簡單地重定向到 `self.data.copy`，因為那個方法返回一個真正的字典，而我們想要的是返回同一個類的一個新的實例，就像是 `self`。 | | \[3\] | 我們使用 `__class__` 屬性來查看 `self` 是否是一個 `UserDict`，如果是，太好了，因為我們知道如何拷貝一個 `UserDict`：只要創建一個新的 `UserDict` ，并傳給它真正的字典，這個字典已經存放在 `self.data` 中了。然后你立即返回這個新的 `UserDict`，你甚至于不需要在下面一行中使用 `import copy`。 | | \[4\] | 如果 `self.__class__` 不是 `UserDict`，那么 `self` 一定是 `UserDict` 的某個子類 (如可能為 `FileInfo`)，生活總是存在意外。`UserDict` 不知道如何生成它的子類的一個原樣的拷貝，例如，有可能在子類中定義了其它的數據屬性，所以我們只能完全復制它們，確定拷貝了它們的全部內容。幸運的是，Python 帶了一個模塊可以正確地完成這件事，它叫做 `copy`。在這里我不想深入細節 (然而它是一個絕對酷的模塊，你是否已經想到要自已研究它了呢？)。說 `copy` 能夠拷貝任何 Python 對象就夠了，這就是我們在這里用它的原因。 | | \[5\] | 其余的方法是直截了當的重定向到 `self.data` 的內置函數上。 | > 注意 > 在 Python 2.2 之前的版本中，你不可以直接子類化字符串、列表以及字典之類的內建數據類型。作為補償，Python 提供封裝類來模擬內建數據類型的行為，比如：`UserString`、`UserList` 和 `UserDict`。通過混合使用普通和特殊方法，`UserDict` 類能十分出色地模仿字典。在 Python 2.2 和其后的版本中，你可以直接從 `dict` 內建數據類型繼承。本書 `fileinfo_fromdict.py` 中有這方面的一個例子。如例子中所示，在 Python 中，你可以直接繼承自內建數據類型 `dict`，這樣做有三點與 `UserDict` 不同。 ## 例?5.11.?直接繼承自內建數據類型 `dict` ``` class FileInfo(dict): "store file metadata" def __init__(self, filename=None): self["name"] = filename ``` | | | | --- | --- | | \[1\] | 第一個區別是你不需要導入 `UserDict` 模塊，因為 `dict` 是已經可以使用的內建數據類型。第二個區別是你不是繼承自 `UserDict.UserDict` ，而是直接繼承自 `dict`。 | | \[2\] | 第三個區別有些晦澀，但卻很重要。`UserDict` 內部的工作方式要求你手工地調用它的 `__init__` 方法去正確初始化它的內部數據結構。`dict` 并不這樣工作，它不是一個封裝所以不需要明確的初始化。 | ## 進一步閱讀 * _Python Library Reference_ 提供了 [`UserDict` 模塊](http://www.python.org/doc/current/lib/module-UserDict.html) 和 [`copy` 模塊](http://www.python.org/doc/current/lib/module-copy.html) 的文檔。 ## Footnotes \[3\] 實際上，這一點并不是那么難以理解。考慮兩個類，`base` 和 `child`，`base` 中的方法 `a` 需要調用 `self.b`；而我們又在 `child` 中覆蓋了方法 `b`。然后我們創建一個 `child` 的實例，`ch`。調用 `ch.a`，那么此時的方法 `a` 調用的 `b` 函數將不是 `base.b`，而是 `child.b`。――譯注