flux package

python bindings to flux-core, the main core of the flux resource manager

flux.Flux(*args, **kwargs)

Subpackages

• flux.abc package
  • JournalConsumerBase
    • JournalConsumerBase.SENTINEL_EVENT
    • JournalConsumerBase.create_event()
    • JournalConsumerBase.is_empty_response()
    • JournalConsumerBase.poll()
    • JournalConsumerBase.process_response()
    • JournalConsumerBase.request_payload
    • JournalConsumerBase.set_callback()
    • JournalConsumerBase.start()
    • JournalConsumerBase.stop()
  • JournalEventBase
    • JournalEventBase.name
    • JournalEventBase.timestamp
    • JournalEventBase.context
    • JournalEventBase.context_string
    • JournalEventBase.is_empty()
  • Submodules
    • flux.abc.journal module
      • JournalConsumerBase
      • JournalEventBase
• flux.cli package
  • Submodules
    • flux.cli.alloc module
    • flux.cli.base module
    • flux.cli.batch module
    • flux.cli.bulksubmit module
    • flux.cli.fortune module
    • flux.cli.run module
    • flux.cli.submit module
• flux.constraint package
  • Submodules
    • flux.constraint.parser module
• flux.core package
  • Submodules
    • flux.core.handle module
      • Flux
    • flux.core.inner module
      • Core
    • flux.core.trampoline module
      • mod_main_trampoline()
    • flux.core.watchers module
      • FDWatcher
      • SignalWatcher
      • TimerWatcher
• flux.job package
  • Subpackages
    • flux.job.frobnicator package
      • Submodules
    • flux.job.validator package
      • Submodules
  • Submodules
    • flux.job.JobID module
      • JobID
      • id_encode()
      • id_parse()
    • flux.job.Jobspec module
      • Jobspec
      • JobspecV1
      • validate_jobspec()
    • flux.job.directives module
      • Directive
      • DirectiveParser
      • MultiLine
    • flux.job.event module
      • JobEventWatchFuture
      • JobException
      • event_wait()
      • event_watch()
      • event_watch_async()
    • flux.job.executor module
      • FluxExecutor
      • FluxExecutorFuture
    • flux.job.info module
      • AnnotationsInfo
      • DependencyList
      • EmptyObject
      • ExceptionInfo
      • InfoList
      • InstanceInfo
      • JobInfo
      • JobInfoFormat
      • StatsInfo
      • get_username()
      • job_fields_to_attrs()
      • resulttoemoji()
      • resulttostr()
      • statetoemoji()
      • statetostr()
      • statustoemoji()
      • statustostr()
    • flux.job.journal module
      • JournalConsumer
      • JournalEvent
      • SENTINEL_EVENT
    • flux.job.kill module
      • cancel()
      • cancel_async()
      • kill()
      • kill_async()
    • flux.job.kvs module
      • job_kvs()
      • job_kvs_guest()
    • flux.job.kvslookup module
      • JobInfoLookupRPC
      • JobKVSLookup
      • JobKVSLookupFuture
      • decode_special_data()
      • job_info_lookup()
      • job_kvs_lookup()
    • flux.job.list module
      • JobList
      • JobListIdRPC
      • JobListIdsFuture
      • JobListRPC
      • get_job()
      • job_list()
      • job_list_id()
      • job_list_inactive()
    • flux.job.output module
      • JobExceptionEvent
      • JobOutput
      • JobOutputEventWatch
      • JobOutputWatch
      • JobOutputWatchLines
      • LogEvent
      • OutputEvent
      • OutputHeaderEvent
      • RedirectEvent
      • Taskset
      • 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
    • flux.job.submit module
      • SubmitFuture
      • submit()
      • submit_async()
    • flux.job.timeleft module
      • timeleft()
    • flux.job.wait module
      • JobResultFuture
      • JobWaitFuture
      • JobWaitResult
      • result()
      • result_async()
      • wait()
      • wait_async()
    • flux.job.watcher module
      • JobProgressBar
      • JobStatus
      • JobWatcher
• flux.resource package
  • Submodules
    • flux.resource.ResourceSet module
      • ResourceSet
    • flux.resource.ResourceSetImplementation module
      • ResourceSetImplementation
    • flux.resource.Rlist module
      • Rlist
    • flux.resource.journal module
      • ResourceJournalConsumer
      • ResourceJournalEvent
    • flux.resource.list module
      • ResourceListRPC
      • SchedResourceList
      • resource_list()
    • flux.resource.status module
      • DrainInfo
      • ResourceStatus
      • ResourceStatusRPC
      • resource_status()
• flux.uri package
  • Submodules
    • flux.uri.uri module
      • FluxURIResolver
      • JobURI
      • URI
      • URIResolverPlugin
      • URIResolverURI

Submodules

• flux.compat36 module
  • strsignal()
• flux.conf_builtin module
  • conf_builtin_get()
• flux.constants module
• flux.debugged module
  • get_mpir_being_debugged()
  • set_mpir_being_debugged()
• flux.eventlog module
  • EventLogEvent
    • EventLogEvent.context
    • EventLogEvent.context_string
    • EventLogEvent.name
    • EventLogEvent.timestamp
  • EventLogFormatter
    • EventLogFormatter.BLUE
    • EventLogFormatter.BOLD
    • EventLogFormatter.GRAY
    • EventLogFormatter.GREEN
    • EventLogFormatter.MAGENTA
    • EventLogFormatter.RED
    • EventLogFormatter.YELLOW
    • EventLogFormatter.eventlog_colors
    • EventLogFormatter.format()
