flux.job package

Subpackages

• flux.job.frobnicator package
  • Submodules
    • flux.job.frobnicator.frobnicator module
      • FrobnicatorPlugin
      • JobFrobnicator
• flux.job.validator package
  • Submodules
    • flux.job.validator.validator module
      • JobValidator
      • ValidatorJobInfo
      • ValidatorPlugin
      • ValidatorResult

Submodules

• flux.job.JobID module
  • JobID
    • JobID.dec
    • JobID.dothex
    • JobID.emoji
    • JobID.encode()
    • JobID.f58
    • JobID.f58plain
    • JobID.hex
    • JobID.kvs
    • JobID.orig
    • JobID.words
  • id_encode()
  • id_parse()
• flux.job.Jobspec module
  • Jobspec
    • Jobspec.add_file()
    • Jobspec.attributes
    • Jobspec.cwd
    • Jobspec.dumps()
    • Jobspec.duration
    • Jobspec.environment
    • Jobspec.error
    • Jobspec.from_yaml_file()
    • Jobspec.from_yaml_stream()
    • Jobspec.getattr()
    • Jobspec.input
    • Jobspec.output
    • Jobspec.queue
    • Jobspec.resource_counts()
    • Jobspec.resource_walk()
    • Jobspec.resources
    • Jobspec.setattr()
    • Jobspec.setattr_shell_option()
    • Jobspec.stderr
    • Jobspec.stdin
    • Jobspec.stdout
    • Jobspec.tasks
    • Jobspec.top_level_keys
    • Jobspec.unbuffered
    • Jobspec.version
  • JobspecV1
    • JobspecV1.apply_options()
    • JobspecV1.from_alloc()
    • JobspecV1.from_batch()
    • JobspecV1.from_batch_command()
    • JobspecV1.from_command()
    • JobspecV1.from_nest_command()
    • JobspecV1.from_submit()
    • JobspecV1.per_resource()
  • validate_counts()
  • validate_jobspec()
• flux.job.directives module
  • Directive
    • Directive.lineno
    • Directive.args
    • Directive.action
  • DirectiveParser
    • DirectiveParser.directives
    • DirectiveParser.script
    • DirectiveParser.append()
    • DirectiveParser.triplequote()
  • MultiLine
    • MultiLine.append()
    • MultiLine.finish()
    • MultiLine.process()
• flux.job.event module
  • JobEventWatchFuture
    • JobEventWatchFuture.get_event()
    • JobEventWatchFuture.watch_cancel()
    • JobEventWatchFuture.watch_get()
  • JobException
  • event_wait()
  • event_watch()
  • event_watch_async()
• flux.job.executor module
  • FluxExecutor
    • FluxExecutor.EVENTS
    • FluxExecutor.attach()
    • FluxExecutor.shutdown()
    • FluxExecutor.submit()
  • FluxExecutorFuture
    • FluxExecutorFuture.EVENTS
    • FluxExecutorFuture.add_done_callback()
    • FluxExecutorFuture.add_event_callback()
    • FluxExecutorFuture.add_jobid_callback()
    • FluxExecutorFuture.cancel()
    • FluxExecutorFuture.exception()
    • FluxExecutorFuture.jobid()
    • FluxExecutorFuture.result()
    • FluxExecutorFuture.set_exception()
• flux.job.info module
  • AnnotationsInfo
  • DependencyList
  • EmptyObject
  • ExceptionInfo
  • InfoList
  • InstanceInfo
    • InstanceInfo.gpu_utilization
    • InstanceInfo.progress
    • InstanceInfo.utilization
  • JobInfo
    • JobInfo.contextual_info
    • JobInfo.contextual_time
    • JobInfo.defaults
    • JobInfo.get_instance_info()
    • JobInfo.get_remaining_time()
    • JobInfo.get_runtime()
    • JobInfo.inactive_reason
    • JobInfo.properties
    • JobInfo.result
    • JobInfo.result_abbrev
    • JobInfo.result_emoji
    • JobInfo.returncode
    • JobInfo.runtime
    • JobInfo.state
    • JobInfo.state_emoji
    • JobInfo.state_single
    • JobInfo.status
    • JobInfo.status_abbrev
    • JobInfo.status_emoji
    • JobInfo.t_remaining
    • JobInfo.to_dict()
    • JobInfo.uri
    • JobInfo.username
  • JobInfoFormat
    • JobInfoFormat.headings
  • StatsInfo
  • get_username()
  • job_fields_to_attrs()
  • resulttoemoji()
  • resulttostr()
  • statetoemoji()
  • statetostr()
  • statustoemoji()
  • statustostr()
• flux.job.journal module
  • JournalConsumer
    • JournalConsumer.SENTINEL_EVENT
    • JournalConsumer.create_event()
    • JournalConsumer.process_response()
    • JournalConsumer.request_payload
  • JournalEvent
    • JournalEvent.jobid
    • JournalEvent.name
    • JournalEvent.timestamp
    • JournalEvent.context
    • JournalEvent.context_string
    • JournalEvent.jobspec
    • JournalEvent.R
    • JournalEvent.is_empty()
  • SENTINEL_EVENT
• flux.job.kill module
  • cancel()
  • cancel_async()
  • job_raise()
  • job_raise_async()
  • kill()
  • kill_async()
