如何使用 Pyramid 和 Cornice 編寫 Python Web API
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
本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive