pyslurmutils.client.rest.pyscript.SlurmPythonJobRestClient#

class pyslurmutils.client.rest.pyscript.SlurmPythonJobRestClient(*args, data_directory=None, max_workers=None, pre_script=None, post_script=None, python_cmd=None, **kw)[source]#

Bases: SlurmScriptRestClient

SLURM API to submit, cancel and monitor python functions. This class contains job-related state (needed to handle response).

Parameters:

  • max_workers (Optional[int]) –

  • pre_script (Optional[str]) –

  • post_script (Optional[str]) –

  • python_cmd (Optional[str]) –

VERSION = '0.0.37'#
cancel_job(job_id, request_options=None)#
Parameters:

  • job_id (int) –

  • request_options (Optional[dict]) –

Return type:

None

clean_all_job_artifacts()[source]#

Cleanup on-disk artifacts

Return type:

None

clean_job_artifacts(job_id, raise_on_error=False, **kw)[source]#
Parameters:

job_id (int) –

cleanup(wait=True, cancel_futures=False)[source]#

Cleanup in-memory artifacts but not on-disk artifacts (see clean_all_job_artifacts)

Parameters:

  • wait (bool) –

  • cancel_futures (bool) –

Return type:

None

delete(path, request_options=None, error_msg=None, raise_on_error=True)#
Parameters:

  • path (str) –

  • request_options (Optional[dict]) –

  • error_msg (Optional[str]) –

  • raise_on_error (bool) –

Return type:

dict

get(path, request_options=None, error_msg=None, raise_on_error=True)#
Parameters:

  • path (str) –

  • request_options (Optional[dict]) –

  • error_msg (Optional[str]) –

  • raise_on_error (bool) –

Return type:

dict

get_all_job_properties(raise_on_error=True, request_options=None, filter=None, update_time=None)#
Parameters:

request_options (Optional[dict]) –

Return type:

List[dict]

get_full_status(job_id, request_options=None)#
Parameters:

job_id (int) –

Return type:

dict

get_future(job_id, **kw)[source]#
Parameters:

job_id (int) –

Return type:

Optional[Future]

get_headers()#
Return type:

dict

get_job_properties(job_id, raise_on_error=True, request_options=None)#
Parameters:

  • job_id (int) –

  • request_options (Optional[dict]) –

Return type:

Optional[dict]

get_result(job_id)[source]#
Parameters:

job_id (int) –

Return type:

Any

get_status(job_id, request_options=None)#
Parameters:

job_id (int) –

Return type:

str

get_stdout_stderr(job_id, **kw)#
Parameters:

job_id (int) –

Return type:

Tuple[StdInfo, StdInfo]

property io_handler: JobIoHandler#
log_stdout_stderr(job_id, logger=None, level=20, **kw)#
Parameters:

job_id (int) –

Return type:

None

post(path, json=None, request_options=None, raise_on_error=True, error_msg=None)#
Parameters:

  • path (str) –

  • json (Optional[dict]) –

  • request_options (Optional[dict]) –

  • raise_on_error (bool) –

  • error_msg (Optional[str]) –

Return type:

dict

print_stdout_stderr(job_id)#
Parameters:

job_id (int) –

server_has_api(request_options=None)#
Parameters:

request_options (Optional[dict]) –

Return type:

bool

spawn(func, args=None, kwargs=None, pre_script=None, post_script=None, python_cmd=None, **submit_kw)[source]#
Parameters:

  • func (Callable) –

  • args (Optional[Tuple]) –

  • kwargs (Optional[Mapping]) –

  • pre_script (Optional[str]) –

  • post_script (Optional[str]) –

  • python_cmd (Optional[str]) –

Return type:

Future

submit_job(script, parameters=None, metadata=None, request_options=None)#

Returns the SLURM job ID

Parameters:

  • script (str) –

  • parameters (Optional[dict]) –

  • metadata (Union[str, dict, None]) –

  • request_options (Optional[dict]) –

Return type:

int

submit_script(script=None, **kw)#

Submit a script. Assume it is a bash script in the absence of a shebang.

Parameters:

script (Union[str, Sequence[str], None]) –

Return type:

int

wait_done(job_id, *args, **kw)[source]#
Parameters:

job_id (int) –

Return type:

str