Skip to content

Module yapapi.runner.ctx

Variables

DownloadEvents

Classes

CommandContainer

class CommandContainer(

)

Methods

commands
def commands(
    self
)

Work

class Work(
    /,
    *args,
    **kwargs
)

Helper class that provides a standard way to create an ABC using inheritance.

Ancestors (in MRO)

  • abc.ABC

Descendants

  • yapapi.runner.ctx._InitStep
  • yapapi.runner.ctx._SendWork
  • yapapi.runner.ctx._Run
  • yapapi.runner.ctx._RecvFile
  • yapapi.runner.ctx._Steps

Methods

post
def post(
    self
)
prepare
def prepare(
    self
)
register
def register(
    self,
    commands:yapapi.runner.ctx.CommandContainer
)

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

WorkContext

class WorkContext(
    ctx_id:str,
    storage:yapapi.storage.StorageProvider,
    emitter:Union[yapapi.runner.events.EventEmitter[typing_extensions.Literal[<EventType.DOWNLOAD_STARTED: 23>, <EventType.DOWNLOAD_FINISHED: 24>]], NoneType]=None
)

Methods

begin
def begin(
    self
)
commit
def commit(
    self,
    task:'Task'
) -> Tuple[_ForwardRef('Task'), yapapi.runner.ctx.Work]
download_file
def download_file(
    self,
    src_path:str,
    dst_path:str
)
log
def log(
    self,
    *args
)
run
def run(
    self,
    cmd:str,
    *args:Iterable[str],
    env:Union[Dict[str, str], NoneType]=None
)
send_file
def send_file(
    self,
    src_path:str,
    dst_path:str
)
send_json
def send_json(
    self,
    json_path:str,
    data:dict
)