lor.commands package¶
Submodules¶
lor.commands.dot module¶
Module for visualizing Luigi task graphs
-
class
lor.commands.dot.DotCommand¶ Bases:
lor.util.cli.CliCommand-
description()¶ Override to provide a method that returns a human-readable description of the command. :return:
-
name()¶ Override to provide a method that returns a unique name for the command. :return:
-
run(argv)¶ Override to provide a method that is called with the command’s arguments :param argv:
-
-
lor.commands.dot.print_as_dot(task)¶
-
lor.commands.dot.recursively_traverse_task(graph, task, parent_task_name=None, previously_traversed_task_names=None)¶
lor.commands.explain module¶
-
class
lor.commands.explain.ExplainCommand¶ Bases:
lor.util.cli.CliCommand-
description()¶ Override to provide a method that returns a human-readable description of the command. :return:
-
name()¶ Override to provide a method that returns a unique name for the command. :return:
-
run(argv)¶ Override to provide a method that is called with the command’s arguments :param argv:
-
-
lor.commands.explain.explain(task_obj)¶
-
lor.commands.explain.generate_depends(task_obj)¶
-
lor.commands.explain.generate_header(task_obj)¶
-
lor.commands.explain.generate_inputs(task_obj)¶
-
lor.commands.explain.generate_outputs(task_obj)¶
-
lor.commands.explain.generate_task_explanation(task_obj)¶
lor.commands.ls module¶
-
class
lor.commands.ls.LsCommand¶ Bases:
lor.util.cli.CliCommand-
description()¶ Override to provide a method that returns a human-readable description of the command. :return:
-
name()¶ Override to provide a method that returns a unique name for the command. :return:
-
run(argv)¶ Override to provide a method that is called with the command’s arguments :param argv:
-
lor.commands.new module¶
-
class
lor.commands.new.NewCommand¶ Bases:
lor.util.cli.CliCommand-
description()¶ Override to provide a method that returns a human-readable description of the command. :return:
-
name()¶ Override to provide a method that returns a unique name for the command. :return:
-
run(argv)¶ Override to provide a method that is called with the command’s arguments :param argv:
-
lor.commands.properties module¶
Module for a command that lists runtime property keys + values.
-
class
lor.commands.properties.PropertiesCommand¶ Bases:
lor.util.cli.CliCommand-
description()¶ Override to provide a method that returns a human-readable description of the command. :return:
-
name()¶ Override to provide a method that returns a unique name for the command. :return:
-
run(argv)¶ Override to provide a method that is called with the command’s arguments :param argv:
-
lor.commands.run module¶
-
class
lor.commands.run.RunCommand¶ Bases:
lor.util.cli.CliCommand-
description()¶ Override to provide a method that returns a human-readable description of the command. :return:
-
epilog= '\n This command is effectively an alias for the base `luigi` command. The only addition is that this command *also* \n allows overrides that are specific to LoR (e.g. overriding a property value).\n '¶
-
name()¶ Override to provide a method that returns a unique name for the command. :return:
-
run(argv)¶ Override to provide a method that is called with the command’s arguments :param argv:
-