藉助 zope.interface 深入了解 Python 介面

zope.interface 庫可以克服 Python 介面設計中的歧義性。讓我們來研究一下。

隱式介面不是 Python 之禪

Python 之禪 很寬鬆，但是有點自相矛盾，以至於你可以用它來例證任何東西。讓我們來思考其中最著名的原則之一：「顯示勝於隱式」。

傳統上，在 Python 中會隱含的一件事是預期的介面。比如函數已經記錄了它期望一個「類文件對象」或「序列」。但是什麼是類文件對象呢？它支持 .writelines嗎？.seek 呢？什麼是一個「序列」？是否支持步進切片，例如 a[1:10:2]？

最初，Python 的答案是所謂的「鴨子類型」，取自短語「如果它像鴨子一樣行走，像鴨子一樣嘎嘎叫，那麼它可能就是鴨子」。換句話說，「試試看」，這可能是你能得到的最具隱式的表達。

為了使這些內容顯式地表達出來，你需要一種方法來表達期望的介面。Zope Web 框架是最早用 Python 編寫的大型系統之一，它迫切需要這些東西來使代碼明確呈現出來，例如，期望從「類似用戶的對象」獲得什麼。

zope.interface 由 Zope 開發，但作為單獨的 Python 包發布。Zope.interface 可以幫助聲明存在哪些介面，是由哪些對象提供的，以及如何查詢這些信息。

想像編寫一個簡單的 2D 遊戲，它需要各種東西來支持精靈界面（LCTT 譯註：「 精靈 Sprite 」是指遊戲面板中各個組件）。例如，表示一個邊界框，但也要表示對象何時與一個框相交。與一些其他語言不同，在 Python 中，將屬性訪問作為公共介面一部分是一種常見的做法，而不是實現 getter 和 setter。邊界框應該是一個屬性，而不是一個方法。

呈現精靈列表的方法可能類似於：

def render_sprites(render_surface, sprites):
    """
    sprites 應該是符合 Sprite 介面的對象列表：
    * 一個名為 "bounding_box" 的屬性，包含了邊界框
    * 一個名為 "intersects" 的方法，它接受一個邊界框並返回 True 或 False
    """
    pass # 一些做實際渲染的代碼

該遊戲將具有許多處理精靈的函數。在每個函數中，你都必須在隨附文檔中指定預期。

此外，某些函數可能期望使用更複雜的精靈對象，例如具有 Z 序的對象。我們必須跟蹤哪些方法需要 Sprite 對象，哪些方法需要 SpriteWithZ 對象。

如果能夠使精靈是顯式而直觀的，這樣方法就可以聲明「我需要一個精靈」，並有個嚴格定義的介面，這不是很好嗎？來看看 zope.interface。

from zope import interface

class ISprite(interface.Interface):

    bounding_box = interface.Attribute(
        "邊界框"
    )

    def intersects(box):
        "它和一個框相交嗎？"

乍看起來，這段代碼有點奇怪。這些方法不包括 self，而包含 self 是一種常見的做法，並且它有一個屬性。這是在 zope.interface 中聲明介面的方法。這看起來很奇怪，因為大多數人不習慣嚴格聲明介面。

這樣做的原因是介面顯示了如何調用方法，而不是如何定義方法。因為介面不是超類，所以它們可以用來聲明數據屬性。

下面是一個能帶有圓形精靈的介面的一個實現：

@implementer(ISprite)
@attr.s(auto_attribs=True)
class CircleSprite:
    x: float
    y: float
    radius: float

    @property
    def bounding_box(self):
        return (
            self.x - self.radius,
            self.y - self.radius,
            self.x + self.radius,
            self.y + self.radius,
        )

    def intersects(self, box):
        # 當且僅當至少一個角在圓內時，方框與圓相交
        top_left, bottom_right = box[:2], box[2:]
        for choose_x_from (top_left, bottom_right):
            for choose_y_from (top_left, bottom_right):
                x = choose_x_from[0]
                y = choose_y_from[1]
                if (((x - self.x) ` 2 + (y - self.y) ` 2) <=
                    self.radius ` 2):
                     return True
        return False

這顯式聲明了實現了該介面的 CircleSprite 類。它甚至能讓我們驗證該類是否正確實現了介面：

from zope.interface import verify

def test_implementation():
    sprite = CircleSprite(x=0, y=0, radius=1)
    verify.verifyObject(ISprite, sprite)

這可以由 pytest、nose 或其他測試框架運行，它將驗證創建的精靈是否符合介面。測試通常是局部的：它不會測試僅在文檔中提及的內容，甚至不會測試方法是否可以在沒有異常的情況下被調用！但是，它會檢查是否存在正確的方法和屬性。這是對單元測試套件一個很好的補充，至少可以防止簡單的拼寫錯誤通過測試。

via: https://opensource.com/article/19/9/zopeinterface-python-package

作者：Moshe Zadka 選題：lujun9972 譯者：MjSeven 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive