neuralib.argp.dispatch.DispatchOption

class neuralib.argp.dispatch.DispatchOption[source]

Bases: object

argument

alias of DispatchArgument

list_commands(group=<object object>)[source]

list all dispatch-decoratored function info in host.

Parameters:

group (str | None) – dispatch group.

Returns:

list of DispatchCommand

Return type:

list[DispatchCommand]

find_command(command, group=<object object>)[source]

find dispatch-decoratored function in host according to command.

Parameters:

  • command (str) – command or command alias

  • group (str | None) – dispatch group

Returns:

found DispatchCommand

Return type:

DispatchCommand | None

invoke_command(command, *args, **kwargs)[source]

invoke a dispatch-decoratored function in default group.

Parameters:

  • command (str) – command or command alias

  • args – dispatch-decoratored function positional arguments

  • kwargs – dispatch-decoratored function keyword arguments

Returns:

function return

Raises:

DispatchCommandNotFound –

Return type:

Any

invoke_group_command(group, command, *args, **kwargs)[source]

invoke a dispatch-decoratored function in certain group.

Parameters:

  • group (str) – dispatch group

  • command (str) – command or command alias

  • args – dispatch-decoratored function positional arguments

  • kwargs – dispatch-decoratored function keyword arguments

Returns:

function return

Raises:

DispatchCommandNotFound –

Return type:

Any

classmethod dispatch(command, alias=None, group=None)[source]
Parameters:

  • command (str)

  • alias (str | list[str] | None)

  • group (str | None)

classmethod parser_command_epilog(group=<object object>)[source]
Parameters:

group (str | None)

Return type:

str