Test proposed api to get custom environment variables for a workspace

[karrtikr]

Refs: #15112

• anyOS @lszomoru
• anyOS: @DonJayamanne

Complexity: 3

Create Issue

---

Requirements

Use Pre release build of the python extension.

Test APIs exposed via ProposedExtensionAPI

Python extensions offers environments definition file (.env files) using which users can specify any custom environment variables that can be used for running linters, formatters, IntelliSense, testing, debugging etc for the workspace. This API provides a way to return the environment variables after resolving values of the .env file.

New API: environment variables

• See definitions file for the API to test: https://github.com/microsoft/vscode-python/blob/main/src/client/proposedApiTypes.ts#L62-L74
• Use Python: Clear cache and reload command to clear any pre-existing cache in the extension.
• Make sure the API is fast and reliable, should be as fast as reading a file.
• Make sure changes to .env files are caught in a multiroot scenario.

Example usage:
Copy over contents of https://github.com/microsoft/vscode-python/blob/main/src/client/proposedApiTypes.ts#L62-L74 as needed.

const extension = extensions.getExtension('ms-python.python');
if (extension) {
    if (!extension.isActive) {
        await extension.activate();
    }
    const api: IExtensionApi & ProposedExtensionAPI = extension.exports as IExtensionApi & ProposedExtensionAPI;
    if (api.environment) {
        const vars =  api.environments.getEnvironmentVariables(<workspace folder>);
    }
}

[DonJayamanne]

Thanks @karrtikr for this API.
I'll making the changes in jupyter extension and test this there, (best way to test)

[lszomoru]

Api works as advertised. There is a typo in the code sample: api.environments instead of api.environment.

[DonJayamanne]

Verified, works as expected, thanks @karrtikr