• flux.job.kvs module
  • job_kvs()
  • job_kvs_guest()
• flux.job.kvslookup module
  • JobInfoLookupRPC
    • JobInfoLookupRPC.get()
    • JobInfoLookupRPC.get_decode()
  • JobKVSLookup
    • JobKVSLookup.data()
    • JobKVSLookup.fetch_data()
  • JobKVSLookupFuture
    • JobKVSLookupFuture.get()
    • JobKVSLookupFuture.get_decode()
  • decode_special_data()
  • job_info_lookup()
  • job_kvs_lookup()
• flux.job.list module
  • JobList
    • JobList.RESULTS
    • JobList.STATES
    • JobList.add_filter()
    • JobList.fetch_jobs()
    • JobList.jobs()
    • JobList.set_user()
  • JobListIdRPC
    • JobListIdRPC.get_job()
    • JobListIdRPC.get_jobinfo()
  • JobListIdsFuture
    • JobListIdsFuture.get_jobinfos()
    • JobListIdsFuture.get_jobs()
  • JobListRPC
    • JobListRPC.get_jobinfos()
    • JobListRPC.get_jobs()
  • get_job()
  • job_list()
  • job_list_id()
  • job_list_inactive()
• flux.job.output module
  • JobExceptionEvent
    • JobExceptionEvent.name
    • JobExceptionEvent.severity
    • JobExceptionEvent.exc_type
    • JobExceptionEvent.note
    • JobExceptionEvent.render()
  • JobOutput
    • JobOutput.stderr
    • JobOutput.log
    • JobOutput.log
    • JobOutput.stderr
    • JobOutput.stdout
  • JobOutputEventWatch
    • JobOutputEventWatch.get_event()
  • JobOutputWatch
    • JobOutputWatch.get_output()
  • JobOutputWatchLines
    • JobOutputWatchLines.getline()
  • LogEvent
    • LogEvent.name
    • LogEvent.rank
    • LogEvent.level
    • LogEvent.levelstr
    • LogEvent.message
    • LogEvent.component
    • LogEvent.file
    • LogEvent.line
    • LogEvent.dict
    • LogEvent.levelstr
    • LogEvent.log_level_string
    • LogEvent.render()
  • OutputEvent
    • OutputEvent.name
    • OutputEvent.rank
    • OutputEvent.stream
    • OutputEvent.eof
    • OutputEvent.data
    • OutputEvent.dict
    • OutputEvent.render()
  • OutputHeaderEvent
    • OutputHeaderEvent.name
    • OutputHeaderEvent.version
    • OutputHeaderEvent.stdout_count
    • OutputHeaderEvent.stderr_count
    • OutputHeaderEvent.stdout_encoding
    • OutputHeaderEvent.stderr_encoding
    • OutputHeaderEvent.event
  • RedirectEvent
    • RedirectEvent.name
    • RedirectEvent.stream
    • RedirectEvent.rank
    • RedirectEvent.path
    • RedirectEvent.dict
    • RedirectEvent.render()
  • Taskset
    • Taskset.all
    • Taskset.ids
    • Taskset.intersect()
  • job_output()
  • output_event_watch()
  • output_event_watch_async()
  • output_watch()
  • output_watch_async()
  • output_watch_lines()
  • output_watch_lines_async()
• flux.job.stats module
  • JobStats
    • JobStats.depend
    • JobStats.priority
    • JobStats.sched
    • JobStats.run
    • JobStats.cleanup
    • JobStats.inactive
    • JobStats.successful
    • JobStats.failed
    • JobStats.timeout
    • JobStats.canceled
    • JobStats.pending
    • JobStats.running
    • JobStats.active
    • JobStats.QueueStats
    • JobStats.derived_stats
    • JobStats.states
    • JobStats.stats
    • JobStats.update()
    • JobStats.update_sync()
• flux.job.submit module
  • SubmitFuture
    • SubmitFuture.get_id()
  • submit()
  • submit_async()
• flux.job.timeleft module
  • timeleft()
• flux.job.wait module
  • JobResultFuture
    • JobResultFuture.get_dict()
    • JobResultFuture.get_info()
  • JobWaitFuture
    • JobWaitFuture.get_status()
  • JobWaitResult
    • JobWaitResult.errstr
    • JobWaitResult.jobid
    • JobWaitResult.success
  • result()
  • result_async()
  • wait()
  • wait_async()
• flux.job.watcher module
  • JobProgressBar
    • JobProgressBar.jobs
    • JobProgressBar.starttime
    • JobProgressBar.total
    • JobProgressBar.pending
    • JobProgressBar.running
    • JobProgressBar.complete
    • JobProgressBar.failed
    • JobProgressBar.add_job()
    • JobProgressBar.add_jobs()
    • JobProgressBar.advance()
    • JobProgressBar.jobs_per_sec()
    • JobProgressBar.process_event()
    • JobProgressBar.start()
    • JobProgressBar.update()
  • JobStatus
    • JobStatus.id
    • JobStatus.status
    • JobStatus.exitcode
    • JobStatus.active
    • JobStatus.add_event()
    • JobStatus.event_count()
    • JobStatus.has_event()
  • JobWatcher
    • JobWatcher.JobWatchStatus
    • JobWatcher.add_jobid()
    • JobWatcher.add_jobs()
    • JobWatcher.start()
    • JobWatcher.stop()