deailab

DeAI JupyterLab扩展。

DeAILab是DeAI请求库的JupyterLab扩展。

需求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install deailab

卸载

要移除扩展，请执行

pip uninstall deailab

故障排除

如果您看到前端扩展但无法使用，请检查服务器扩展是否启用

jupyter server extension list

如果服务器扩展已安装并启用，但您未看到前端扩展，请检查前端扩展是否已安装

jupyter labextension list

贡献

开发安装

注意：您需要NodeJS来构建扩展包。

jlpm 命令是 JupyterLab 附带的固定版本 yarn，它是与 JupyterLab 一起安装的。您可以使用 yarn 或 npm 替代下面的 jlpm。

# Clone the repo to your local environment
# Change directory to the deailab directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable deailab
# Rebuild extension Typescript source after making changes
jlpm build

您可以在不同的终端中同时监视源目录并运行 JupyterLab，以便监视扩展的源代码变化并自动重新构建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

在运行监视命令时，每次保存的更改都将立即在本地构建并可用于您正在运行的 JupyterLab。刷新 JupyterLab 以在浏览器中加载更改（您可能需要等待几秒钟，以便重新构建扩展）。

默认情况下，jlpm build 命令为该扩展生成源映射，以便更容易使用浏览器开发工具进行调试。要同时为 JupyterLab 核心扩展生成源映射，可以运行以下命令

jupyter lab build --minimize=False

开发模式卸载

# Server extension must be manually disabled in develop mode
jupyter server extension disable deailab
pip uninstall deailab

在开发模式下，您还需要删除由 jupyter labextension develop 命令创建的符号链接。要找到其位置，可以运行 jupyter labextension list 以确定 labextensions 文件夹的位置。然后您可以删除该文件夹中的名为 deailab 的符号链接。

测试扩展

服务器测试

此扩展使用 Pytest 进行 Python 代码测试。

安装测试依赖项（只需安装一次）

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

要执行它们，请运行

pytest -vv -r ap --cov deailab

前端测试

此扩展使用 Jest 进行 JavaScript 代码测试。

要执行它们，请执行

jlpm
jlpm test

集成测试

此扩展使用 Playwright 进行集成测试（也称为用户级测试）。更精确地说，JupyterLab 辅助工具 Galata 用于处理在 JupyterLab 中测试扩展。

更多详细信息请参阅 ui-tests 中的 README。

打包扩展

请参阅 RELEASE