Internal Jobs

class InternalJobStatusEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

The state of a record object. The states which are available are a finite set.

complete = 'complete'

waiting = 'waiting'

running = 'running'

error = 'error'

cancelled = 'cancelled'

pydantic model InternalJob

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

Fields:

• added_date (datetime.datetime)

• after_function (str | None)

• after_function_kwargs (Dict[str, Any] | None)

• ended_date (datetime.datetime | None)

• function (str)

• id (int)

• kwargs (Dict[str, Any])

• last_updated (datetime.datetime | None)

• name (str)

• progress (int)

• progress_description (str | None)

• repeat_delay (int | None)

• result (Any)

• runner_hostname (str | None)

• runner_uuid (str | None)

• scheduled_date (datetime.datetime)

• serial_group (str | None)

• started_date (datetime.datetime | None)

• status (qcportal.internal_jobs.models.InternalJobStatusEnum)

• user (str | None)

field id: int [Required]

field name: str [Required]

field status: InternalJobStatusEnum [Required]

field added_date: datetime [Required]

field scheduled_date: datetime [Required]

field started_date: datetime | None = None

field last_updated: datetime | None = None

field ended_date: datetime | None = None

field runner_hostname: str | None = None

field runner_uuid: str | None = None

field repeat_delay: int | None = None

field serial_group: str | None = None

field progress: int [Required]

field progress_description: str | None = None

field function: str [Required]

field kwargs: Dict[str, Any] [Required]

field after_function: str | None = None

field after_function_kwargs: Dict[str, Any] | None = None

field result: Any = None

field user: str | None = None

refresh()

Updates the data of this object with information from the server

watch(interval=2.0, timeout=None)

Watch an internal job for completion

Will poll every interval seconds until the job is finished (complete, error, cancelled, etc).

Parameters:

• interval (float) – Time (in seconds) between polls on the server

• timeout (float | None) – Max amount of time (in seconds) to wait. If None, will wait forever.

property duration: timedelta

property duration_str: str

pydantic model InternalJobQueryFilters

Bases: QueryProjModelBase

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

• validate_assignment: bool = True

Fields:

• added_after (datetime.datetime | None)

• added_before (datetime.datetime | None)

• cursor (int | None)

• exclude (List[str] | None)

• include (List[str] | None)

• job_id (List[int] | None)

• last_updated_after (datetime.datetime | None)

• last_updated_before (datetime.datetime | None)

• limit (int | None)

• name (List[str] | None)

• runner_hostname (List[str] | None)

• scheduled_after (datetime.datetime | None)

• scheduled_before (datetime.datetime | None)

• status (List[qcportal.internal_jobs.models.InternalJobStatusEnum] | None)

• user (List[int | str] | None)

Validators:

• parse_dates » added_after

• parse_dates » added_before

• parse_dates » last_updated_after

• parse_dates » last_updated_before

• parse_dates » scheduled_after

• parse_dates » scheduled_before

• validate_lists » cursor

• validate_lists » limit

field job_id: List[int] | None = None

field name: List[str] | None = None

field user: List[int | str] | None = None

field runner_hostname: List[str] | None = None

field status: List[InternalJobStatusEnum] | None = None

field last_updated_before: datetime | None = None

Validated by:

• parse_dates

field last_updated_after: datetime | None = None

Validated by:

• parse_dates

field added_before: datetime | None = None

Validated by:

• parse_dates

field added_after: datetime | None = None

Validated by:

• parse_dates

field scheduled_before: datetime | None = None

Validated by:

• parse_dates

field scheduled_after: datetime | None = None

Validated by:

• parse_dates

validator parse_dates  »  added_after, scheduled_before, last_updated_before, scheduled_after, added_before, last_updated_after

validator validate_lists  »  cursor, limit

field limit: int | None = None

Validated by:

• validate_lists

field cursor: int | None = None

Validated by:

• validate_lists

field include: List[str] | None = None

field exclude: List[str] | None = None

class InternalJobQueryIterator(client, query_filters)

Bases: QueryIteratorBase[InternalJob]

Iterator for internal job queries

This iterator transparently handles batching and pagination over the results of an internal job query.

Construct an iterator

Parameters:

• client – QCPortal client object used to contact/retrieve data from the server

• query_filters (InternalJobQueryFilters) – The actual query information to send to the server

reset()

Starts retrieval of results from the beginning again