:py:mod:`plan`
==============

.. py:module:: conda.plan

.. autoapi-nested-parse::

   Handle the planning of installs and their execution.

   .. note::

      conda.install uses canonical package names in its interface functions,
      whereas conda.resolve uses package filenames, as those are used as index
      keys.  We try to keep fixes to this "impedance mismatch" local to this
      module.




Functions
---------

.. autoapisummary::

   conda.plan.print_dists
   conda.plan.display_actions
   conda.plan.add_unlink
   conda.plan.add_defaults_to_specs
   conda.plan._get_best_prec_match
   conda.plan.revert_actions
   conda.plan.execute_actions
   conda.plan._plan_from_actions
   conda.plan._inject_UNLINKLINKTRANSACTION
   conda.plan._handle_menuinst
   conda.plan.install_actions
   conda.plan.get_blank_actions
   conda.plan.execute_plan
   conda.plan.execute_instructions
   conda.plan._update_old_plan



.. py:function:: print_dists(dists_extras)


.. py:function:: display_actions(actions, index, show_channel_urls=None, specs_to_remove=(), specs_to_add=())


.. py:function:: add_unlink(actions, dist)


.. py:function:: add_defaults_to_specs(r, linked, specs, update=False, prefix=None)


.. py:function:: _get_best_prec_match(precs)


.. py:function:: revert_actions(prefix, revision=-1, index=None)


.. py:function:: execute_actions(actions, index, verbose=False)


.. py:function:: _plan_from_actions(actions, index)


.. py:function:: _inject_UNLINKLINKTRANSACTION(plan, index, prefix, axn, specs)


.. py:function:: _handle_menuinst(unlink_dists, link_dists)


.. py:function:: install_actions(prefix, index, specs, force=False, only_names=None, always_copy=False, pinned=True, update_deps=True, prune=False, channel_priority_map=None, is_update=False, minimal_hint=False)


.. py:function:: get_blank_actions(prefix)


.. py:function:: execute_plan(old_plan, index=None, verbose=False)

   Deprecated: This should `conda.instructions.execute_instructions` instead.


.. py:function:: execute_instructions(plan, index=None, verbose=False, _commands=None)

   Execute the instructions in the plan

   :param plan: A list of (instruction, arg) tuples
   :param index: The meta-data index
   :param verbose: verbose output
   :param _commands: (For testing only) dict mapping an instruction to executable if None
   then the default commands will be used


.. py:function:: _update_old_plan(old_plan)

   Update an old plan object to work with
   `conda.instructions.execute_instructions`