Ctrl+K

pyslk.job_report_raw

Contents

pyslk.job_report_raw#

pyslk.job_report_raw(job_id: int | str, outfile: Path | str | None = None, overwrite: bool = False, return_incomplete_report: bool = False, return_type: int = 0) → str | int | CompletedProcess#

return job report

Parameters:

  • job_id (str or int) – a job id

  • outfile (str or Path) – optional output file if job report should be written into a file

  • overwrite (bool) – overwrite destination output file if it already exists

  • return_incomplete_report (bool) – try to write out job report even if job is not finished yet

  • return_type (int) – select between 0 (== str output), 1 (== exit code), 2 (subprocess output)

Returns:

stdout of the slk call

Return type:

Union[str, int, subprocess.CompletedProcess]

Contents