：讓 Flaskr 項目可安裝——pyproject.toml 描述項目與 pip 可編輯安裝全解)
Flask 教程實戰(zhàn)讓 Flaskr 項目可安裝——pyproject.toml 描述項目與 pip 可編輯安裝全解【免費下載鏈接】flaskThe Python micro framework for building web applications.項目地址: https://gitcode.com/gh_mirrors/fl/flask本篇基于 Flask 官方教程的 Make the Project Installable 章節(jié)展開講解如何把一個 Flask 應用教程中的博客應用 Flaskr變成標準的 Python 可安裝項目編寫pyproject.toml、以可編輯editable模式安裝、理解依賴聲明與構建后端。讀完后你將掌握使用標準 Python 打包工具鏈管理項目依賴、在任意目錄導入應用、并隔離測試環(huán)境與開發(fā)環(huán)境的完整方案同時能看到 Flask 倉庫自身正是用同一套方式打包的見 examples/tutorial 示例工程與 pyproject.toml。為什么要把項目做成可安裝在教程前面各章中Flaskr 應用由 examples/tutorial/flaskr 組成的包之所以能運行僅僅是因為你一直停留在項目目錄下Python 解釋器恰好能把flaskr當作本地模塊找到。讓項目可安裝Make the Project Installable意味著你可以構建出一個wheel文件并在另一個環(huán)境中安裝它——就像當初在開發(fā)環(huán)境中安裝 Flask 一樣。這帶來的收益包括部署方式統(tǒng)一部署你的項目與安裝任何其他 Python 庫完全一樣全程使用標準 Python 工具pip、wheel、虛擬環(huán)境管理一切隨處可導入安裝之后無論從哪個目錄運行都可以import flaskr不再受必須在項目目錄里的限制依賴隨包聲明可以像管理其他包一樣管理項目依賴pip install yourproject.whl會連帶安裝dependencies中聲明的所有依賴測試環(huán)境隔離測試工具如 pytest 虛擬環(huán)境可以把測試環(huán)境從開發(fā)環(huán)境中隔離出來避免兩者互相污染。教程原文在此處有一個值得記住的提示這一步雖然是教程靠后才引入的但在你今后的真實項目中應該從一開始就這么做。用 pyproject.toml 描述項目pyproject.toml文件描述你的項目及其構建方式。教程給出的最小完整版本如下# pyproject.toml [project] name flaskr version 1.0.0 description The basic blog app built in the Flask tutorial. dependencies [ flask, ] [build-system] requires [flit_core4] build-backend flit_core.buildapi逐項說明各字段的含義字段作用[project] name項目/包名即 pip 中顯示的名稱這里為flaskr[project] version語義化版本號教程示例固定為1.0.0[project] description一句話項目描述展示在包索引等元數(shù)據(jù)中[project] dependencies運行時依賴列表。安裝本包時 pip 會自動解析并安裝。flask不帶版本約束表示任意最新兼容版本[build-system] requires構建本包所需的環(huán)境依賴。flit_core4表示使用 flit 構建工具且限定大版本低于 4[build-system] build-backendPEP 517 構建后端入口flit_core.buildapi是 flit 提供的標準后端關于這些文件與選項的更多解釋可參考 Python 官方的 Packaging 教程文檔中鏈接的 packaging.python.org 教程頁面這里不再展開。倉庫中的教程示例工程提供了更完整的真實版本 examples/tutorial/pyproject.toml在最小版本之上補充了實際項目中常見的配置# examples/tutorial/pyproject.toml節(jié)選 [project] name flaskr version 1.0.0 description The basic blog app built in the Flask tutorial. readme README.rst license {file LICENSE.txt} maintainers [{name Pallets, email contactpalletsprojects.com}] classifiers [Private :: Do Not Upload] dependencies [ flask, ] [project.urls] Documentation https://flask.palletsprojects.com/tutorial/ [project.optional-dependencies] test [pytest] [build-system] requires [flit_core4] build-backend flit_core.buildapi [tool.flit.module] name flaskr [tool.flit.sdist] include [ tests/, ] [tool.pytest.ini_options] testpaths [tests] filterwarnings [error]與教程最小版本的差異點值得注意[project.optional-dependencies] test [pytest]聲明了可選的測試依賴組安裝命令寫作pip install .[test]這樣 pytest 只在需要跑測試時才會進入環(huán)境[tool.flit.module] name flaskr顯式告訴 flit 要打包的模塊名。由于name flaskr與頂層包目錄同名這一節(jié)其實也可以省略示例工程寫出它屬于顯式化[tool.flit.sdist] include把tests/目錄納入源碼發(fā)行sdist保證發(fā)布出去的源碼包含測試classifiers [Private :: Do Not Upload]是一個約定俗成的分類器防止有人誤把這個私有示例上傳到 PyPI。值得一提的是Flask 框架本身也使用同一套 flit 打包體系?？磦}庫根目錄的 pyproject.toml# 根目錄 pyproject.toml節(jié)選 [build-system] requires [flit_core3.11,4] build-backend flit_core.buildapi [tool.flit.module] name flask并且 pyproject.toml 中的[project.scripts]一節(jié)聲明了flask flask.cli:main控制臺腳本入口——這就是為什么pip install flask之后你在終端能直接使用flask命令。教程項目不需要自定義命令入口Flaskr 的命令如init-db是通過 Click 注冊到應用上的由flask命令發(fā)現(xiàn)并調(diào)用。以可編輯模式安裝項目在激活的虛擬環(huán)境中用pip安裝你的項目$ pip install -e .這條命令告訴 pip 在當前目錄找到pyproject.toml并以editable可編輯或development開發(fā)模式安裝項目?？删庉嬆Ｊ降暮诵暮x是后續(xù)修改本地代碼時無需重新安裝只有在改變項目元數(shù)據(jù)例如dependencies中新增依賴時才需要重新執(zhí)行安裝命令。Flask 官方教程示例工程同樣遵循這一流程。其 examples/tutorial/README.rst 給出的完整步驟是先創(chuàng)建并激活虛擬環(huán)境再執(zhí)行pip install -e .如果基于 Flask 主分支開發(fā)則先pip install -e ../..從源碼安裝開發(fā)版 Flask再pip install -e .安裝 Flaskr。安裝完成后可以用pip list觀察項目是否已安裝教程原文的輸出示例$ pip list Package Version Location -------------- --------- ---------------------------------- click 6.7 Flask 1.0 flaskr 1.0.0 /home/user/Projects/flask-tutorial itsdangerous 0.24 Jinja2 2.10 MarkupSafe 1.0 pip 9.0.3 Werkzeug 0.14.1輸出中flaskr一行的Location指向項目目錄這是可編輯安裝的典型特征包的位置不是 site-packages 里的副本而是源碼目錄本身。示例中的具體版本號是教程撰寫時期的舊版本當前倉庫的 Flask 在 pyproject.toml 中聲明支持 Python 3.10依賴werkzeug3.1.0、jinja23.1.2等實際pip list會以當時解析到的版本為準。安裝后從任意目錄運行應用安裝后運行方式與你此前在教程中做的沒有任何變化——--app依然是flaskrflask run依然啟動應用區(qū)別在于你可以在任意目錄調(diào)用它而不再局限于flask-tutorial目錄內(nèi)$ flask --app flaskr init-db $ flask --app flaskr run --debug打開 http://127.0.0.1:5000 即可看到 Flaskr 首頁。從源碼層面看這個隨處可運行的能力來自flask命令的應用定位邏輯。src/flask/cli.py 中的locate_app()負責把--app flaskr這樣的字符串參數(shù)變成應用實例def locate_app( module_name: str, app_name: str | None, raise_if_not_found: bool True ) - Flask | None: try: __import__(module_name) except ImportError: # Reraise the ImportError if it occurred within the imported module. ... elif raise_if_not_found: raise NoAppException(fCould not import {module_name!r}.) from None else: return None module sys.modules[module_name] if app_name is None: return find_best_app(module) else: return find_app_by_string(module, app_name)它通過__import__(module_name)走標準導入機制導入模塊然后按名稱查找Flask實例。未安裝未 editable 安裝時__import__(flaskr)只有當前工作目錄恰好在sys.path中才能成功這正是教程強調(diào)只能從項目目錄里運行的原因可編輯安裝讓flaskr的包元數(shù)據(jù)注冊進了環(huán)境的 site-packages指向源碼目錄標準導入機制從此在任何工作目錄下都能解析到它flask命令的--app機制才真正隨處可用。為測試環(huán)境提供隔離的依賴教程原文指出的第三個收益——測試工具可以隔離測試環(huán)境與開發(fā)環(huán)境——在示例工程中落地為 examples/tutorial/pyproject.toml 的可選依賴組與 examples/tutorial/README.rst 的測試流程$ pip install .[test] $ pytest這里的.[test]表示以可編輯模式安裝項目本身并額外安裝test可選依賴組即 pytest。測試代碼從 examples/tutorial/tests/conftest.py 開頭即可看到安裝帶來的直接效果——from flaskr import create_app這類導入不依賴任何相對路徑技巧只要 flaskr 已安裝就能在任意位置工作from flaskr import create_app from flaskr.db import get_db from flaskr.db import init_db pytest.fixture def app(): Create and configure a new app instance for each test. # create a temporary file to isolate the database for each test db_fd, db_path tempfile.mkstemp() # create the app with common test config app create_app({TESTING: True, DATABASE: db_path}) ...配合 examples/tutorial/tests/test_factory.py 中對create_app()工廠函數(shù)的直接測試可以看出因為項目是安裝好的包而不是散落在目錄里的腳本測試可以在獨立虛擬環(huán)境中只安裝聲明過的依賴來運行驗證配置注入TESTING: True、數(shù)據(jù)庫臨時文件隔離等行為而不受開發(fā)機環(huán)境的干擾。小結可安裝項目的標準工作流把本章內(nèi)容收斂為一條可復制的工作流在項目根目錄編寫pyproject.toml聲明name、version、dependencies與[build-system]flit_core flit_core.buildapi在項目目錄內(nèi)執(zhí)行pip install -e .完成可編輯安裝用pip list確認包名與Location指向源碼目錄之后在任意目錄執(zhí)行flask --app flaskr init-db、flask --app flaskr run --debug行為與安裝前一致需要跑測試時執(zhí)行pip install .[test]再pytest讓測試環(huán)境按聲明的依賴組獨立裝配。這套流程與 Flask 自身的打包方式flit 構建后端 PEP 517一致也是教程建議新項目從一開始就采用的標準化做法。下一章 tests 將在此基礎上展開測試細節(jié)deploy 則會討論如何把這樣一個已可安裝的應用部署到生產(chǎn)環(huán)境。【免費下載鏈接】flaskThe Python micro framework for building web applications.項目地址: https://gitcode.com/gh_mirrors/fl/flask創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 Flask 教程實戰(zhàn)：讓 Flaskr 項目可安裝——pyproject.toml 描述項目與 pip 可編輯安裝全解
Flask 教程實戰(zhàn)讓 Flaskr 項目可安裝——pyproject.toml 描述項目與 pip 可編輯安裝全解【免費下載鏈接】flaskThe Python micro framework for building web applications.項目地址: https://gitcode.com/gh_mirrors/fl/flask本篇基于 Flask 官方教程的 Make the Project Installable 章節(jié)展開講解如何把一個 Flask 應用教程中的博客應用 Flaskr變成標準的 Python 可安裝項目編寫pyproject.toml、以可編輯editable模式安裝、理解依賴聲明與構建后端。讀完后你將掌握使用標準 Python 打包工具鏈管理項目依賴、在任意目錄導入應用、并隔離測試環(huán)境與開發(fā)環(huán)境的完整方案同時能看到 Flask 倉庫自身正是用同一套方式打包的見 examples/tutorial 示例工程與 pyproject.toml。為什么要把項目做成可安裝在教程前面各章中Flaskr 應用由 examples/tutorial/flaskr 組成的包之所以能運行僅僅是因為你一直停留在項目目錄下Python 解釋器恰好能把flaskr當作本地模塊找到。讓項目可安裝Make the Project Installable意味著你可以構建出一個wheel文件并在另一個環(huán)境中安裝它——就像當初在開發(fā)環(huán)境中安裝 Flask 一樣。這帶來的收益包括部署方式統(tǒng)一部署你的項目與安裝任何其他 Python 庫完全一樣全程使用標準 Python 工具pip、wheel、虛擬環(huán)境管理一切隨處可導入安裝之后無論從哪個目錄運行都可以import flaskr不再受必須在項目目錄里的限制依賴隨包聲明可以像管理其他包一樣管理項目依賴pip install yourproject.whl會連帶安裝dependencies中聲明的所有依賴測試環(huán)境隔離測試工具如 pytest 虛擬環(huán)境可以把測試環(huán)境從開發(fā)環(huán)境中隔離出來避免兩者互相污染。教程原文在此處有一個值得記住的提示這一步雖然是教程靠后才引入的但在你今后的真實項目中應該從一開始就這么做。用 pyproject.toml 描述項目pyproject.toml文件描述你的項目及其構建方式。教程給出的最小完整版本如下# pyproject.toml [project] name flaskr version 1.0.0 description The basic blog app built in the Flask tutorial. dependencies [ flask, ] [build-system] requires [flit_core4] build-backend flit_core.buildapi逐項說明各字段的含義字段作用[project] name項目/包名即 pip 中顯示的名稱這里為flaskr[project] version語義化版本號教程示例固定為1.0.0[project] description一句話項目描述展示在包索引等元數(shù)據(jù)中[project] dependencies運行時依賴列表。安裝本包時 pip 會自動解析并安裝。flask不帶版本約束表示任意最新兼容版本[build-system] requires構建本包所需的環(huán)境依賴。flit_core4表示使用 flit 構建工具且限定大版本低于 4[build-system] build-backendPEP 517 構建后端入口flit_core.buildapi是 flit 提供的標準后端關于這些文件與選項的更多解釋可參考 Python 官方的 Packaging 教程文檔中鏈接的 packaging.python.org 教程頁面這里不再展開。倉庫中的教程示例工程提供了更完整的真實版本 examples/tutorial/pyproject.toml在最小版本之上補充了實際項目中常見的配置# examples/tutorial/pyproject.toml節(jié)選 [project] name flaskr version 1.0.0 description The basic blog app built in the Flask tutorial. readme README.rst license {file LICENSE.txt} maintainers [{name Pallets, email contactpalletsprojects.com}] classifiers [Private :: Do Not Upload] dependencies [ flask, ] [project.urls] Documentation https://flask.palletsprojects.com/tutorial/ [project.optional-dependencies] test [pytest] [build-system] requires [flit_core4] build-backend flit_core.buildapi [tool.flit.module] name flaskr [tool.flit.sdist] include [ tests/, ] [tool.pytest.ini_options] testpaths [tests] filterwarnings [error]與教程最小版本的差異點值得注意[project.optional-dependencies] test [pytest]聲明了可選的測試依賴組安裝命令寫作pip install .[test]這樣 pytest 只在需要跑測試時才會進入環(huán)境[tool.flit.module] name flaskr顯式告訴 flit 要打包的模塊名。由于name flaskr與頂層包目錄同名這一節(jié)其實也可以省略示例工程寫出它屬于顯式化[tool.flit.sdist] include把tests/目錄納入源碼發(fā)行sdist保證發(fā)布出去的源碼包含測試classifiers [Private :: Do Not Upload]是一個約定俗成的分類器防止有人誤把這個私有示例上傳到 PyPI。值得一提的是Flask 框架本身也使用同一套 flit 打包體系?？磦}庫根目錄的 pyproject.toml# 根目錄 pyproject.toml節(jié)選 [build-system] requires [flit_core3.11,4] build-backend flit_core.buildapi [tool.flit.module] name flask并且 pyproject.toml 中的[project.scripts]一節(jié)聲明了flask flask.cli:main控制臺腳本入口——這就是為什么pip install flask之后你在終端能直接使用flask命令。教程項目不需要自定義命令入口Flaskr 的命令如init-db是通過 Click 注冊到應用上的由flask命令發(fā)現(xiàn)并調(diào)用。以可編輯模式安裝項目在激活的虛擬環(huán)境中用pip安裝你的項目$ pip install -e .這條命令告訴 pip 在當前目錄找到pyproject.toml并以editable可編輯或development開發(fā)模式安裝項目?？删庉嬆Ｊ降暮诵暮x是后續(xù)修改本地代碼時無需重新安裝只有在改變項目元數(shù)據(jù)例如dependencies中新增依賴時才需要重新執(zhí)行安裝命令。Flask 官方教程示例工程同樣遵循這一流程。其 examples/tutorial/README.rst 給出的完整步驟是先創(chuàng)建并激活虛擬環(huán)境再執(zhí)行pip install -e .如果基于 Flask 主分支開發(fā)則先pip install -e ../..從源碼安裝開發(fā)版 Flask再pip install -e .安裝 Flaskr。安裝完成后可以用pip list觀察項目是否已安裝教程原文的輸出示例$ pip list Package Version Location -------------- --------- ---------------------------------- click 6.7 Flask 1.0 flaskr 1.0.0 /home/user/Projects/flask-tutorial itsdangerous 0.24 Jinja2 2.10 MarkupSafe 1.0 pip 9.0.3 Werkzeug 0.14.1輸出中flaskr一行的Location指向項目目錄這是可編輯安裝的典型特征包的位置不是 site-packages 里的副本而是源碼目錄本身。示例中的具體版本號是教程撰寫時期的舊版本當前倉庫的 Flask 在 pyproject.toml 中聲明支持 Python 3.10依賴werkzeug3.1.0、jinja23.1.2等實際pip list會以當時解析到的版本為準。安裝后從任意目錄運行應用安裝后運行方式與你此前在教程中做的沒有任何變化——--app依然是flaskrflask run依然啟動應用區(qū)別在于你可以在任意目錄調(diào)用它而不再局限于flask-tutorial目錄內(nèi)$ flask --app flaskr init-db $ flask --app flaskr run --debug打開 http://127.0.0.1:5000 即可看到 Flaskr 首頁。從源碼層面看這個隨處可運行的能力來自flask命令的應用定位邏輯。src/flask/cli.py 中的locate_app()負責把--app flaskr這樣的字符串參數(shù)變成應用實例def locate_app( module_name: str, app_name: str | None, raise_if_not_found: bool True ) - Flask | None: try: __import__(module_name) except ImportError: # Reraise the ImportError if it occurred within the imported module. ... elif raise_if_not_found: raise NoAppException(fCould not import {module_name!r}.) from None else: return None module sys.modules[module_name] if app_name is None: return find_best_app(module) else: return find_app_by_string(module, app_name)它通過__import__(module_name)走標準導入機制導入模塊然后按名稱查找Flask實例。未安裝未 editable 安裝時__import__(flaskr)只有當前工作目錄恰好在sys.path中才能成功這正是教程強調(diào)只能從項目目錄里運行的原因可編輯安裝讓flaskr的包元數(shù)據(jù)注冊進了環(huán)境的 site-packages指向源碼目錄標準導入機制從此在任何工作目錄下都能解析到它flask命令的--app機制才真正隨處可用。為測試環(huán)境提供隔離的依賴教程原文指出的第三個收益——測試工具可以隔離測試環(huán)境與開發(fā)環(huán)境——在示例工程中落地為 examples/tutorial/pyproject.toml 的可選依賴組與 examples/tutorial/README.rst 的測試流程$ pip install .[test] $ pytest這里的.[test]表示以可編輯模式安裝項目本身并額外安裝test可選依賴組即 pytest。測試代碼從 examples/tutorial/tests/conftest.py 開頭即可看到安裝帶來的直接效果——from flaskr import create_app這類導入不依賴任何相對路徑技巧只要 flaskr 已安裝就能在任意位置工作from flaskr import create_app from flaskr.db import get_db from flaskr.db import init_db pytest.fixture def app(): Create and configure a new app instance for each test. # create a temporary file to isolate the database for each test db_fd, db_path tempfile.mkstemp() # create the app with common test config app create_app({TESTING: True, DATABASE: db_path}) ...配合 examples/tutorial/tests/test_factory.py 中對create_app()工廠函數(shù)的直接測試可以看出因為項目是安裝好的包而不是散落在目錄里的腳本測試可以在獨立虛擬環(huán)境中只安裝聲明過的依賴來運行驗證配置注入TESTING: True、數(shù)據(jù)庫臨時文件隔離等行為而不受開發(fā)機環(huán)境的干擾。小結可安裝項目的標準工作流把本章內(nèi)容收斂為一條可復制的工作流在項目根目錄編寫pyproject.toml聲明name、version、dependencies與[build-system]flit_core flit_core.buildapi在項目目錄內(nèi)執(zhí)行pip install -e .完成可編輯安裝用pip list確認包名與Location指向源碼目錄之后在任意目錄執(zhí)行flask --app flaskr init-db、flask --app flaskr run --debug行為與安裝前一致需要跑測試時執(zhí)行pip install .[test]再pytest讓測試環(huán)境按聲明的依賴組獨立裝配。這套流程與 Flask 自身的打包方式flit 構建后端 PEP 517一致也是教程建議新項目從一開始就采用的標準化做法。下一章 tests 將在此基礎上展開測試細節(jié)deploy 則會討論如何把這樣一個已可安裝的應用部署到生產(chǎn)環(huán)境。【免費下載鏈接】flaskThe Python micro framework for building web applications.項目地址: https://gitcode.com/gh_mirrors/fl/flask創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考