cowbird.cli.utils
=================

.. py:module:: cowbird.cli.utils


Attributes
----------

.. autoapisummary::

   cowbird.cli.utils.CommandPrefixes
   cowbird.cli.utils.SharedParsers
   cowbird.cli.utils.ParsedArgs
   cowbird.cli.utils.ParserArgs
   cowbird.cli.utils.HelperParser
   cowbird.cli.utils.ParseResult
   cowbird.cli.utils.ParserMaker
   cowbird.cli.utils.ParserRunner
   cowbird.cli.utils.SubParserArgs
   cowbird.cli.utils.PrintFormat


Functions
---------

.. autoapisummary::

   cowbird.cli.utils.subparser_help
   cowbird.cli.utils.get_config_parser
   cowbird.cli.utils.get_logger_parser
   cowbird.cli.utils.set_log_level
   cowbird.cli.utils.get_format_parser
   cowbird.cli.utils.print_format


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

.. py:data:: CommandPrefixes

.. py:data:: SharedParsers

.. py:data:: ParsedArgs

.. py:data:: ParserArgs

.. py:data:: HelperParser

.. py:data:: ParseResult

.. py:data:: ParserMaker

.. py:data:: ParserRunner

.. py:data:: SubParserArgs

.. py:data:: PrintFormat

.. py:function:: subparser_help(description: str, parent_parser: Optional[argparse.ArgumentParser] = None) -> SubParserArgs

   Generates both fields with the same description as each parameter is used in different context.

   Field ``help`` is printed next to the subparser name when *parent parser* is called with ``--help``.
   Field ``description`` populates the help details under the usage command when calling *child parser* ``--help``.


.. py:function:: get_config_parser() -> argparse.ArgumentParser

.. py:function:: get_logger_parser() -> argparse.ArgumentParser

.. py:function:: set_log_level(args: argparse.Namespace, logger: Optional[logging.Logger] = None) -> None

.. py:function:: get_format_parser() -> argparse.ArgumentParser

.. py:function:: print_format(data: cowbird.typedefs.JSON, fmt: PrintFormat, section: Optional[str] = None) -> None