日常 Python 程式設計優雅之道 | Linux 中國

讓我們看看在我喜歡的一個名為 agithub[10] 的庫中的一些示例程式碼中，這個方法魔術是如何結合在一起的，這是一個（名字起得很 low 的） REST API 客戶端，它具有透明的語法，允許你以最小的配置快速構建任何 REST API 原型（不僅僅是 GitHub）。我發現這個專案很有趣，因為它非常強大，但只有大約 400 行 Python 程式碼。你可以在大約 30 行配置程式碼中新增對任何 REST API 的支援。agithub 知道協議所需的一切（REST、HTTP、TCP），但它不考慮上游 API。讓我們深入到它的實現中。

以下是我們如何為 GitHub API 和任何其他相關連線屬性定義端點 URL 的簡化版本。在這裡檢視完整程式碼[11]。

class GitHub(API):
    def __init__(self, token=None, *args, **kwargs):
        props = ConnectionProperties(api_url = kwargs.pop('api_url', 'api.github.com'))
        self.setClient(Client(*args, **kwargs))
        self.setConnectionProperties(props)

然後，一旦配置了訪問令牌[12]，就可以開始使用 GitHub API[13]。

>>> gh = GitHub('token')
>>> status, data = gh.user.repos.get(visibility='public', sort='created')
>>> # ^ 對映到 GET /user/repos
>>> data
... ['tweeter', 'snipey', '...']

請註意，你要確保 URL 拼寫正確，因為我們沒有驗證 URL。如果 URL 不存在或出現了其他任何錯誤，將傳回 API 丟擲的錯誤。那麼，這一切是如何運作的呢？讓我們找出答案。首先，我們將檢視一個 API 類[14]的簡化示例：

class API:
    # ... other methods ...
    def __getattr__(self, key):
        return IncompleteRequest(self.client).__getattr__(key)
    __getitem__ = __getattr__

在 API 類上的每次呼叫都會呼叫 IncompleteRequest 類[15]作為指定的 key。

class IncompleteRequest:
    # ... other methods ...
    def __getattr__(self, key):
        if key in self.client.http_methods:
            htmlMethod = getattr(self.client, key)
            return partial(htmlMethod, url=self.url)
        else:
            self.url += '/' + str(key)
            return self
    __getitem__ = __getattr__
class Client:
    http_methods = ('get')  # 還有 post, put, patch 等等。
    def get(self, url, essay-headers={}, **params):
        return self.request('GET', url, None, essay-headers)

>>> status, data = this.path.doesnt.exist.get()
>>> status
... 404

>>> owner, repo = 'nnja', 'tweeter'
>>> status, data = gh.repos[owner][repo].pulls.get()
>>> # ^ Maps to GET /repos/nnja/tweeter/pulls
>>> data
.... # {....}