Repository navigation
Test finalized API for python environments #19886
Description
Refs: #19101
- anyOS: Ian Huff (@IanMatthewHuff)
- anyOS: Don Jayamanne (@DonJayamanne)
Complexity: 5
Requirements
Pre-assigning Jupyter team, but note builds are not available yet, testing begins tomorrow.
- Use Pre release build of the python extension
- Have as many types of environments as you can.
- Interesting types to test: Conda, Pyenv global installs, Pyenv conda envs etc.
Test APIs exposed via ProposedExtensionAPI
- See
ProposedExtensionAPIfor APIs to test: https://github.dev/microsoft/vscode-python/blob/main/src/client/proposedApiTypes.ts - Use
Python: Clear cache and reloadcommand to clear any pre-existing discovery cache in the extension. - Try dry-adopting it in the Jupyter extension for discovery of Python environments and make sure it covers all scenarios.
Example usage:
Copy over contents of https://github.com/microsoft/vscode-python/blob/main/src/client/proposedApiTypes.ts#L8 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 envPath = api.environment.getActiveEnvironmentPath();
}
}
Activity
IanMatthewHuff commentedon Sep 27, 2022
Right now I'm testing this with a separate extension as opposed to trying to fully adopt into Jupyter. Seemed like a fairer test of the API itself.
karrtikr commentedon Sep 27, 2022
Yep, by dry-adopting I mean we should make sure it covers all scenarios in the Jupyter extension.
IanMatthewHuff commentedon Sep 27, 2022
That seems a bit much for a single TPI. But so far things all look good with it. Maybe Don knows better if we can just drop this in quickly.
DonJayamanne commentedon Sep 28, 2022
i agree with Ian, it's impossible to cover
ALLscenrios in a TPI without adopting this in jupyyer extensionif you're plan is to finalize the api based on feedback from jupyter extension adoption, then i don't think we can finalize this api now.
All we (jupyter extension) can do is test this with a simple sample and provide some feedback.
we will discuss this in our stand-up.
karrtikr commentedon Sep 28, 2022
I see, in that case just testing and feedback would suffice for purposes of this TPI.
Will discuss with the team on when we plan to finalize it.
karrtikr commentedon Sep 28, 2022
So I talked with the team and decided that we'll finalize it in an iteration or two, hope that gives Jupyter some time to adopt the API. Meanwhile we'll still announce it in our blog posts and release notes to get additional feedback!