:py:mod:`mass_driver.commands`
==============================

.. py:module:: mass_driver.commands

.. autodoc2-docstring:: mass_driver.commands
   :parser: myst
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`drivers_command <mass_driver.commands.drivers_command>`
     - .. autodoc2-docstring:: mass_driver.commands.drivers_command
          :parser: myst
          :summary:
   * - :py:obj:`forges_command <mass_driver.commands.forges_command>`
     - .. autodoc2-docstring:: mass_driver.commands.forges_command
          :parser: myst
          :summary:
   * - :py:obj:`sources_command <mass_driver.commands.sources_command>`
     - .. autodoc2-docstring:: mass_driver.commands.sources_command
          :parser: myst
          :summary:
   * - :py:obj:`plugins_command <mass_driver.commands.plugins_command>`
     - .. autodoc2-docstring:: mass_driver.commands.plugins_command
          :parser: myst
          :summary:
   * - :py:obj:`run_command <mass_driver.commands.run_command>`
     - .. autodoc2-docstring:: mass_driver.commands.run_command
          :parser: myst
          :summary:
   * - :py:obj:`scanners_command <mass_driver.commands.scanners_command>`
     - .. autodoc2-docstring:: mass_driver.commands.scanners_command
          :parser: myst
          :summary:
   * - :py:obj:`review_pr_command <mass_driver.commands.review_pr_command>`
     - .. autodoc2-docstring:: mass_driver.commands.review_pr_command
          :parser: myst
          :summary:
   * - :py:obj:`config_error_exit <mass_driver.commands.config_error_exit>`
     - .. autodoc2-docstring:: mass_driver.commands.config_error_exit
          :parser: myst
          :summary:
   * - :py:obj:`source_repolist_args <mass_driver.commands.source_repolist_args>`
     - .. autodoc2-docstring:: mass_driver.commands.source_repolist_args
          :parser: myst
          :summary:
   * - :py:obj:`read_repolist <mass_driver.commands.read_repolist>`
     - .. autodoc2-docstring:: mass_driver.commands.read_repolist
          :parser: myst
          :summary:
   * - :py:obj:`maybe_save_outcome <mass_driver.commands.maybe_save_outcome>`
     - .. autodoc2-docstring:: mass_driver.commands.maybe_save_outcome
          :parser: myst
          :summary:
   * - :py:obj:`save_outcome <mass_driver.commands.save_outcome>`
     - .. autodoc2-docstring:: mass_driver.commands.save_outcome
          :parser: myst
          :summary:
   * - :py:obj:`needs_run <mass_driver.commands.needs_run>`
     - .. autodoc2-docstring:: mass_driver.commands.needs_run
          :parser: myst
          :summary:

API
~~~

.. py:function:: drivers_command(args: argparse.Namespace)
   :canonical: mass_driver.commands.drivers_command

   .. autodoc2-docstring:: mass_driver.commands.drivers_command
      :parser: myst

.. py:function:: forges_command(args: argparse.Namespace)
   :canonical: mass_driver.commands.forges_command

   .. autodoc2-docstring:: mass_driver.commands.forges_command
      :parser: myst

.. py:function:: sources_command(args: argparse.Namespace)
   :canonical: mass_driver.commands.sources_command

   .. autodoc2-docstring:: mass_driver.commands.sources_command
      :parser: myst

.. py:function:: plugins_command(args: argparse.Namespace, plugin: str, entrypoint: typing.Callable, discover: typing.Callable)
   :canonical: mass_driver.commands.plugins_command

   .. autodoc2-docstring:: mass_driver.commands.plugins_command
      :parser: myst

.. py:function:: run_command(args: argparse.Namespace) -> mass_driver.models.activity.ActivityOutcome
   :canonical: mass_driver.commands.run_command

   .. autodoc2-docstring:: mass_driver.commands.run_command
      :parser: myst

.. py:function:: scanners_command(args: argparse.Namespace)
   :canonical: mass_driver.commands.scanners_command

   .. autodoc2-docstring:: mass_driver.commands.scanners_command
      :parser: myst

.. py:function:: review_pr_command(args: argparse.Namespace)
   :canonical: mass_driver.commands.review_pr_command

   .. autodoc2-docstring:: mass_driver.commands.review_pr_command
      :parser: myst

.. py:function:: config_error_exit(e: pydantic.ValidationError)
   :canonical: mass_driver.commands.config_error_exit

   .. autodoc2-docstring:: mass_driver.commands.config_error_exit
      :parser: myst

.. py:function:: source_repolist_args(args) -> typing.Optional[mass_driver.models.repository.IndexedRepos]
   :canonical: mass_driver.commands.source_repolist_args

   .. autodoc2-docstring:: mass_driver.commands.source_repolist_args
      :parser: myst

.. py:function:: read_repolist(args) -> typing.Optional[list[str]]
   :canonical: mass_driver.commands.read_repolist

   .. autodoc2-docstring:: mass_driver.commands.read_repolist
      :parser: myst

.. py:function:: maybe_save_outcome(args: argparse.Namespace, outcome: mass_driver.models.activity.ActivityOutcome)
   :canonical: mass_driver.commands.maybe_save_outcome

   .. autodoc2-docstring:: mass_driver.commands.maybe_save_outcome
      :parser: myst

.. py:function:: save_outcome(outcome: mass_driver.models.activity.ActivityOutcome, out_file)
   :canonical: mass_driver.commands.save_outcome

   .. autodoc2-docstring:: mass_driver.commands.save_outcome
      :parser: myst

.. py:function:: needs_run(activity: mass_driver.models.activity.ActivityLoaded) -> bool
   :canonical: mass_driver.commands.needs_run

   .. autodoc2-docstring:: mass_driver.commands.needs_run
      :parser: myst