.. _doot.cmds.structs.stub:
  
======================
doot.cmds.structs.stub
======================
  


.. py:module:: doot.cmds.structs.stub

 











Classes
-------
  


.. autoapisummary::

    doot.cmds.structs.stub.TaskStub
    doot.cmds.structs.stub.TaskStubPart

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


.. _doot.cmds.structs.stub.TaskStub:
  


.. py:class:: TaskStub(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`, :py:obj:`jgdv._abstract.protocols.general.StubStruct_p`, :py:obj:`jgdv._abstract.protocols.general.Buildable_p` 
  
   Stub Task Spec for description in toml
   Automatically Adds default keys from TaskSpec

   This essentially wraps a dict, adding toml stubs parts as you access keys.
   eg:
   obj = TaskStub()
   ob["blah"].type = "int"

   # str(obj) -> will now generate toml, including a "blah" key



   .. py:attribute:: ctor
      :type:  str | jgdv.structs.strang.CodeReference | type

   .. py:attribute:: parts
      :type:  dict[str, TaskStubPart]

   .. py:attribute:: skip_parts
      :type:  ClassVar[set[str]]

   
   .. py:method:: build(data: jgdv.Maybe[dict] = None) -> <Unknown>
      :classmethod:



   
   .. py:method:: initial_values() -> <Unknown>



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



 

.. _doot.cmds.structs.stub.TaskStubPart:
  


.. py:class:: TaskStubPart(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel` 
  
   Describes a single part of a stub task in toml


   .. py:attribute:: key
      :type:  str

   .. py:attribute:: type_
      :type:  str | pydantic.InstanceOf[type] | Any
      :value: 'str'


   .. py:attribute:: prefix
      :type:  str
      :value: ''


   .. py:attribute:: default
      :type:  Any
      :value: None


   .. py:attribute:: comment
      :type:  str
      :value: ''


   .. py:attribute:: priority
      :type:  int
      :value: 0


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



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



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



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


      Formats the default toml representation of this stub part



   
   .. py:method:: set(**kwargs) -> <Unknown>