flux.job.list module

class flux.job.list.JobList(flux_handle, attrs=['all'], filters=[], ids=[], user=None, max_entries=1000, since=0.0, name=None, queue=None)

Bases: object

User friendly class for querying lists of jobs from Flux

By default a JobList will query the last max_entries jobs for all users. Other filter parameters can be passed to the constructor or the set_user() and add_filter() methods.


A Flux handle obtained from flux.Flux()


Optional list of job attributes to fetch. (default is all attrs)


List of strings defining the results or states to filter. E.g., [ "pending", "running" ].


List of jobids to return. Other filters are ignored if ids is not empty.


Username or userid for which to fetch jobs. Default is all users.


Maximum number of jobs to return

RESULTS = {'canceled': flux.constants.FLUX_JOB_RESULT_CANCELED, 'completed': flux.constants.FLUX_JOB_RESULT_COMPLETED, 'failed': flux.constants.FLUX_JOB_RESULT_FAILED, 'timeout': flux.constants.FLUX_JOB_RESULT_TIMEOUT}
STATES = {'active': flux.constants.FLUX_JOB_STATE_ACTIVE, 'cleanup': flux.constants.FLUX_JOB_STATE_CLEANUP, 'depend': flux.constants.FLUX_JOB_STATE_DEPEND, 'inactive': flux.constants.FLUX_JOB_STATE_INACTIVE, 'pending': flux.constants.FLUX_JOB_STATE_PENDING, 'priority': flux.constants.FLUX_JOB_STATE_PRIORITY, 'run': flux.constants.FLUX_JOB_STATE_RUN, 'running': flux.constants.FLUX_JOB_STATE_RUNNING, 'sched': flux.constants.FLUX_JOB_STATE_SCHED}

Append a state or result filter to JobList query


Initiate the JobList query to the Flux job-info module

JobList.fetch_jobs() returns a JobListRPC or JobListIdsFuture, either of which will be fulfilled when the job data is available.

Once the Future has been fulfilled, a list of JobInfo objects can be obtained via JobList.jobs(). If JobList.errors is non-empty, then it will contain a list of errors returned via the query.


Synchronously fetch a list of JobInfo objects from JobList query

If the Future object returned by JobList.fetch_jobs has not yet been fulfilled (e.g. is_ready() returns False), then this call may block. Otherwise, returns a list of JobInfo objects for all jobs returned from the underlying job listing RPC.


Only return jobs for user (may be a username or userid)

class flux.job.list.JobListIdRPC(*args, **kwargs)

Bases: flux.rpc.RPC

class flux.job.list.JobListIdsFuture

Bases: flux.future.WaitAllFuture

Simulate interface of JobListRPC for listing multiple jobids


get all successful results as list of JobInfo objects

Any errors are appended to self.errors.


get all successful results, appending errors into self.errors

class flux.job.list.JobListRPC(flux_handle, topic, payload=None, nodeid=flux.constants.FLUX_NODEID_ANY, flags=0)

Bases: flux.rpc.RPC

flux.job.list.get_job(flux_handle, jobid)

Get job information dictionary based on a jobid

This is a courtesy, blocking function for users looking for details about a job after submission. The dictionary includes the job identifier, userid that submit it, urgency, priority, t_submit, t_depend, (and others when finished), state, name, ntasks, ncores, duration, nnodes, result, runtime, returncode, waitstatus, nodelist, and exception type, severity, and note.

flux.job.list.job_list(flux_handle, max_entries=1000, attrs=['all'], userid=1005, states=0, results=0, since=0.0, name=None, queue=None)
flux.job.list.job_list_id(flux_handle, jobid, attrs=['all'])
flux.job.list.job_list_inactive(flux_handle, since=0.0, max_entries=1000, attrs=['all'], name=None, queue=None)