Deprecate conda.models.dist and conda.plan #13557
Conversation
Signed-off-by: Marcel Bargull <[email protected]>
conda-bot
added
the
cla-signed
mbargull
force-pushed
the
deprecate-dist-and-plan
branch
2 times, most recently
from
1cd92b0 to
733e081
Compare
CodSpeed Performance ReportMerging #13557 will create unknown performance changesComparing Summary
|
| @@ -1614,3 +1622,61 @@ def messages(prefix): | |||
| return m | |||
| finally: | |||
| rm_rf(path) | |||
|
|
|||
|
|
|||
| def _get_best_prec_match(precs): | |||
There was a problem hiding this comment.
We may want to change the name to not carry the underscore prefix since it's used in an other module (conda.misc also imported .plan._get_best_prec_match before).
| from .channel import Channel | ||
| from .package_info import PackageInfo | ||
| from .records import PackageRecord | ||
|
|
||
| log = getLogger(__name__) | ||
|
|
||
| deprecated.module( | ||
| "24.3", | ||
| "24.9", |
There was a problem hiding this comment.
This is the earliest I'd be comfortable with.
Dist is used elsewhere outside of https://github.com/conda .
Unless it induces noticeable maintenance burden, we can also postpone the actual removal to early 2025 or so.
Marking this for 24.9 just gives us the possibility to remove it earlier.
| deprecated.module( | ||
| "24.3", | ||
| "24.9", | ||
| addendum="Use `conda.models.records.PackageRecord` instead.", |
There was a problem hiding this comment.
PackageRecord of course does not cover every functionality of this module one to one.
Feel free to add additional deprecation notes to symbols of this module as you see fit!
| @@ -519,7 +519,7 @@ environment..." step in the CLI report. | |||
| [conda.models.match_spec:MatchSpec]: https://github.com/conda/conda/blob/4.11.0/conda/models/match_spec.py#L73 | |||
| [conda.misc:explicit]: https://github.com/conda/conda/blob/4.11.0/conda/misc.py#L52 | |||
| [conda.misc:clone_env]:https://github.com/conda/conda/blob/4.11.0/conda/misc.py#L187 | |||
| [conda.plan:revert_actions]: https://github.com/conda/conda/blob/4.11.0/conda/plan.py#L279 | |||
| [conda.core.link:revert_actions]: https://github.com/conda/conda/blob/24.1.0/conda/plan.py#L298 | |||
There was a problem hiding this comment.
If/when we merge this PR, we should open a tracking issue to update this link to actually point to the correct module from a new release.
| from .core.index import LAST_CHANNEL_URLS, _supplement_index_with_prefix | ||
| from .core.link import PrefixSetup, UnlinkLinkTransaction | ||
| from .core.solve import diff_for_unlink_link_precs | ||
| from .exceptions import CondaIndexError, PackagesNotFoundError | ||
| from .history import History | ||
| from .core.index import LAST_CHANNEL_URLS | ||
| from .core.link import _get_best_prec_match, revert_actions # noqa: F401 | ||
| from .deprecations import deprecated | ||
| from .instructions import FETCH, LINK, SYMLINK_CONDA, UNLINK | ||
| from .models.channel import Channel, prioritize_channels | ||
| from .models.dist import Dist | ||
| from .models.enums import LinkType | ||
| from .models.match_spec import ChannelMatch | ||
| from .models.prefix_graph import PrefixGraph |
There was a problem hiding this comment.
Should we add deprecated.constant(...)s for all re-exported symbols this removes?
Signed-off-by: Marcel Bargull <[email protected]>
Signed-off-by: Marcel Bargull <[email protected]>
Signed-off-by: Marcel Bargull <[email protected]>
mbargull
force-pushed
the
deprecate-dist-and-plan
branch
from
d203a0a to
897a906
Compare
Description
Checklist - did you ...
newsdirectory (using the template) for the next release's release notes?[ ] Add / update necessary tests?Following the removal of
conda.models.distandconda.plan's usage inconda-buildvia conda/conda-build#5074 , this moves the few functions of these modules that are used withincondaitself to other modules and marks both modules as pending for deprecation.