.. _doot.control._interface:
  
=======================
doot.control._interface
=======================
  


.. py:module:: doot.control._interface

 









Protocols
---------

.. autoapisummary::

   doot.control._interface.Overlord_p
   doot.control._interface.Overlord_i
   doot.control._interface.Main_p
   doot.control._interface.Main_i





Module Contents
===============


.. _doot.control._interface.Overlord_p:
  


.. py:class:: Overlord_p

   Bases: :py:obj:`Protocol` 
  
   protocol for the doot accesspoint,
   used for setting up and using Doot programmatically


   
   .. py:method:: setup(*, targets: jgdv.Maybe[list[doot._interface.Loadable]] = None, prefix: str) -> None



   
   .. py:method:: load() -> None



   
   .. py:method:: load_reporter(target: str = 'default') -> None



   
   .. py:method:: verify_config_version(ver: jgdv.Maybe[str], sources: str | pathlib.Path, *, override: jgdv.Maybe[str] = None) -> None



   
   .. py:method:: update_aliases(*, data: dict | jgdv.structs.chainguard.ChainGuard) -> None



   
   .. py:method:: update_cmd_args(data: jgdv.cli._interface.ParseReport_d | dict) -> None



   
   .. py:method:: update_global_task_state(data: jgdv.structs.chainguard.ChainGuard, *, source: jgdv.Maybe[str] = None) -> None



   
   .. py:method:: update_import_path(*paths: pathlib.Path) -> None



 

.. _doot.control._interface.Overlord_i:
  


.. py:class:: Overlord_i

   Bases: :py:obj:`Overlord_p`, :py:obj:`Protocol` 
  
   protocol for the doot accesspoint,
   used for setting up and using Doot programmatically


   .. py:attribute:: config
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: constants
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: aliases
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: cmd_aliases
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: args
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: locs
      :type:  jgdv.structs.locator.JGDVLocator

   .. py:attribute:: configs_loaded_from
      :type:  list[str | pathlib.Path]

   .. py:attribute:: global_task_state
      :type:  dict

   .. py:attribute:: path_ext
      :type:  list[str]

   .. py:attribute:: is_setup
      :type:  bool

   .. py:attribute:: loaded_plugins
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: loaded_cmds
      :type:  jgdv.structs.chainguard.ChainGuard

   .. py:attribute:: loaded_tasks
      :type:  jgdv.structs.chainguard.ChainGuard

 

.. _doot.control._interface.Main_p:
  


.. py:class:: Main_p(*, args: jgdv.Maybe[list] = None)

   Bases: :py:obj:`Protocol` 
  
   protocol for doot as a main program


   .. py:property:: name
      :type: str


   
   .. py:method:: handle_cli_args() -> jgdv.Maybe[int]



   
   .. py:method:: help() -> str



   
   .. py:method:: setup_logging() -> None



 

.. _doot.control._interface.Main_i:
  


.. py:class:: Main_i(*, args: jgdv.Maybe[list] = None)

   Bases: :py:obj:`Main_p`, :py:obj:`Protocol` 
  
   protocol for doot as a main program


   .. py:attribute:: result_code
      :type:  int

   .. py:attribute:: prog_name
      :type:  str

   .. py:attribute:: raw_args
      :type:  list[str]

   .. py:attribute:: current_cmd
      :type:  jgdv.Maybe[doot.cmd._interface.Command_p]

   .. py:attribute:: parser
      :type:  jgdv.Maybe[jgdv.cli.ParseMachine]

   .. py:attribute:: log_config
      :type:  jgdv.logging.JGDVLogConfig