主頁 > 後端開發 > 我自己的 Python Web 框架

我自己的 Python Web 框架

2023-03-01 07:09:26 後端開發

原文地址: 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的一點啟發,比如 getServerSidePropsgetStaticProps ,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源出現連接超時

下一篇:Python elasticsearch 使用心得

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more