JupyterLab 使用與開發(fā)全指南安裝、運(yùn)行、擴(kuò)展與架構(gòu)解析【免費(fèi)下載鏈接】jupyterlabJupyterLab computational environment.項(xiàng)目地址: https://gitcode.com/gh_mirrors/ju/jupyterlabJupyterLab 是 Project Jupyter 推出的下一代交互式計(jì)算環(huán)境在經(jīng)典 Jupyter Notebook 的記事本、終端、文本編輯器、文件瀏覽器與富文本輸出等基礎(chǔ)上提供了更加靈活、可擴(kuò)展的統(tǒng)一用戶界面。本文以倉庫根目錄 README.md 為骨架結(jié)合倉庫內(nèi)服務(wù)端實(shí)現(xiàn)jupyterlab/labapp.py、pyproject.toml與前端包結(jié)構(gòu)packages/application/package.json系統(tǒng)講解 JupyterLab 的安裝、啟動、運(yùn)行模式、擴(kuò)展機(jī)制與開發(fā)參與方式幫助讀者快速上手并理解其內(nèi)部運(yùn)行原理。JupyterLab 是什么按 README 的定義JupyterLab 是一個基于 Jupyter Notebook 與 Jupyter 架構(gòu)的可擴(kuò)展、支持交互與可復(fù)現(xiàn)計(jì)算的運(yùn)行環(huán)境是 Project Jupyter 的下一代用戶界面。它把經(jīng)典 Jupyter Notebook 中大家熟悉的積木塊——記事本Notebook、終端Terminal、文本編輯器Text Editor、文件瀏覽器File Browser、富輸出Rich Outputs等——整合進(jìn)一個靈活而強(qiáng)大的統(tǒng)一界面中。與經(jīng)典 Notebook 單文檔的單頁模型不同JupyterLab 采用多文檔、多面板的 IDE 式布局你可以并排打開多個筆記本、終端與文件拖拽調(diào)整面板位置并將多個文檔組織成可保存、可分享的工作區(qū)Workspace。前端核心包 packages/application 中可以看到整個界面建立在 Luminolumino/application、lumino/widgets、lumino/commands、lumino/signaling插件化應(yīng)用框架之上并由jupyterlab/docregistry、jupyterlab/rendermime、jupyterlab/services等模塊提供文檔注冊、渲染與內(nèi)核服務(wù)通信能力。安裝 JupyterLab使用 conda / mamba / pip 一鍵安裝README 提供了三種最主流的安裝方式任選其一即可# 使用 conda conda install -c conda-forge jupyterlab # 使用 mamba mamba install -c conda-forge jupyterlab # 使用 pip pip install jupyterlabconda-forge渠道的預(yù)編譯包通常能避免編譯依賴適合科學(xué)計(jì)算環(huán)境pip 方式則與現(xiàn)有 Python 虛擬環(huán)境無縫集成。從 pyproject.toml 的打包配置看JupyterLab 4.x 要求 Python 3.10依賴的核心組件包括jupyter_server2.19.0,3、jupyterlab_server2.28.0,3、notebook_shim0.2、tornado6.2.0以及jupyter-lsp2.0.0等安裝后會自動注冊為 Jupyter Server 的服務(wù)器擴(kuò)展。關(guān)于pip install --user的 PATH 問題README 特別提醒如果使用pip install --user安裝必須把用戶級bin目錄加入PATH環(huán)境變量才能直接運(yùn)行jupyter lab。在類 Unix 系統(tǒng)FreeBSD、GNU/Linux、macOS上執(zhí)行export PATH$HOME/.local/bin:$PATH如果遇到 Command jupyter not found 錯誤一般就是 PATH 未配置正確。此時可以不修改 PATH直接使用完整路徑啟動~/.local/bin/jupyter lab使用舊版本 Jupyter Notebook 5.3時README 指出當(dāng)搭配的 Jupyter Notebook 版本早于 5.3 時安裝 JupyterLab 后還需手動啟用其服務(wù)器擴(kuò)展jupyter serverextension enable --py jupyterlab --sys-prefix如果使用新版 Jupyter Notebook / Jupyter Server則無需手動操作。倉庫中的 jupyter-config/jupyter_server_config.d/jupyterlab.json 與 jupyter-config/jupyter_notebook_config.d/jupyterlab.json 展示了安裝包自帶的兩份配置前者在ServerApp.jpserver_extensions中聲明jupyterlab: true后者在NotebookApp.nbserver_extensions中聲明同樣的開關(guān)分別保證 JupyterLab 服務(wù)器擴(kuò)展被 Jupyter Server 與舊版 Notebook 自動加載。啟動 JupyterLab安裝完成后在終端執(zhí)行jupyter labJupyterLab 會自動在瀏覽器中打開。若要查看更多啟動選項(xiàng)可查看 jupyterlab/labapp.py 中LabApp的examples字段它給出了幾種常見用法jupyter lab # 啟動 JupyterLab jupyter lab --dev-mode # 開發(fā)模式啟動無擴(kuò)展需 pip install -e . 源碼安裝 jupyter lab --core-mode # 核心模式啟動無第三方擴(kuò)展 jupyter lab --app-dir~/myjupyterlabapp # 以指定應(yīng)用目錄特定擴(kuò)展組合啟動 jupyter lab --certfilemycert.pem # 使用 SSL/TLS 證書啟動三種運(yùn)行模式LabApp的description與initialize_templates方法把 JupyterLab 歸納為三種運(yùn)行模式理解它們有助于排查資源路徑問題核心模式Core mode--core-mode直接使用已安裝的jupyterlabPython 包內(nèi)自帶的 JavaScript 靜態(tài)資源不加載任何第三方擴(kuò)展。這是穩(wěn)定版在沒有安裝擴(kuò)展時的默認(rèn)行為。實(shí)現(xiàn)上見 jupyterlab/labapp.py會把static_paths/template_paths指向包內(nèi)的static目錄并清空labextensions_path。開發(fā)模式Dev mode--dev-mode使用倉庫dev_mode目錄中未發(fā)布的本地 JavaScript 包頁面頂部會出現(xiàn)紅色條紋提示。僅當(dāng) JupyterLab 以pip install -e .方式安裝時可用適合前端源碼開發(fā)。應(yīng)用模式App modeJupyterLab 允許用戶創(chuàng)建多個攜帶不同擴(kuò)展組合的應(yīng)用通過--app-dir指定應(yīng)用目錄默認(rèn)應(yīng)用目錄可通過jupyter lab path查詢。與之配套的子命令在LabApp.subcommands中注冊jupyterlab/labapp.pyjupyter lab build # 構(gòu)建應(yīng)用staging 目錄編譯后輸出到 static jupyter lab clean # 清理應(yīng)用目錄staging/extensions/settings/static jupyter lab path # 打印應(yīng)用、用戶設(shè)置、工作區(qū)等目錄路徑 jupyter lab workspace # 工作區(qū)導(dǎo)出/導(dǎo)入/列出子命令 export/import/list jupyter lab licenses # 查看應(yīng)用使用的前端包許可證其中jupyter lab build支持--dev-build、--minimize、--app-dir、--debug-log-path等參數(shù)。LabBuildAppjupyterlab/labapp.py中的兩個關(guān)鍵開關(guān)值得注意dev_build控制使用 dev 構(gòu)建還是更精簡的 production 構(gòu)建。默認(rèn)絕大多數(shù)用戶為Falseproduction但一旦安裝了來自本地文件的 labextensions默認(rèn)會切換為True顯式設(shè)置False可強(qiáng)制在所有場景下使用 production 構(gòu)建。minimize控制 Rspack 構(gòu)建時是否壓縮 JS bundle有助于提升 JupyterLab 整體性能在低內(nèi)存環(huán)境構(gòu)建失敗時關(guān)閉壓縮往往能解決問題。若需對全部構(gòu)建關(guān)閉這兩個選項(xiàng)可在任意 Jupyter 配置目錄下新建jupyter_config.py并寫入c.LabBuildApp.minimize False c.LabBuildApp.dev_build False配置文件目錄列表可用jupyter --paths查看。應(yīng)用相關(guān)目錄與路徑通過jupyter lab pathLabPathApp見 jupyterlab/labapp.py可打印三類路徑它們也分別支持環(huán)境變量覆蓋應(yīng)用目錄Application directory默認(rèn)由JUPYTERLAB_DIR環(huán)境變量配置用戶設(shè)置目錄User Settings directory默認(rèn)由JUPYTERLAB_SETTINGS_DIR配置否則回退到默認(rèn) Jupyter 配置目錄下的/lab/user-settings工作區(qū)目錄Workspaces directory默認(rèn)由JUPYTERLAB_WORKSPACES_DIR配置否則回退到默認(rèn)配置目錄下的/lab/workspaces。支持的瀏覽器README 明確列出當(dāng)前已知可正常工作的最新版瀏覽器FirefoxChromeSafari新版 Chromium 內(nèi)核瀏覽器一般也能獲得良好支持。若在瀏覽器中遇到渲染異常優(yōu)先檢查瀏覽器是否升級到最新版本以及前端靜態(tài)資源static目錄是否與當(dāng)前 JupyterLab 版本匹配。擴(kuò)展機(jī)制讓 JupyterLab 無限擴(kuò)展JupyterLab 的擴(kuò)展性是其核心設(shè)計(jì)目標(biāo)之一。README 說明其擴(kuò)展分為兩類預(yù)構(gòu)建擴(kuò)展Prebuilt extensions可通過 PyPI、conda 等包管理器分發(fā)安裝后無需額外構(gòu)建步驟開箱即用。源碼擴(kuò)展Source extensions直接通過 npm 安裝可搜索jupyterlab-extension關(guān)鍵詞的 npm 包但需要額外的構(gòu)建步驟。從 Python 側(cè)看pyproject.toml 聲明了擴(kuò)展管理器的入口點(diǎn)[project.entry-points.jupyterlab.extension_manager_v1] readonly jupyterlab.extensions:get_readonly_manager pypi jupyterlab.extensions:get_pypi_managerLabApp.extension_manager配置項(xiàng)默認(rèn)值為pypi見 jupyterlab/labapp.py用于選擇擴(kuò)展管理器工廠readonly提供無安裝能力的只讀管理器pypi則基于 PyPI 與 pip 安裝擴(kuò)展。在 jupyterlab/labapp.py 的initialize_handlers中可以看到非核心模式啟動時會實(shí)例化所選管理器并將擴(kuò)展元數(shù)據(jù)注入前端page_config[extensionManager]若所選管理器初始化失敗會回退到ReadOnlyExtensionManager實(shí)現(xiàn)在 jupyterlab/extensions/readonly.py同時支持通過LabServerApp.blocked_extensions_uris/allowed_extensions_uris配置擴(kuò)展黑/白名單列表詳見 jupyterlab/extensions/manager.py 中擴(kuò)展兼容性檢查與消息映射的實(shí)現(xiàn)。前端擴(kuò)展管理器 UI 位于 packages/extensionmanager 與 packages/extensionmanager-extension。命令行層面還提供擴(kuò)展管理工具jupyter labextension入口在 jupyterlab/labextensions.py對應(yīng) pyproject.toml 的[project.scripts]支持安裝、卸載、禁用、啟用、列表等操作應(yīng)用模式下的擴(kuò)展安裝會觸發(fā)jupyter lab build重新構(gòu)建靜態(tài)資源。從源碼開發(fā)與貢獻(xiàn)為 JupyterLab 開發(fā)擴(kuò)展要開始開發(fā)擴(kuò)展README 指引讀者閱讀開發(fā)者文檔與 API 文檔。就本倉庫而言前端部分是一個大型 TypeScript monorepopackages/目錄下按功能拆分為application、notebook、apputils、services、ui-components、rendermime等數(shù)十個獨(dú)立 npm 包每個包都維護(hù)獨(dú)立的package.json如 packages/application/package.json 聲明了依賴lumino/application、jupyterlab/services等并統(tǒng)一通過倉庫根目錄的 package.json 與 lerna.json 組織版本與發(fā)布。示例項(xiàng)目位于 examples/覆蓋 app、cell、console、filebrowser、notebook、terminal 等典型擴(kuò)展場景每個示例均包含main.py、package.json與rspack.config.js是上手編寫前端擴(kuò)展的最佳參照。參與 JupyterLab 本體開發(fā)從 git 源碼安裝的說明見 CONTRIBUTING.md。開發(fā)者可從源碼構(gòu)建倉庫提供的開發(fā)相關(guān)腳本與工具包括binder/environment.ymlBinder 在線試用環(huán)境配置buildutils/版本號管理、包創(chuàng)建/刪除、依賴更新、發(fā)布等一攬子工程化腳本galata/基于 Playwright 的端到端測試框架含jupyterlab/test大量 UI 回歸測試用例scripts/CI 安裝腳本ci_install.sh、flake 測試分析、i18n 檢查等輔助腳本。JupyterLab 遵循 Jupyter 社區(qū)指南Jupyter Community Guides開發(fā)者應(yīng)同時閱讀 docs/ 下的用戶與開發(fā)者文檔。每周開發(fā)會議社區(qū)每周三太平洋時間上午 9:00 召開視頻會議任何人都可以旁聽或參與討論會議記錄歸檔于 Jupyter Frontends 團(tuán)隊(duì) compass。版本維護(hù)現(xiàn)狀與升級建議README 中有一條重要公告JupyterLab 3 已于 2024 年 5 月 15 日到達(dá)維護(hù)期終點(diǎn)關(guān)鍵問題的修復(fù)僅回溯支持至 2024 年 12 月 31 日。仍在使用 JupyterLab 3 的用戶應(yīng)盡快升級到 JupyterLab 4。從本倉庫看前端包版本號如jupyterlab/application的4.7.0-alpha.1與 Python 包jupyterlabjupyterlab/_version.py共同推進(jìn)到 4.x 系列pyproject.toml中Framework :: Jupyter :: JupyterLab :: 4的分類器也印證了當(dāng)前主線為 4.x。獲取幫助與反饋提問交流推薦在 Jupyter Discourse 論壇的 JupyterLab 板塊提問公開問答可以沉淀為對他人有用的資料。提交 Bug請先閱讀問題報(bào)告指南再使用 Bug 模板新建 issue已解決的問題在閑置一段時間后會被 lock bot 鎖定如仍需討論請新開 issue 并引用原 issue。功能建議歡迎使用功能請求模板提交新特性建議幫助項(xiàng)目對更多用戶更有用。許可證與版權(quán)模式JupyterLab 采用共享版權(quán)shared copyright模式所有貢獻(xiàn)者保留各自貢獻(xiàn)的版權(quán)全部代碼以修訂版 BSD 許可證授權(quán)詳見倉庫 LICENSE。JupyterLab 是 Project Jupyter 的一部分由開放社區(qū)開發(fā)維護(hù)團(tuán)隊(duì)受 Jupyter Frontends Council 治理決策型貢獻(xiàn)者與代碼貢獻(xiàn)者分別可見于團(tuán)隊(duì)名錄與貢獻(xiàn)者圖譜?？偨Y(jié)從pip install jupyterlab到j(luò)upyter lab再到通過--core-mode/--dev-mode/--app-dir切換運(yùn)行形態(tài)、借助 prebuilt 擴(kuò)展與 npm 源碼擴(kuò)展搭建個性化環(huán)境JupyterLab 提供了一條從拿來即用到深度定制的完整路徑。理解 jupyterlab/labapp.py 中的三種運(yùn)行模式與構(gòu)建/清理/路徑等子命令、pyproject.toml 中的擴(kuò)展管理器入口點(diǎn)以及packages/下的前端模塊化結(jié)構(gòu)將幫助你更高效地使用、排查和擴(kuò)展這套計(jì)算環(huán)境?！久赓M(fèi)下載鏈接】jupyterlabJupyterLab computational environment.項(xiàng)目地址: https://gitcode.com/gh_mirrors/ju/jupyterlab創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考