import a library from another vscode extension

[BlackRam-oss]

Hi I am screening an exension for renpy.

Renpy is written in python and gives the possibility to develop with phython language by importing a library called renpy.
The renpy library will be added only when the program is compiled for distribution.
for this reason when the import of renpy is done, vscode will report a false error -> because python cannot find the renpy library.

so my idea is to add the path to this library to vscode-python from my extension through its api.

I know that you can do the following way to import them:

	// import python extension
	let python = extensions.getExtension('ms-python.python');
	let pythonApi = python?. Exports;

the problem is that I don't know if there is a function that is right for me

[ccalvocm]

Greetings @donrp

To add a path to the Python environment used by the VS Code Python extension, you can use the python.setExecutionDetails() method provided by the Python extension API.

Here's an example of how you could use this method to add a path to the Python environment:

// Import the Python extension API
const pythonExtension = vscode.extensions.getExtension('ms-python.python');
const pythonApi = pythonExtension.exports;

// Add a path to the Python environment
pythonApi.setExecutionDetails('python', { path: '/path/to/renpy/library' });

This code gets a reference to the Python extension API, and then calls the setExecutionDetails() method to add a path to the Python environment. The first argument to setExecutionDetails() is the name of the Python executable to modify (in this case, 'python'), and the second argument is an object that specifies the details to set for the executable. In this case, the object specifies a path property that contains the path to the Ren'Py library.

Note that this code assumes that the Ren'Py library is installed on the same machine as VS Code, and that you know the path to the library. If the library is installed in a different location, or if you need to determine the path dynamically, you may need to modify this code accordingly.

[BlackRam-oss]

hello, i only had time to test it now. it gives me the following error:

rejected promise not handled within 1 second: TypeError: pythonApi.setExecutionDetails is not a function
extensionHostProcess.js:105
stack trace: TypeError: pythonApi.setExecutionDetails is not a function
    at /home/simone/renpy-vscode/src/extension.ts:50:15
    at processTicksAndRejections (node:internal/process/task_queues:96:5)

/**
 * Add a path to the Python environment
 * @param renpySDKPath 
 * @returns 
 */
function addAPathToThePythonEnvironment(renpySDKPath: string | undefined) {
	if (!renpySDKPath) {
		vscode.window.showErrorMessage("The setting 'renpy.renpySDKPath' has not been set");
		return
	}

	const pythonExtension = extensions.getExtension('ms-python.python');
	if (pythonExtension) {
		if (!pythonExtension.isActive) {
			pythonExtension.activate().then(() => {
				const pythonApi: any = pythonExtension.exports //as IExtensionAPI;
				// Add a path to the Python environment
				pythonApi.setExecutionDetails('python', { path: renpySDKPath });
			});
		}
		else {
			const pythonApi: any = pythonExtension.exports //as IExtensionAPI;
			// Add a path to the Python environment
			pythonApi.setExecutionDetails('python', { path: renpySDKPath });
		}
	}
	else {
		// TODO: check add ignore setting
		vscode.window.showWarningMessage("The 'ms-python.python' extension is recommended for python files (you can ignore this message in the settings)");
	}
}

[brettcannon]

The documentation for the API can be found in our wiki (we are also working towards creating an NPM package to make it easier to use).

when the import of renpy is done, vscode will report a false error -> because python cannot find the renpy library.

I think you're referring to Pylance saying that the import doesn't exist?

[gnikit]

@brettcannon that's pretty cool about the NPM package. Is there a rough ETA on the first release?

[brettcannon]

Don't know not sure, what is the difference?

It's either Pylance or Jedi. All depends on your settings for python.languageServer.

that's pretty cool about the NPM package. Is there a rough ETA on the first release?

Nope, but we are actively working on it (albeit with summer vacations starting to complicate things), so I would say hopefully before September (due to company policies involving security we can't just throw any random thing up on NPM, so there's a bunch of steps we have to go through that prolong how long it takes for us to publish anything).

[BlackRam-oss]

I was looking at the documentation, where can I import IExtensionAPI?

[karrtikr]

@donrp See https://github.com/microsoft/vscode-python/wiki/Python-Environment-APIs#get-the-python-extension-api, currently you've to copy the interface over.

[gnikit]

Nope, but we are actively working on it (albeit with summer vacations starting to complicate things), so I would say hopefully before September (due to company policies involving security we can't just throw any random thing up on NPM, so there's a bunch of steps we have to go through that prolong how long it takes for us to publish anything).

@brettcannon I completely understand. Thanks for all the work you are putting into making the extension reusable by third parties. I look forward in using the NPM package whenever it is ready.

[BlackRam-oss]

Hi I read the wiki, and I tried in the following way.

pythonApi.environments.updateActiveEnvironmentPath('renpy', sdkPath + "/renpy");

gives me the following error:

rejected promise not handled within 1 second: TypeError: Cannot use 'in' operator to search for 'uri' in /home/user/renpy/renpy
extensionHostProcess.js:105
stack trace: TypeError: Cannot use 'in' operator to search for 'uri' in /home/user/renpy/renpy
    at Object.updateActiveEnvironmentPath (/home/user/.vscode-server/extensions/ms-python.python-2023.8.0/out/client/extension.js:2:418681)
    at /home/user/renpy-vscode/src/extension.ts:50:28
    at processTicksAndRejections (node:internal/process/task_queues:96:5)

I am not clear what the parameters refer to.

---

in any case, I am not 100% sure that function updateActiveEnvironmentPath is what I am looking for.

my intention is to add this library which is in a specific folder in addition to the standard python ones.

could someone confirm for me that updateActiveEnvironmentPath is do this

[karthiknadig]

@donrp To do this programmatically through a VS Code extension, currently you can only make this work for things running in terminal. This is the API https://code.visualstudio.com/api/references/vscode-api#EnvironmentVariableCollection

For intellisense, with either Jedi/Pylance, you can set the following setting programmatically python.autoComplete.extraPaths to include the path to renpy. This path should be similar to what you would do with PYTHONPATH.
From your screen shot and messages it should likely be like this: "python.autoComplete.extraPaths": ["/home/user/renpy"].

To validate the path before you add setting do this:

> export PYTHONPATH=/home/user/renpy
> python -c "import renpy"

We don't have an API that is generically make this work for all background process etc (that would be a feature request). But the above should get terminal runs.

[BlackRam-oss]

To do this programmatically through a VS Code extension, currently you can only make this work for things running in terminal. This is the API https://code.visualstudio.com/api/references/vscode-api#EnvironmentVariableCollection

with currently you can only make this work for things running in terminal, does this mean that python extension will not import this library? Will basically continue to report this in red?

We don't have an API that is generically make this work for all background process etc (that would be a feature request). But the above should get terminal runs.

It would be great if it was implemented, do I create an issue?

[karthiknadig]

does this mean that python extension will not import this library? Will basically continue to report this in red?

If you add to the extra paths setting it will not show the red squiggle.

[karthiknadig]

It would be great if it was implemented, do I create an issue?

Please create an issue so we can track this.

[BlackRam-oss]

issue: #21372