• flux.future module
  • Future
    • Future.InnerWrapper
      • Future.InnerWrapper.check_wrap()
    • Future.error_string()
    • Future.fulfill_error()
    • Future.get()
    • Future.get_flux()
    • Future.get_reactor()
    • Future.incref()
    • Future.is_ready()
    • Future.raise_if_handle_exception()
    • Future.reset()
    • Future.set_flux()
    • Future.stop()
    • Future.then()
    • Future.wait_for()
  • FutureExt
    • FutureExt.fulfill()
    • FutureExt.get()
  • WaitAllFuture
    • WaitAllFuture.push()
  • continuation_callback()
  • init_callback()
• flux.hostlist module
  • Hostlist
    • Hostlist.InnerWrapper
    • Hostlist.append()
    • Hostlist.copy()
    • Hostlist.count()
    • Hostlist.delete()
    • Hostlist.encode()
    • Hostlist.expand()
    • Hostlist.find()
    • Hostlist.index()
    • Hostlist.sort()
    • Hostlist.uniq()
  • HostlistIterator
  • decode()
• flux.idset module
  • IDset
    • IDset.InnerWrapper
    • IDset.add()
    • IDset.clear()
    • IDset.copy()
    • IDset.count()
    • IDset.difference()
    • IDset.encode()
    • IDset.equal()
    • IDset.expand()
    • IDset.first()
    • IDset.intersect()
    • IDset.last()
    • IDset.next()
    • IDset.set()
    • IDset.set_flags()
    • IDset.subtract()
    • IDset.test()
    • IDset.union()
  • IDsetIterator
  • decode()
• flux.importer module
  • import_path()
  • import_plugins()
  • import_plugins_pkg()
• flux.kvs module
  • KVSDir
    • KVSDir.InnerWrapper
    • KVSDir.KVSDirIterator
      • KVSDir.KVSDirIterator.next()
    • KVSDir.commit()
    • KVSDir.commit_async()
    • KVSDir.directories()
    • KVSDir.exists()
    • KVSDir.files()
    • KVSDir.fill()
    • KVSDir.key_at()
    • KVSDir.list_all()
    • KVSDir.mkdir()
  • KVSTxn
    • KVSTxn.clear()
    • KVSTxn.commit()
    • KVSTxn.commit_async()
    • KVSTxn.mkdir()
    • KVSTxn.put()
    • KVSTxn.symlink()
    • KVSTxn.unlink()
  • KVSWatchFuture
    • KVSWatchFuture.watch_cancel()
    • KVSWatchFuture.watch_get()
  • KVSWrapper
    • KVSWrapper.flux_kvsitr_next()
  • WatchImplementation
    • WatchImplementation.cancel()
    • WatchImplementation.get()
    • WatchImplementation.watch_cancel()
    • WatchImplementation.watch_get()
  • commit()
  • commit_async()
  • exists()
  • get()
  • get_dir()
  • get_key_direct()
  • isdir()
  • join()
  • kvs_watch_async()
  • namespace_create()
  • namespace_list()
  • namespace_remove()
  • put()
  • put_mkdir()
  • put_symlink()
  • put_unlink()
  • walk()
• flux.memoized_property module
  • memoized_property()
• flux.message module
  • Message
    • Message.InnerWrapper
    • Message.decode()
    • Message.from_event_encode()
    • Message.payload
    • Message.payload_str
    • Message.topic
    • Message.type
    • Message.type_str
  • MessageWatcher
    • MessageWatcher.destroy()
    • MessageWatcher.start()
    • MessageWatcher.stop()
  • msg_typestr()
• flux.progress module
  • Bottombar
    • Bottombar.elapsed
    • Bottombar.redraw()
    • Bottombar.start()
    • Bottombar.stop()
    • Bottombar.update()
  • ElapsedTime
    • ElapsedTime.dt
  • ProgressBar
    • ProgressBar.bar_style
    • ProgressBar.update()
• flux.queue module
  • QueueDefaults
    • QueueDefaults.duration
    • QueueDefaults.timelimit
    • QueueDefaults.duration
    • QueueDefaults.timelimit
  • QueueInfo
  • QueueLimits
    • QueueLimits.min
    • QueueLimits.max
    • QueueLimits.duration
    • QueueLimits.timelimit
    • QueueLimits.duration
    • QueueLimits.max
    • QueueLimits.min
    • QueueLimits.timelimit
  • QueueList
  • QueueResourceCounts
    • QueueResourceCounts.nnodes
    • QueueResourceCounts.ncores
    • QueueResourceCounts.ngpus
    • QueueResourceCounts.ncores
    • QueueResourceCounts.ngpus
    • QueueResourceCounts.nnodes
  • QueueResources
• flux.rpc module
  • RPC
    • RPC.RPCInnerWrapper
      • RPC.RPCInnerWrapper.check_wrap()
    • RPC.get()
    • RPC.get_str()
• flux.security module
  • SecurityContext
    • SecurityContext.InnerWrapper
      • SecurityContext.InnerWrapper.check_wrap()
    • SecurityContext.sign_unwrap()
    • SecurityContext.sign_wrap()
    • SecurityContext.sign_wrap_as()
  • SecurityFunctionWrapper
• flux.util module
  • CLIMain
  • check_future_error()
  • encode_payload()
  • encode_topic()
  • parse_fsd()
• flux.wrapper module
  • ErrorPrinter
  • FunctionWrapper
    • FunctionWrapper.build_argument_translation_list()
    • FunctionWrapper.set_error_check()
  • InvalidArguments
  • MissingFunctionError
  • Wrapper
    • Wrapper.check_handle()
    • Wrapper.check_wrap()
    • Wrapper.handle
  • WrapperBase
    • WrapperBase.handle
  • WrapperPimpl
    • WrapperPimpl.handle
  • WrongNumArguments