hpcflow.sdk.submission.schedulers.Scheduler

class hpcflow.sdk.submission.schedulers.Scheduler(shebang_executable=None, options=None)

Bases: ABC, Generic[JSRefType], AppAware

Abstract base class for schedulers.

Note

Do not make immediate subclasses of this class other than DirectScheduler and QueuedScheduler; subclass those two instead. Code (e.g., in Jobscript) assumes that this model is followed and does not check it.

Parameters:

shebang_executable (list[str]) – If specified, this will be used in the jobscript’s shebang line instead of the shell’s executable and executable_args attributes.

Methods

cancel_jobs	Cancel one or more jobscripts.
get_job_state_info	Get the state of one or more jobscripts.
get_std_out_err_filename	File name of combined standard output and error streams.
get_stderr_filename	File name of the standard error stream file.
get_stdout_filename	File name of the standard output stream file.
get_submit_command	Get a command for submitting a jobscript.
get_version_info	Get the version of the scheduler.
is_num_cores_supported	Test whether particular number of cores is supported in given range of cores.
parse_submission_output	Parse the output from a submission to determine the submission ID.
process_resources	Perform scheduler-specific processing to the element resources.
wait_for_jobscripts	Wait for one or more jobscripts to complete.

Attributes

unique_properties

Unique properties, for hashing.

abstractmethod cancel_jobs(js_refs, jobscripts=None, quiet=False)

Cancel one or more jobscripts.

Parameters:

• js_refs (list[JSRefType])

• jobscripts (list[Jobscript] | None)

• quiet (bool)

Return type:

None

abstractmethod get_job_state_info(*, js_refs=None)

Get the state of one or more jobscripts.

Parameters:

js_refs (Sequence[JSRefType] | None)

Return type:

Mapping[str, JobscriptElementState | Mapping[int, JobscriptElementState]]

abstractmethod get_std_out_err_filename(js_idx, *args, **kwargs)

File name of combined standard output and error streams.

Parameters:

js_idx (int)

Return type:

str

abstractmethod get_stderr_filename(js_idx, *args, **kwargs)

File name of the standard error stream file.

Parameters:

js_idx (int)

Return type:

str

abstractmethod get_stdout_filename(js_idx, *args, **kwargs)

File name of the standard output stream file.

Parameters:

js_idx (int)

Return type:

str

abstractmethod get_submit_command(shell, js_path, deps)

Get a command for submitting a jobscript.

Parameters:

• shell (Shell)

• js_path (str)

• deps (dict[Any, tuple[Any, ...]])

Return type:

list[str]

get_version_info()

Get the version of the scheduler.

Return type:

VersionInfo

static is_num_cores_supported(num_cores, core_range)

Test whether particular number of cores is supported in given range of cores.

Parameters:

• num_cores (int | None)

• core_range (Sequence[int])

Return type:

bool

parse_submission_output(stdout)

Parse the output from a submission to determine the submission ID.

Parameters:

stdout (str)

Return type:

str | None

abstractmethod process_resources(resources, scheduler_config)

Perform scheduler-specific processing to the element resources.

Note

This mutates resources.

Parameters:

• resources (ElementResources)

• scheduler_config (SchedulerConfigDescriptor)

Return type:

None

property unique_properties: tuple[str, ...]

Unique properties, for hashing.

abstractmethod wait_for_jobscripts(js_refs)

Wait for one or more jobscripts to complete.

Parameters:

js_refs (list[JSRefType])

Return type:

None