原文地址: https://healeycodes.com/my-own-python-web-framework
在過去的幾個月里,我一直在從頭開始建立我自己的軟體工具--像編程語言、文本編輯器和CLI工具,在周末,我建立了一個概念驗證的網路框架,通過Build Output API部署到Vercel,
一個基于檔案系統的規范,允許任何框架為Vercel構建,并利用Vercel的基礎設施構建塊,如邊緣函式、邊緣中間件、增量靜態再生(ISR)、影像優化等,
Jar是一個玩具Python網路框架,用大約200行代碼實作(見 cli.py ),我建立它是為了探索一些圍繞框架API的想法,并從作者方面探索框架,請不要真的使用它,它之所以被稱為Jar,是因為它幾乎沒有任何功能,你需要自己去填充它!
它使用檔案系統路由并支持,
-
建立頁面,又稱靜態檔案
-
重繪頁面,又稱無服務器功能
-
重新生成的頁面,又稱預渲染功能
Jar專案的結構是這樣的:
project/
├─ pages/
│ ├─ index.py
├─ public/
│ ├─ favicon.ico
API理念
我對Jar的個人使用情況是在沒有前臺框架的情況下建立小型動態網站,受到Next.js的API的一點啟發,比如 getServerSideProps 和 getStaticProps ,Jar的API是由三個函式簽名定義的,
-
資料函式在構建頁面和重新生成的頁面時被呼叫,當它在服務器上被呼叫時,它會收到一個帶有方法、路徑、頭資訊和正文的請求物件,
-
render函式接收data函式的回傳值,并回傳一個
body,info的元組,其中的資訊可以改變回應的狀態代碼和頭檔案, -
配置函式定義了頁面的型別(構建、新鮮或再生),
這是一個生成頁面的例子kitchen sink example:
import time
def render(data):
return f"<h1>Last regenerated at: {data['time']}</h1>", {}
def data(request=None):
return {
"time": time.time()
}
def config():
return {
"regenerate": {
"every": 5
}
}
因為我們是在Python領域,我希望API是靈活的,資料和配置函式是可選的(而且它們不需要接受任何引數),因此,最小的Jar頁面看起來像這樣,
render = lambda: (“Hi! I'm a little page.”, {})
構建CLI
在對Jar的CLI進行原型設計時,Build Output API的檔案和例子足夠全面,我沒有遇到任何重大問題,通過試驗和錯誤,沒過多久我就通過構建和部署真正的專案來測驗Jar(從頭到尾大約需要6秒鐘),
Jar需要在構建時和在服務器上渲染頁面,并使用大量的動態匯入和元編程來減少代碼行和復雜性,
為了把用戶撰寫的頁面當作 Python 模塊,在運行時要像這樣匯入,
module_location = "project/pages/index.py"
spec = importlib.util.spec_from_file_location("", module_location)
page = importlib.util.module_from_spec(spec)
spec.loader.exec_module(page)
# `page` can now be called like `page.render()`
這意味著動態匯入的構建頁面可以在構建時被呼叫以生成靜態檔案,
# `page` is a dynamically imported module e.g. it exists at `pages/index.py`
with open(os.path.join(build_dir, f".vercel/output/static/{request_path}"), "w") as f:
res = call_render(page)
f.write(res['body'])
build_config['overrides'][request_path] = {
'contentType': res['headers']['Content-Type']
}
為了創建新鮮和再生的頁面,Jar創建了使用 python3.9 運行時的無服務器函式,用于創建構建頁面的相同函式(例如 call_data , call_render )被寫入一個處理檔案,以便它們可以根據需要在服務器上運行,當我說相同的函式時,我的意思是它們是真的從記憶體中讀取的,
def create_handler(path, module_location):
# the following functions are used at build time to generated build pages
# and are also used on the server to generated fresh/regenerated pages
# so we bundle them into a handler file
with open(path, "w") as f:
# imports
f.write("import json\nimport inspect\nimport importlib.util\n")
f.write('\n')
# request class
request_source = inspect.getsource(Request)
f.write(request_source)
f.write('\n')
# call_data function
call_data_source = inspect.getsource(call_data)
f.write(call_data_source)
f.write('\n')
# call_render function
call_render_source = inspect.getsource(call_render)
f.write(call_render_source)
f.write('\n')
# app function
app_source = inspect.getsource(app)
f.write(app_source.replace("__MODULE_LOCATION", module_location))
f.write('\n')
構建輸出API要求像包這樣的外部檔案被包含在函式的檔案系統中,
一個無服務器功能在檔案系統中被表示為一個名稱上帶有 .func 后綴的目錄,包含在 .vercel/output/functions 目錄中,
從概念上講,你可以把這個 .func 目錄看作是無服務器功能的檔案系統掛載: .func 目錄以下的檔案被包括在內(遞回), .func 目錄以上的檔案則不包括在內,私人檔案可以安全地放在這個目錄中,因為它們不會被終端用戶直接訪問,然而,它們可以被無服務器功能執行的代碼所參考,
在 .func 目錄下必須包含一個名為 .vc-config.json 的組態檔,其中包含Vercel應該如何構建無服務器功能的資訊,
在Jar中,所有的專案檔案都被復制到每個函式目錄中,以保持簡單(更成熟的框架會分割和捆綁以避免每個函式的大小限制), .vc-config.json 檔案對每個也是一樣的,
{"handler": "__handler.app", "runtime": "python3.9", "environment": {}}
函式之間的唯一區別是處理程式在運行時匯入的模塊(又稱頁面檔案),
Jar中的一個新的/再生的頁面與Serverless/Reperender函式一一對應,當一個請求進入Vercel的邊緣網路時,它最侄訓被路由到處理檔案,該檔案呼叫相關頁面的 data 和 render 函式,然后回復給客戶端,
關于Vercel內部的一些進一步閱讀:
-
Vercel基礎設施的幕后花絮
-
Runtime Developer Reference
-
Build your own web framework
-
SvelteKit's adapter-vercel
-
Vercel's CLI vercel/vercel
檔案
無論用戶的規模或數量如何,我都喜歡為我的副專案撰寫檔案,它記錄了我的想法,幫助我捕捉任何粗糙的邊緣,并給我完成專案最后 10% 所需的推動力,也意味著我以后可以隨時把東西撿回來!
我為 Jar 寫了檔案……用 Jar!請在此處查看專案檔案,檔案使用 marko markdown 包和 Prism.js 進行語法高亮顯示(所有 Jar 頁面都是純 Python,沒有匯入或特殊語法),
Serverless/Prerender Functions 不知道其函式目錄之外的任何內容,因此在使用第三方包時,需要將其安裝在專案的根目錄下,有一些成熟的方法可以使它正常作業(比如 Python 虛擬環境),但到目前為止我還沒有遇到任何問題,只是通過使用 pip 的 --target 引數在本地安裝包,
下面是一個示例,在構建和部署 Jar 檔案網站的腳本中:
python3 framework/cli.py build examples/docs
# project packages must be installed locally
# so they are bundled correctly when deployed
cd examples/docs && pip3 install -r requirements.txt --target . && cd ../..
cd build && vercel --prebuilt --prod && cd ..
檔案涵蓋了這個問題,以及有關 API 的更多詳細資訊,以及每種頁面型別的示例,
Tests
有一條有趣的公理說 everything is a compiler, a database, or a combination of both, Web 框架絕對是編譯器——測驗編譯器(應該具有確定性輸出)的一種快速方法是快照測驗,
Jar 的測驗套件構建兩個專案并對檔案進行快照測驗,對于真正的端到端測驗,它可以部署然后卷曲它們以驗證生產中的行為沒有分歧,
說到確定性輸出,我實際上遇到了一個錯誤,在 CI 中測驗有時會失敗,該錯誤是由于 Python 的 json.dumps 在序列化構建配置時如何對鍵進行排序,
這是我花了三十分鐘才找到并修復的錯誤:
with open(os.path.join(build_dir, '.vercel/output/config.json'), 'w') as f:
- json.dump(build_config, f)
+ json.dump(build_config, f, sort_keys=True)
做完這個專案,從idea到production一路走來,感覺好像剝了幾個計算層,我更喜歡 web 框架 → 編譯器 → 生產的流程,
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/545285.html
標籤:Python
上一篇:使用默認pypi源出現連接超時
