You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在JupyterLab UI扩展中获取激活/聚焦笔记本的完整路径?

获取JupyterLab中激活笔记本的完整路径(适配分屏场景)

你之前用defaultFileBrowser.listing.selection的思路存在偏差——这个属性对应的是文件浏览器里选中的文件项,和当前聚焦/激活的笔记本(尤其是分屏时的窗口)完全是两个独立的概念。要拿到用户正在操作的笔记本路径,得从JupyterLab的文档追踪服务入手。

解决步骤

  1. 注入核心服务:在扩展激活时,引入JupyterLab提供的INotebookTracker(专门追踪笔记本类型的Widget)和IDocumentManager(可选,用于复杂文档操作)。
  2. 定位激活的笔记本:通过notebookTracker.currentWidget获取当前聚焦的笔记本实例,分屏场景下也能准确识别用户正在操作的那个窗口。
  3. 提取完整路径:从笔记本Widget的context属性中读取path字段,这就是该笔记本在工作区中的完整路径。

代码示例

import { IDocumentManager } from '@jupyterlab/docmanager';
import { INotebookTracker } from '@jupyterlab/notebook';
import { JupyterFrontEnd, JupyterFrontEndPlugin } from '@jupyterlab/application';
import { CommandRegistry } from '@jupyterlab/coreutils';

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'your-custom-extension:get-notebook-path',
  autoStart: true,
  requires: [IDocumentManager, INotebookTracker],
  activate: (app: JupyterFrontEnd, docManager: IDocumentManager, notebookTracker: INotebookTracker) => {
    // 注册按钮点击对应的命令逻辑
    app.commands.addCommand('your-custom-extension:get-active-path', {
      label: 'Get Active Notebook Path',
      execute: () => {
        const activeNotebook = notebookTracker.currentWidget;
        if (!activeNotebook) {
          console.log('当前没有激活的笔记本');
          return;
        }
        // 获取工作区下的完整路径
        const fullPath = activeNotebook.context.path;
        console.log('激活笔记本路径:', fullPath);
        
        // 若需要生成可直接访问的URL,可借助docManager:
        // const notebookUrl = docManager.services.contents.getDownloadUrl(fullPath);
        // console.log('笔记本访问URL:', notebookUrl);
      }
    });

    // 创建按钮并添加到工具栏(假设你已完成基础按钮创建逻辑)
    const pathButton = new CommandRegistry.Button({
      command: 'your-custom-extension:get-active-path'
    });
    app.toolbar.addItem('get-active-notebook-path', pathButton);
  }
};

export default plugin;

补充说明

  • 如果你的扩展需要支持笔记本之外的文档类型(如Markdown、CSV),可以替换INotebookTracker为IDocumentWidgetTracker,并通过widget.context.model.type判断文档类型。
  • currentWidget会严格对应用户当前聚焦的窗口,无论单窗口还是多窗口分屏,都能精准返回正在操作的文档。
  • context.path返回的是工作区根目录下的相对路径,若需要绝对路径或其他格式,可结合docManager提供的工具方法处理。

内容的提问来源于stack exchange,提问作者Anoush Hakobyan

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.04 18:32:17