如何使用 Pyramid 和 Cornice 編寫 Python Web API

使用 Pyramid 和 Cornice 構建和描述可擴充套件的 RESTful Web 服務。

Python 是一種高階的、物件導向的程式語言，它以其簡單的語法而聞名。它一直是構建 RESTful API 的頂級程式語言之一。

Pyramid 是一個 Python Web 框架，旨在隨著應用的擴充套件而擴充套件：這可以讓簡單的應用很簡單，也可以增長為大型、複雜的應用。此外，Pyramid 為 PyPI （Python 軟體包索引）提供了強大的支援。Cornice 為使用 Pyramid 構建和描述 RESTful Web 服務提供了助力。

本文將使用 Web 服務的例子來獲取名人名言，來展示如何使用這些工具。

建立 Pyramid 應用

首先為你的應用建立一個虛擬環境，並建立一個檔案來儲存程式碼：

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

匯入 Cornice 和 Pyramid 模組

使用以下命令匯入這些模組：

from pyramid.config import Configurator
from cornice import Service

定義服務

將引用服務定義為 Service 物件：

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

編寫引用邏輯

到目前為止，這僅支援獲取名言。用 QUOTES.get 裝飾函式。這是將邏輯繫結到 REST 服務的方法：

@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.']
        }
    }

請注意，與其他框架不同，裝飾器不會更改 get_quote 函式。如果匯入此模組，你仍然可以定期呼叫該函式並檢查結果。

在為 Pyramid RESTful 服務編寫單元測試時，這很有用。

定義應用物件

最後，使用 scan 查詢所有修飾的函式並將其新增到配置中：

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

預設掃描當前模組。如果要掃描軟體包中的所有模組，你也可以提供軟體包的名稱。

執行服務

我使用 Twisted 的 WSGI 伺服器執行該應用，但是如果需要，你可以使用任何其他 WSGI 伺服器，例如 Gunicorn 或 uWSGI。

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

預設情況下，Twisted 的 WSGI 伺服器執行在埠 8080 上。你可以使用 HTTPie 測試該服務：

(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 等一些引人注目的專案中使用。我喜歡 Pyramid，因為它是認真對待單元測試的框架之一：因為裝飾器不會修改函式並且沒有執行緒區域性變數，所以可以直接從單元測試中呼叫函式。例如，需要訪問資料庫的函式將從通過 request.config 傳遞的 request.config 物件中獲取它。這允許單元測試人員將模擬（或真實）資料庫物件放入請求中，而不用仔細設定全域性變數、執行緒區域性變數或其他特定於框架的東西。

如果你正在尋找一個經過測試的庫來構建你接下來的 API，請嘗試使用 Pyramid。你不會失望的。

---

via: https://opensource.com/article/20/1/python-web-api-pyramid-cornice

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

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

訂閱“Linux 中國”官方小程式來檢視