client.cli

Client command line interface for workflow/task status and concurrency limiting.

Classes

_HelpAction	To show help for all subparsers in one place.
ClientCLI	Client command line interface for workflow/task status and concurrency limiting.

Functions

main(→ None)

Create CLI.

Module Contents

class client.cli._HelpAction(option_strings, dest=SUPPRESS, default=SUPPRESS, help=None)

Bases: argparse._HelpAction

To show help for all subparsers in one place.

__call__(parser: Any, namespace: argparse.Namespace, values: Any, option_string: str | None = None) → None

Add subparsers’ help info when jobmon –help is called.

class client.cli.ClientCLI

Bases: jobmon.core.cli.CLI

Client command line interface for workflow/task status and concurrency limiting.

parser

_subparsers

static limit_checker(limit: Any) → int

Coerce to int and check that the limit is greater than 0.

static workflow_status(args: argparse.Namespace) → None

Workflow status checking options.

static workflow_tasks(args: argparse.Namespace) → None

Check the tasks for a given workflow.

static task_template_resources(args: argparse.Namespace) → None

Aggregates the resource usage for a given TaskTemplateVersion.

static task_status(args: argparse.Namespace) → None

Check task status.

static update_task_status(args: argparse.Namespace) → None

Manually update task status for resumes, reruns, etc.

static concurrency_limit(args: argparse.Namespace) → None

Set a limit for the number of tasks that can run concurrently.

static task_dependencies(args: argparse.Namespace) → None

Get task’s upstream and downstream tasks and their status.

static workflow_reset(args: argparse.Namespace) → None

Manually reset a workflow.

static jobmon_version(args: argparse.Namespace) → None

Return the jobmon version.

static resource_yaml(args: argparse.Namespace) → None

Create resource yaml.

static resume_workflow(args: argparse.Namespace) → None

Resume a workflow from a workflow ID.

static get_filepaths(args: argparse.Namespace) → None

static update_config(args: argparse.Namespace) → None

Update a configuration value in the defaults.yaml file.

_add_version_subparser() → None

_add_workflow_status_subparser() → None

_add_workflow_tasks_subparser() → None

_add_task_template_resources_subparser() → None

_add_task_status_subparser() → None

_add_update_task_status_subparser() → None

_add_concurrency_limit_subparser() → None

_add_task_dependencies_subparser() → None

_add_workflow_reset_subparser() → None

_add_create_resource_yaml_subparser() → None

_add_get_filepaths_subparser() → None

_add_resume_workflow_parser() → None

_add_update_config_subparser() → None

client.cli.main(argstr: str | None = None) → None

Create CLI.