kedro.framework.cli.cli.KedroCLI

class documentation

class KedroCLI(CommandCollection): (source)

View In Hierarchy

A CommandCollection class to encapsulate the KedroCLI command loading.

Method __init__ Undocumented
Method main Undocumented
Property global_groups Property which loads all global command groups from plugins and combines them with the built-in ones (eventually overriding the built-in ones if they are redefined by plugins).
Property project_groups Property which loads all project command groups from the project and the plugins, then combines them with the built-in ones. Built-in commands can be overridden by plugins, which can be overridden by a custom project cli...
Instance Variable _cli_hook_manager Undocumented
Instance Variable _metadata Undocumented

Inherited from CommandCollection:

Method format_commands Undocumented
Method resolve_command Undocumented
Instance Variable callback Undocumented
Instance Variable groups Undocumented
Instance Variable params Undocumented
Static Method _dedupe_commands Deduplicate commands by keeping the ones from the last source in the list.
Static Method _merge_same_name_collections Undocumented
def __init__(self, project_path: Path): (source)
overrides kedro.framework.cli.utils.CommandCollection.__init__

Undocumented

def main(self, args=None, prog_name=None, complete_var=None, standalone_mode=True, **extra): (source)

Undocumented

@property
global_groups: Sequence[click.MultiCommand] = (source)

Property which loads all global command groups from plugins and combines them with the built-in ones (eventually overriding the built-in ones if they are redefined by plugins).

@property
project_groups: Sequence[click.MultiCommand] = (source)

Property which loads all project command groups from the project and the plugins, then combines them with the built-in ones. Built-in commands can be overridden by plugins, which can be overridden by a custom project cli.py. See https://kedro.readthedocs.io/en/stable/extend_kedro/common_use_cases.html#use-case-3-how-to-add-or-modify-cli-commands on how to add this.

_cli_hook_manager = (source)

Undocumented

_metadata = (source)

Undocumented