Implement copying python import path from opened file #25026

s-kai273 · 2025-05-01T12:16:42Z

Summary

This PR implements a new feature that allows users to copy the Python import path of the currently opened file to the clipboard via the file tab context menu.

What was done

Add a context menu item to the Python file tab for copying the import path.
Implement python.copyImportPath command.
Implement test cases to verify the behavior under different path resolution scenarios:
- When a sys.path entry matches the file path.
- When no sys.path match is found but the file is within a workspace folder.
- When neither match is found, using the filename as a fallback.

Example

For a file at /home/user/project/src/pkg/module.py and sys.path containing /home/user/project/src, the copied import path will be:

pkg.module

s-kai273 · 2025-05-01T12:21:30Z

@microsoft-github-policy-service agree

s-kai273 · 2025-05-01T12:27:38Z

src/client/application/importPath/copyImportPathCommand.ts

+    }
+
+    /**
+     * Resolves a Python import-style dotted path from an absolute file path.


As described here, the strategy for resolving the Python import path is as follows:

If the file is located under any entry in sys.path, the path relative to that entry is used.

If the file is located under the current workspace folder, the path relative to the workspace root is used.

Otherwise, the import path falls back to the file name (without extension).

I believe this approach is reasonable, but if you have any suggestions for improvement, I’d love to hear them!

s-kai273 · 2025-05-01T12:43:25Z

package.json

@@ -1126,6 +1131,11 @@
            }
        ],
        "keybindings": [
+            {
+                "command": "python.copyImportPath",
+                "key": "ctrl+alt+shift+i",


I've set Ctrl+Alt+Shift+I as the default keybinding.
If you find it inconvenient or have a better suggestion, please let me know!

s-kai273 · 2025-05-04T13:15:48Z

Hi, just a quick note regarding the CI failure:

It appears that the error is not related to the changes in this PR.
The failure seems to be caused by a build issue with the testresources package, due to an incompatibility with the latest setuptools (related to the deprecation of easy_install.sys_executable).

Please let me know if anything needs to be changed on my end. Thanks!

karthiknadig · 2025-05-19T23:46:21Z

@s-kai273 Thanks for creating this PR. Can you create an issue for this, with steps for testing it, and to get community input on this?

src/client/application/importPath/copyImportPathCommand.ts

rchiodo · 2025-05-20T00:13:51Z

src/client/application/importPath/copyImportPathCommand.ts

+     * @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, pythonPath?: string): string {


You might look at the import logic as described here:
https://github.com/microsoft/pyright/blob/5d79dbbbcd0e683b07b4bd4a7f1910a835564249/packages/pyright-internal/src/analyzer/importResolver.ts#L1568

That's what Pylance uses to resolve an import. Maybe it's too complicated for this, but it would be cool if the python extension had the same import path as the language server.

Or instead of doing it this way, we add a new api to the pylance extension for the python extension to call.

Thank you for your feedback.
I agree that it would be better to adopt the same implementation as Pylance.
However, I’m wondering whether adding an API specifically for this feature and using it in this context is appropriate.
As I understand it, an LSP server like Pylance is mainly intended to provide language features such as completion, diagnostics, and navigation, so this feature might be outside the typical scope of a language server.

If you think this approach is appropriate, I’d be happy to proceed with it.

Pylance would likely add this command itself if this was used enough. In fact if Pylance was open source, I'd say it would be better if you just added it to Pylance. That way the command would be consistent with other things that happen in the editor.

Whether or not it's worth the effort to add an API to Pylance, I'd say probably not now. We'd likely want to wait for telemetry on how often this command is used and any issues that people entered where the path is wrong.

I looked into the _resolveBestAbsoluteImport implementation in Pyright that you shared, and I found that the logic is quite extensive.

As you mentioned, it would definitely be great if the Python extension could reuse the same logic as Pyright. Honestly, I’d love to take on that challenge—but maintaining a custom implementation at that scale would likely be too costly.

Instead, I think a more maintainable approach would be to install Pyright as an internal dependency and call the relevant methods directly. However, considering that this would introduce a dependency that overlaps with functionality already provided by Pylance, it might not be ideal to add Pyright internally just for this feature.

As a practical compromise for now, I’m considering refining the current import resolution logic and adding telemetry to better understand usage and potential improvements in the future.

I'd really appreciate your feedback on this direction.

Yeah I like this idea:

As a practical compromise for now, I’m considering refining the current import resolution logic and adding telemetry to better understand usage and potential improvements in the future.

I don't think this command has to be perfect from the beginning. It can be close enough and then if it gets a lot of usage we can come back and figure out how to match the import logic later.

Thanks for the feedback!
I’ll go ahead with that approach.

@rchiodo,
I’ve added telemetry implementation in f72b005.
I’d appreciate it if you could take a look when you have time. Thanks!

rchiodo · 2025-05-20T00:16:24Z

src/client/common/utils/pythonUtils.ts

@@ -0,0 +1,13 @@
+import { execFileSync } from 'child_process';
+
+export function getSysPath(pythonCmd = 'python3'): string[] {


This isn't safe if there's a json.py file in the user's workspace (people sometimes open folders without checking). You might want to copy this code here:

https://github.com/microsoft/pyright/blob/5d79dbbbcd0e683b07b4bd4a7f1910a835564249/packages/pyright-internal/src/common/fullAccessHost.ts#L25

Thank you for your insightful comment.
I learned a lot from it.
If we adopt the approach used in Pylance, this method will no longer be necessary.
After this discussion, I’ll address this issue.

Fix it on 1e33952

s-kai273 · 2025-05-21T13:46:29Z

@karthiknadig
Thank you for your reply!
The issue has been opened already.
#25027

I added an instruction of this feature here.

…273/vscode-python into feature/implement_copy_import_path

rchiodo

LGTM

s-kai273 added 5 commits February 24, 2025 23:54

add context menu item of copy import path

0fe3beb

implement copy import path command

16c9419

add kiybindings

59df3ad

add test cases

ebf0c20

modify to use clipboard object

a13ad19

Merge branch 'main' into feature/implement_copy_import_path

b540d9d

s-kai273 commented May 1, 2025

View reviewed changes

s-kai273 mentioned this pull request May 1, 2025

Implement copying python import path from opened file #25027

Open

s-kai273 commented May 1, 2025

View reviewed changes

Merge branch 'main' into feature/implement_copy_import_path

6fb135d

s-kai273 and others added 5 commits May 7, 2025 16:09

Merge branch 'main' into feature/implement_copy_import_path

6156876

modify method to resolve path

c23849d

delete unnecessary comment

8179c18

modify to use current interpreter path for resolving sys.path

63abf49

Merge branch 'main' into feature/implement_copy_import_path

7607eed

karthiknadig requested review from karthiknadig and rchiodo May 19, 2025 23:41

karthiknadig self-assigned this May 19, 2025

karthiknadig added the feature-request Request for new features or functionality label May 19, 2025

rchiodo reviewed May 20, 2025

View reviewed changes

src/client/application/importPath/copyImportPathCommand.ts Outdated Show resolved Hide resolved

rchiodo reviewed May 20, 2025

View reviewed changes

s-kai273 and others added 4 commits May 21, 2025 23:40

Merge branch 'main' into feature/implement_copy_import_path

2855a30

modify to work on remote environment

3eeaf87

Merge branch 'feature/implement_copy_import_path' of github.com:s-kai…

ac66899

…273/vscode-python into feature/implement_copy_import_path

improve command for getting sys path to resolve security issue

1e33952

s-kai273 and others added 3 commits May 23, 2025 23:09

Merge branch 'main' into feature/implement_copy_import_path

aabb1d3

add telemetry for copy import path

f72b005

Merge branch 'feature/implement_copy_import_path' of github.com:s-kai…

42178a3

…273/vscode-python into feature/implement_copy_import_path

rchiodo approved these changes May 23, 2025

View reviewed changes

		@@ -0,0 +1,13 @@
		import { execFileSync } from 'child_process';

		export function getSysPath(pythonCmd = 'python3'): string[] {

Implement copying python import path from opened file #25026

Are you sure you want to change the base?

Implement copying python import path from opened file #25026

Conversation

s-kai273 commented May 1, 2025

Summary

What was done

Example

Uh oh!

s-kai273 commented May 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s-kai273 commented May 4, 2025

Uh oh!

karthiknadig commented May 19, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

s-kai273 commented May 21, 2025

Uh oh!

rchiodo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!