Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge resolve and resolve_multi #969

Closed
4 tasks
jsirois opened this issue May 11, 2020 · 2 comments · Fixed by #1420
Closed
4 tasks

Merge resolve and resolve_multi #969

jsirois opened this issue May 11, 2020 · 2 comments · Fixed by #1420
Assignees
Labels
resolver tech-debt Issue that addresses technical debt.
Milestone

Comments

@jsirois
Copy link
Member

jsirois commented May 11, 2020

These functions are both part of the informal public API. We should deprecate passing a single interpreter and a single platform and just support passing optional lists for each as done in resolve_multi. We should also probably pick the name 'resolve' for the merged function, essentially deleting the current resolve and replacing it with the current resolve_multi renamed to resolve.

Resolving this issue is probably a good time to take up #584 and set up proper deprecation, then removal.

  1. Create a deprecation policy doc.
  2. Implement a deprecation system - emit pex_warning messages as needed.
  3. Change resolve to support None, singles, or lists for interpreter and platform and deprecate both calling resolve with singles and calling resolve_multi.
  4. When the deprecation cycle is up remove resolve and rename resolve_multi to resolve.

This deprecation should probably use version 3.0.0 as the boundary to conform to Semver.

@jsirois jsirois added resolver tech-debt Issue that addresses technical debt. API Issues that relate to changes in the public Pex API labels May 11, 2020
@jsirois jsirois added this to the 3.0 milestone May 11, 2020
@jsirois
Copy link
Member Author

jsirois commented May 11, 2020

Additionally it would be good to circle back to the exposed datatypes and exception types and thoroughly document them and check their args as part of this resolve API cleanup and the API formalization umbrelled by #584.

@jsirois
Copy link
Member Author

jsirois commented Aug 23, 2021

Since Pex has moved away from suporting any API besides the CLI, this can now be done without all the above prep work needed to support breaking CLI API changes.

@jsirois jsirois self-assigned this Aug 23, 2021
@jsirois jsirois added in progress and removed API Issues that relate to changes in the public Pex API labels Aug 23, 2021
jsirois added a commit to jsirois/pex that referenced this issue Aug 23, 2021
Kill ~unused resolve and rename resolve_multi to resolve.
Eliminate ResolvedDistribution alias in favor of InstalledDistribution
which better reflects the shap of the distribution (not a wheel, but an
installed wheel). Fix test-use fallout.

Work towards pex-tool#1401.
Closes pex-tool#969
jsirois added a commit that referenced this issue Aug 23, 2021
Kill ~unused resolve and rename resolve_multi to resolve.
Eliminate ResolvedDistribution alias in favor of InstalledDistribution
which better reflects the shap of the distribution (not a wheel, but an
installed wheel). Fix test-use fallout.

Work towards #1401.
Closes #969
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
resolver tech-debt Issue that addresses technical debt.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant