openprotein.align.MSAFuture#

class openprotein.align.MSAFuture(session, job, page_size=50000)[source]#

Represents a future for MSA (Multiple Sequence Alignment) results.

Parameters:

  • session (APISession)

  • job (MSAJob | MafftJob | ClustalOJob | AbNumberJob)

  • page_size (int)

__init__(session, job, page_size=50000)[source]#

Initialize an MSAFuture instance.

Parameters:

  • session (APISession) – An instance of APISession for API interactions.

  • job (MSAJob) – The MSA job.

  • page_size (int, optional) – The number of results to fetch in a single page. Defaults to config.POET_PAGE_SIZE.

Methods

__init__(session, job[, page_size])

Initialize an MSAFuture instance.

cancelled()

Check if the job has been cancelled.

create(session[, job_id, job, response])

Create an instance of the appropriate Future class based on the job type.

done()

Check if the job has completed.

get([verbose])

Retrieve the MSA of the job.

get_input(input_type)

Retrieve input data for this alignment job.

get_seed()

Retrieve the seed sequence for this alignment job.

refresh()

Refresh the job status and internal job object.

sample_prompt([num_sequences, num_residues, ...])

Create a protein sequence prompt from the linked MSA for PoET Jobs.

wait([interval, timeout, verbose])

Wait for the job to complete, then fetch results.

wait_until_done([interval, timeout, verbose])

Wait for the job to complete.

Attributes

created_date

The creation timestamp of the job.

end_date

The end timestamp of the job.

id

The job ID for this alignment job.

job_id

The unique identifier of the job.

job_type

The type of the job.

progress_counter

The progress counter of the job.

start_date

The start timestamp of the job.

status

The current status of the job.

job

session