feat: add getPackageAvailableVersions to public API and bump API to 1.1.0 - #1682
Open
edvilme wants to merge 3 commits into
Open
feat: add getPackageAvailableVersions to public API and bump API to 1.1.0#1682edvilme wants to merge 3 commits into
edvilme wants to merge 3 commits into
Conversation
edvilme
force-pushed
the
api-version-bump
branch
from
July 30, 2026 18:01
4f563d7 to
540d41d
Compare
edvilme
changed the title
edvilme
enabled auto-merge (squash)
July 31, 2026 21:59
edvilme
disabled auto-merge
July 31, 2026 22:15
Add PythonPackageGetterApi.getPackageAvailableVersions so API consumers can query a package's available versions (newest-first), delegating to the environment's package manager and resolving to undefined when unsupported. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3f16397e-0917-4efb-8d75-566c71ebf9ba
edvilme
changed the title
Contributor
Author
|
Adding "skip tests" label since this functionality already exists but is now being exposed to the public API |
StellaHuang95
approved these changes
Jul 31, 2026
edvilme
enabled auto-merge (squash)
August 3, 2026 16:58
eleanorjboyd
reviewed
Aug 4, 2026
| ### Changed | ||
|
|
||
| - Added the optional `options?: GetPackagesOptions` parameter to `PackageManager.getPackages(environment, options?)` and `PythonPackageGetterApi.getPackages(environment, options?)`. Consumers can set `options.skipCache` to request fresh package data. | ||
| - Changed `PackageManager.refresh(environment)` from `Promise<void>` to `Promise<Package[] | undefined>`, allowing implementations to return the refreshed package list. |
Member
There was a problem hiding this comment.
this is a big change here- we would need to go to 2.0 if we want to change the return value of this method. Any other ways we could maybe do that?
eleanorjboyd
reviewed
Aug 4, 2026
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [1.1.0] |
Member
There was a problem hiding this comment.
The published 1.0 package has top-level main and types; api/package.json now has only conditional exports. This accumulated unpublished change is not mentioned in the changelog.
Member
There was a problem hiding this comment.
preserve top-level main and types alongside exports, and test packed ESM and legacy CommonJS consumers.
eleanorjboyd
reviewed
Aug 4, 2026
| - Added the optional `options?: GetPackagesOptions` parameter to `PackageManager.getPackages(environment, options?)` and `PythonPackageGetterApi.getPackages(environment, options?)`. Consumers can set `options.skipCache` to request fresh package data. | ||
| - Changed `PackageManager.refresh(environment)` from `Promise<void>` to `Promise<Package[] | undefined>`, allowing implementations to return the refreshed package list. | ||
| - Changed `PythonPackageGetterApi.refreshPackages(environment)` from `Promise<void>` to `Promise<Package[] | undefined>`, exposing the refreshed package list to API consumers. | ||
|
|
Member
There was a problem hiding this comment.
would also want to packed-package contract tests before publishing
eleanorjboyd
requested changes
Aug 4, 2026
eleanorjboyd
left a comment
eleanorjboyd
left a comment
Member
There was a problem hiding this comment.
see two items about refresh and the exported top level items
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PythonPackageGetterApi.getPackageAvailableVersionsto the public API so consumers can query a package's available versions@vscode/python-environmentsfrom1.0.0to1.1.0API changes
PythonPackageGetterApi.getPackageAvailableVersions(environment, packageName): Promise<Pep440Version[] | undefined>— exposes a package's available versions (newest-first) to API consumers, delegating to the environment's package manager and resolving toundefinedwhen version listing is unsupportedPep440Versionfor package manager version APIsPackageInfo.isTransitiveandGetPackagesOptions.skipCacheGetPackagesOptionsparameter toPackageManager.getPackagesandPythonPackageGetterApi.getPackagesPackageManager.refreshandPythonPackageGetterApi.refreshPackagesto return the refreshed package list when availableValidation
npm run lintnpm run compile-testsnpm run unittest(1494passing,5pending)git diff --check