unilab.tools.completion

Shell completion helper for UniLab training entrypoints.

Functions

build_metadata([root])

complete_words(words, cword[, metadata])

install_main([argv])

main([argv])

Classes

CompletionMetadata

CompletionMetadata(commands: 'tuple[str, ...]', flags: 'dict[str, tuple[str, ...]]', choices: 'dict[str, dict[str, tuple[str, ...]]]', tasks: 'tuple[TaskCompletionEntry, ...]', run_paths: 'tuple[str, ...]' = (), root: 'Path | None' = None)

TaskCompletionEntry

TaskCompletionEntry(algo: 'str', task: 'str', sim: 'str', owner: 'str')
class unilab.tools.completion.TaskCompletionEntry[source]

Bases: object

TaskCompletionEntry(algo: ‘str’, task: ‘str’, sim: ‘str’, owner: ‘str’)

Parameters:
algo: str
task: str
sim: str
owner: str
__init__(algo, task, sim, owner)
Parameters:
class unilab.tools.completion.CompletionMetadata[source]

Bases: object

CompletionMetadata(commands: ‘tuple[str, …]’, flags: ‘dict[str, tuple[str, …]]’, choices: ‘dict[str, dict[str, tuple[str, …]]]’, tasks: ‘tuple[TaskCompletionEntry, …]’, run_paths: ‘tuple[str, …]’ = (), root: ‘Path | None’ = None)

Parameters:
commands: tuple[str, ...]
flags: dict[str, tuple[str, ...]]
choices: dict[str, dict[str, tuple[str, ...]]]
tasks: tuple[TaskCompletionEntry, ...]
run_paths: tuple[str, ...] = ()
root: Path | None = None
__init__(commands, flags, choices, tasks, run_paths=(), root=None)
Parameters:
unilab.tools.completion.build_metadata(root=None)[source]
Parameters:

root (Path | None)

Return type:

CompletionMetadata

unilab.tools.completion.complete_words(words, cword, metadata=None)[source]
Parameters:
Return type:

list[str]

unilab.tools.completion.install_main(argv=None)[source]
Parameters:

argv (Optional[Sequence[str]])

Return type:

int

unilab.tools.completion.main(argv=None)[source]
Parameters:

argv (Optional[Sequence[str]])

Return type:

int