[[313078]]

使用 Pyramid 和 Cornice 構(gòu)建和描述可擴(kuò)展的 RESTful Web 服務(wù)。

Python 是一種高級(jí)的、面向?qū)ο蟮木幊陶Z(yǔ)言，它以其簡(jiǎn)單的語(yǔ)法而聞名。它一直是構(gòu)建 RESTful API 的頂級(jí)編程語(yǔ)言之一。

Pyramid 是一個(gè) Python Web 框架，旨在隨著應(yīng)用的擴(kuò)展而擴(kuò)展：這可以讓簡(jiǎn)單的應(yīng)用很簡(jiǎn)單，也可以增長(zhǎng)為大型、復(fù)雜的應(yīng)用。此外，Pyramid 為 PyPI （Python 軟件包索引）提供了強(qiáng)大的支持。Cornice 為使用 Pyramid 構(gòu)建和描述 RESTful Web 服務(wù)提供了助力。

本文將使用 Web 服務(wù)的例子來(lái)獲取名人名言，來(lái)展示如何使用這些工具。

建立 Pyramid 應(yīng)用

首先為你的應(yīng)用創(chuàng)建一個(gè)虛擬環(huán)境，并創(chuàng)建一個(gè)文件來(lái)保存代碼：

$ mkdir tutorial
$ cd tutorial
$ touch main.py
$ python3 -m venv env
$ source env/bin/activate
(env) $ pip3 install cornice twisted

導(dǎo)入 Cornice 和 Pyramid 模塊

使用以下命令導(dǎo)入這些模塊：

from pyramid.config import Configurator
from cornice import Service

定義服務(wù)

將引用服務(wù)定義為 Service 對(duì)象：

QUOTES = Service(name='quotes',
                 path='/',
                 description='Get quotes')

編寫引用邏輯

到目前為止，這僅支持獲取名言。用 QUOTES.get 裝飾函數(shù)。這是將邏輯綁定到 REST 服務(wù)的方法：

@QUOTES.get()
def get_quote(request):
    return {
        'William Shakespeare': {
            'quote': ['Love all, trust a few, do wrong to none',
            'Some are born great, some achieve greatness, and some have greatness thrust upon them.']
    },
    'Linus': {
        'quote': ['Talk is cheap. Show me the code.']
        }
    }

請(qǐng)注意，與其他框架不同，裝飾器不會(huì)更改 get_quote 函數(shù)。如果導(dǎo)入此模塊，你仍然可以定期調(diào)用該函數(shù)并檢查結(jié)果。

在為 Pyramid RESTful 服務(wù)編寫單元測(cè)試時(shí)，這很有用。

定義應(yīng)用對(duì)象

最后，使用 scan 查找所有修飾的函數(shù)并將其添加到配置中：

with Configurator() as config:
    config.include("cornice")
    config.scan()
    application = config.make_wsgi_app()

默認(rèn)掃描當(dāng)前模塊。如果要掃描軟件包中的所有模塊，你也可以提供軟件包的名稱。

運(yùn)行服務(wù)

我使用 Twisted 的 WSGI 服務(wù)器運(yùn)行該應(yīng)用，但是如果需要，你可以使用任何其他 WSGI 服務(wù)器，例如 Gunicorn 或 uWSGI。

(env)$ python -m twisted web --wsgi=main.application

默認(rèn)情況下，Twisted 的 WSGI 服務(wù)器運(yùn)行在端口 8080 上。你可以使用 HTTPie 測(cè)試該服務(wù)：

(env) $ pip install httpie
...
(env) $ http GET <http://localhost:8080/>
HTTP/1.1 200 OK
Content-Length: 220
Content-Type: application/json
Date: Mon, 02 Dec 2019 16:49:27 GMT
Server: TwistedWeb/19.10.0
X-Content-Type-Options: nosniff
 
{
    "Linus": {
        "quote": [
            "Talk is cheap. Show me the code."
        ]
    },
    "William Shakespeare": {
        "quote": [
            "Love all,trust a few,do wrong to none",
            "Some are born great, some achieve greatness, and some greatness thrust upon them."
        ]
    }
}

為什么要使用 Pyramid？

Pyramid 并不是最受歡迎的框架，但它已在 PyPI 等一些引人注目的項(xiàng)目中使用。我喜歡 Pyramid，因?yàn)樗钦J(rèn)真對(duì)待單元測(cè)試的框架之一：因?yàn)檠b飾器不會(huì)修改函數(shù)并且沒(méi)有線程局部變量，所以可以直接從單元測(cè)試中調(diào)用函數(shù)。例如，需要訪問(wèn)數(shù)據(jù)庫(kù)的函數(shù)將從通過(guò) request.config 傳遞的 request.config 對(duì)象中獲取它。這允許單元測(cè)試人員將模擬（或真實(shí)）數(shù)據(jù)庫(kù)對(duì)象放入請(qǐng)求中，而不用仔細(xì)設(shè)置全局變量、線程局部變量或其他特定于框架的東西。

如果你正在尋找一個(gè)經(jīng)過(guò)測(cè)試的庫(kù)來(lái)構(gòu)建你接下來(lái)的 API，請(qǐng)嘗試使用 Pyramid。你不會(huì)失望的。