pulsar.managers.util.cli.job package

Submodules

pulsar.managers.util.cli.job.lsf module

class pulsar.managers.util.cli.job.lsf.LSF(**params)

Bases: BaseJobExec

delete(job_id)

Given job id, return command to stop execution or dequeue specified job.

get_failure_reason(job_id)

Return the failure reason for the given job_id.

get_single_status(job_id)

Return command to get the status of a single, specified job.

get_status(job_ids=None)

Return command to get statuses of specified job ids.

job_script_kwargs(ofile, efile, job_name)

Return extra keyword argument for consumption by job script module.

parse_failure_reason(reason, job_id)

Parses the failure reason, assigning it against a

parse_single_status(status, job_id)

Parse the status of output from get_single_status command.

parse_status(status, job_ids)

Parse the statuses of output from get_status command.

submit(script_file)

Given specified script_file path, yield command to submit it to external job manager.

pulsar.managers.util.cli.job.pbs module

class pulsar.managers.util.cli.job.pbs.OpenPBS(**params)

Bases: Torque

ERROR_MESSAGE_UNRECOGNIZED_ARG = 'Unrecognized long argument passed to OpenPBS CLI plugin: %s'

get_single_status(job_id)

Return command to get the status of a single, specified job.

get_status(job_ids=None)

Return command to get statuses of specified job ids.

parse_status(status, job_ids)

Parse the statuses of output from get_status command.

pulsar.managers.util.cli.job.slurm module

class pulsar.managers.util.cli.job.slurm.Slurm(**params)

Bases: BaseJobExec

delete(job_id)

Given job id, return command to stop execution or dequeue specified job.

get_single_status(job_id)

Return command to get the status of a single, specified job.

get_status(job_ids=None)

Return command to get statuses of specified job ids.

job_script_kwargs(ofile, efile, job_name)

Return extra keyword argument for consumption by job script module.

parse_single_status(status, job_id)

Parse the status of output from get_single_status command.

parse_status(status, job_ids)

Parse the statuses of output from get_status command.

submit(script_file)

Given specified script_file path, yield command to submit it to external job manager.

pulsar.managers.util.cli.job.slurm_torque module

class pulsar.managers.util.cli.job.slurm_torque.SlurmTorque(**params)

Bases: Torque

A CLI job executor for Slurm’s Torque compatibility mode. This differs from real torque CLI in that -x command line is not available so job status needs to be parsed from qstat table instead of XML.

get_status(job_ids=None)

Return command to get statuses of specified job ids.

parse_status(status, job_ids)

Parse the statuses of output from get_status command.

pulsar.managers.util.cli.job.torque module

class pulsar.managers.util.cli.job.torque.Torque(**params)

Bases: BaseJobExec

ERROR_MESSAGE_UNRECOGNIZED_ARG = 'Unrecognized long argument passed to Torque CLI plugin: %s'

delete(job_id)

Given job id, return command to stop execution or dequeue specified job.

get_single_status(job_id)

Return command to get the status of a single, specified job.

get_status(job_ids=None)

Return command to get statuses of specified job ids.

job_script_kwargs(ofile, efile, job_name)

Return extra keyword argument for consumption by job script module.

parse_single_status(status, job_id)

Parse the status of output from get_single_status command.

parse_status(status, job_ids)

Parse the statuses of output from get_status command.

submit(script_file)

Given specified script_file path, yield command to submit it to external job manager.

Module contents

Abstract base class for cli job plugins.

class pulsar.managers.util.cli.job.BaseJobExec(**params)

Bases: object

abstractmethod delete(job_id)

Given job id, return command to stop execution or dequeue specified job.

get_failure_reason(job_id)

Return the failure reason for the given job_id.

abstractmethod get_single_status(job_id)

Return command to get the status of a single, specified job.

abstractmethod get_status(job_ids=None)

Return command to get statuses of specified job ids.

job_script_kwargs(ofile, efile, job_name)

Return extra keyword argument for consumption by job script module.

parse_failure_reason(reason, job_id)

Parses the failure reason, assigning it against a

abstractmethod parse_single_status(status, job_id)

Parse the status of output from get_single_status command.

abstractmethod parse_status(status, job_ids)

Parse the statuses of output from get_status command.

abstractmethod submit(script_file)

Given specified script_file path, yield command to submit it to external job manager.

class pulsar.managers.util.cli.job.job_states(value)

Bases: str, Enum

ERROR = 'failed'

OK = 'complete'

QUEUED = 'queued'

RUNNING = 'running'