doot.cmds.structs.stub

Classes

TaskStub	Stub Task Spec for description in toml
TaskStubPart	Describes a single part of a stub task in toml

Module Contents

class doot.cmds.structs.stub.TaskStub(/, **data: Any)

Bases: pydantic.BaseModel, jgdv._abstract.protocols.general.StubStruct_p, 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

Parameters:

data (Any)

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

parts: dict[str, TaskStubPart]

skip_parts: ClassVar[set[str]]

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

Parameters:

data (jgdv.Maybe[dict])

initial_values() → <Unknown>

to_toml() → str

Return type:

str

class doot.cmds.structs.stub.TaskStubPart(/, **data: Any)

Bases: pydantic.BaseModel

Describes a single part of a stub task in toml

Parameters:

data (Any)

key: str

type_: str | pydantic.InstanceOf[type] | Any = 'str'

prefix: str = ''

default: Any = None

comment: str = ''

priority: int = 0

_key_str() → str

Return type:

str

_type_str() → str

Return type:

str

_comment_str() → str

Return type:

str

_default_str() → str

Formats the default toml representation of this stub part

Return type:

str

set(**kwargs) → <Unknown>