magpie.cli
==========

.. py:module:: magpie.cli


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/magpie/cli/batch_update_permissions/index
   /autoapi/magpie/cli/batch_update_users/index
   /autoapi/magpie/cli/register_defaults/index
   /autoapi/magpie/cli/register_providers/index
   /autoapi/magpie/cli/run_db_migration/index
   /autoapi/magpie/cli/send_email/index
   /autoapi/magpie/cli/sync_resources/index
   /autoapi/magpie/cli/sync_services/index
   /autoapi/magpie/cli/utils/index


Attributes
----------

.. autoapisummary::

   magpie.cli.__version__


Classes
-------

.. autoapisummary::

   magpie.cli.SubArgumentParserFixedMutexGroups


Functions
---------

.. autoapisummary::

   magpie.cli.magpie_helper_cli


Package Contents
----------------

.. py:data:: __version__
   :value: '4.1.0'


.. py:class:: SubArgumentParserFixedMutexGroups(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

   Bases: :py:obj:`argparse.ArgumentParser`


   Patch incorrectly handled mutually exclusive groups sections in subparsers.

   .. seealso::
       - https://bugs.python.org/issue43259
       - https://bugs.python.org/issue16807


   .. py:method:: _add_container_actions(container)


.. py:function:: magpie_helper_cli(args=None)

   Groups all sub-helper CLI listed in :py:mod:`magpie.cli` as a common ``magpie_helper``.

   Dispatches the provided arguments to the appropriate sub-helper CLI as requested. Each sub-helper CLI must implement
   functions ``make_parser`` and ``main`` to generate the arguments and dispatch them to the corresponding caller.