Mark conda/plan.py for Deprecation (and do related refactoring work as necessary)

[beeankha]

What is the idea?

There is a TODO comment marking the conda/plan.py module for deprecation that got added in the pull request titled "separate conda package metadata under new root-level key in repodata (#8639)".

Deprecating/removing that module (and related test file) entirely is not a straightforward task, as there are references to the contents of conda/plan.py in files such as conda/misc.py and conda/exports.py. This deprecation will require:

Tasks

Beta Give feedback

1. Investigations into which files contain references to any functions/methods in conda/plan.py
2. Figuring out what sort of refactoring efforts are required as a result of those references

[github-actions]

Hi there, thank you for your contribution!

This issue has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this issue to remain open please:

1. Verify that you can still reproduce the issue at hand
2. Comment that the issue is still reproducible and include:
   - What OS and version you reproduced the issue on
   - What steps you followed to reproduce the issue

NOTE: If this issue was closed prematurely, please leave a comment.

Thanks!

[jezdez]

@beeankha Is there anything we need to do about this ticket?

[beeankha]

@jezdez nothing in particular is blocking this work afaik, we just need to get started on it; if it's more complicated than anticipated we can move it to the 24.7.x milestone. I'll do at least the preliminary research (task 1) this week!

[beeankha]

Discoveries for Step 1 of this task:

In conda/conda

• print_dists():

  • only used within conda/plan.py, in the display_actions() function

• display_actions():

  • used in conda/exports.py in display_actions() (it's imported as _display_actions with a leading underscore added
  • found in tests in tests/test_plan.py, specifically test_display_actions_0(), test_display_actions_show_channel_urls(), test_display_actions_link_type(), test_display_actions_features()

• add_unlink():

  • used in tests/test_plan.py in test_simply_adds_unlink_on_non_windows() and test_adds_to_existing_actions()

• add_defaults_to_specs():

  • no references/usage found

• _get_best_prec_match():

  • used in conda/plan.py in revert_actions()
  • also found in conda/misc.py in clone_env()

• revert_actions():

  • used internally in conda/plan.py in main execution code
  • also found in conda/install.py in install() function

• execute_actions():

  • imported but unused in conda/exports.py with a #noqa: F401 comment

• _plan_from_actions():

  • only used in conda/plan.py module in execute_actions() function directly above

• _inject_UNLINKLINKTRANSACTION():

  • only used internally in conda/plan.py module in _plan_from_actions() helper method

• _handle_menuinst():

  • only used internally in conda/plan.py module in _inject_UNLINKLINKTRANSACTION() helper method directly above

• install_actions():

  • imported but unused in conda/exports.py with a #noqa: F401 comment

• get_blank_actions():

  • only used internally in the install_actions() function, which is imported but unused in conda/exports.py

• execute_plan():

  • imported but unused in conda/exports.py with a #noqa: F401 comment
  • also found in tests/test_plan.py in test_execute_plan()

• execute_instructions():

  • used internally in conda/plan.py module in execute_actions() and execute_plan() functions
  • found in tests/test_instructions.py in test_simple_instruction() and test_state()
  • imported but unused in conda/exports.py with a #noqa: F401 comment

• _update_old_plan():

  • found internally in conda/plan.py module in execute_plan() which is imported but unused in conda/exports.py with a #noqa: F401 comment
  • also found in tests/test_plan.py in test_update_old_plan(), imported as update_old_plan (without the leading underscore)

In conda/conda-build

• Per work done in Dist removal conda-build#5074, dependency on conda.plan.py was removed from conda-build (see conda-build's 24.1.0 release changelog)

• In conda_build/utils.py, "conda.plan" is listed in the LoggingContext.default_loggers list

• In conda_build/environ.py, several comments list functions that were copied over from conda/plan.py:

  • install_actions()
  • _execute_actions()
  • _display_actions()

[beeankha]

Resolved per merging of #13881