implement copy import path command

Author: s-kai273

src/client/application/importPath/copyImportPathCommand.ts

@@ -0,0 +1,68 @@
+import * as path from 'path';
+import * as vscode from 'vscode';
+import { inject, injectable } from 'inversify';
+
+import { ICommandManager, IWorkspaceService } from '../../common/application/types';
+import { IExtensionSingleActivationService } from '../../activation/types';
+import { Commands } from '../../common/constants';
+import { getSysPath } from '../../common/utils/pythonUtils';
+
+@injectable()
+export class CopyImportPathCommand implements IExtensionSingleActivationService {
+    public readonly supportedWorkspaceTypes = { untrustedWorkspace: true, virtualWorkspace: true };
+
+    constructor(
+        @inject(ICommandManager) private readonly commands: ICommandManager,
+        @inject(IWorkspaceService) private readonly workspace: IWorkspaceService,
+    ) {}
+
+    async activate(): Promise<void> {
+        this.commands.registerCommand(Commands.CopyImportPath, this.execute, this);
+    }
+
+    private async execute(fileUri?: vscode.Uri): Promise<void> {
+        const uri = fileUri ?? vscode.window.activeTextEditor?.document.uri;
+        if (!uri || uri.scheme !== 'file' || !uri.fsPath.endsWith('.py')) {
+            void vscode.window.showWarningMessage('No Python file selected for import-path copy.');
+            return;
+        }
+
+        const importPath = this.resolveImportPath(uri.fsPath);
+        await vscode.env.clipboard.writeText(importPath);
+        void vscode.window.showInformationMessage(`Copied: ${importPath}`);
+    }
+
+    /**
+     * Resolves a Python import-style dotted path from an absolute file path.
+     *
+     * The resolution follows a 3-level fallback strategy:
+     *
+     * 1. If the file is located under any entry in `sys.path`, the path relative to that entry is used.
+     * 2. If the file is located under the current workspace folder, the path relative to the workspace root is used.
+     * 3. Otherwise, the import path falls back to the file name (without extension).
+     *
+     * @param absPath - The absolute path to a `.py` file.
+     * @returns The resolved import path in dotted notation (e.g., 'pkg.module').
+     */
+    private resolveImportPath(absPath: string): string {
+        // ---------- ① sys.path ----------
+        for (const sysRoot of getSysPath()) {
+            if (sysRoot && absPath.startsWith(sysRoot)) {
+                return CopyImportPathCommand.toDotted(path.relative(sysRoot, absPath));
+            }
+        }
+
+        // ---------- ② workspaceFolder ----------
+        const ws = this.workspace.getWorkspaceFolder(vscode.Uri.file(absPath));
+        if (ws && absPath.startsWith(ws.uri.fsPath)) {
+            return CopyImportPathCommand.toDotted(path.relative(ws.uri.fsPath, absPath));
+        }
+
+        // ---------- ③ fallback ----------
+        return path.basename(absPath, '.py');
+    }
+
+    private static toDotted(relPath: string): string {
+        return relPath.replace(/\.py$/i, '').split(path.sep).filter(Boolean).join('.');
+    }
+}

src/client/application/importPath/serviceRegistry.ts

@@ -0,0 +1,10 @@
+import { IServiceManager } from '../../ioc/types';
+import { IExtensionSingleActivationService } from '../../activation/types';
+import { CopyImportPathCommand } from './copyImportPathCommand';
+
+export function registerTypes(serviceManager: IServiceManager): void {
+    serviceManager.addSingleton<IExtensionSingleActivationService>(
+        IExtensionSingleActivationService,
+        CopyImportPathCommand,
+    );
+}

src/client/application/serviceRegistry.ts

@@ -5,7 +5,9 @@
 
 import { IServiceManager } from '../ioc/types';
 import { registerTypes as diagnosticsRegisterTypes } from './diagnostics/serviceRegistry';
+import { registerTypes as importPathRegisterTypes } from './importPath/serviceRegistry';
 
 export function registerTypes(serviceManager: IServiceManager) {
     diagnosticsRegisterTypes(serviceManager);
+    importPathRegisterTypes(serviceManager);
 }

src/client/common/application/commands.ts

@@ -40,6 +40,7 @@ interface ICommandNameWithoutArgumentTypeMapping {
     [Commands.ClearStorage]: [];
     [Commands.CreateNewFile]: [];
     [Commands.ReportIssue]: [];
+    [Commands.CopyImportPath]: [];
     [LSCommands.RestartLS]: [];
 }
 

src/client/common/constants.ts

@@ -35,6 +35,7 @@ export enum CommandSource {
 
 export namespace Commands {
     export const ClearStorage = 'python.clearCacheAndReload';
+    export const CopyImportPath = 'python.copyImportPath';
     export const CreateNewFile = 'python.createNewFile';
     export const ClearWorkspaceInterpreter = 'python.clearWorkspaceInterpreter';
     export const Create_Environment = 'python.createEnvironment';

src/client/common/utils/pythonUtils.ts

@@ -0,0 +1,13 @@
+import { execFileSync } from 'child_process';
+
+export function getSysPath(pythonCmd = 'python3'): string[] {
+    try {
+        const out = execFileSync(pythonCmd, ['-c', 'import sys, json; print(json.dumps(sys.path))'], {
+            encoding: 'utf-8',
+        });
+        return JSON.parse(out);
+    } catch (err) {
+        console.warn('[CopyImportPath] getSysPath failed:', err);
+        return [];
+    }
+}