Complete API Reference

Note that some of the items documented here may not be intended or designed for public use.

• flux package
  • Flux()
  • Subpackages
    • flux.abc package
      • JournalConsumerBase
      • JournalEventBase
      • Submodules
    • flux.cli package
      • Subpackages
      • Submodules
    • flux.constraint package
      • Submodules
    • flux.core package
      • Submodules
    • flux.job package
      • Subpackages
      • Submodules
    • flux.resource package
      • Submodules
    • flux.sdexec package
      • Submodules
    • flux.shape package
      • Submodules
    • flux.testing package
      • Submodules
    • flux.uri package
      • Submodules
  • Submodules
    • flux.brokermod module
      • BrokerLogger
      • BrokerModule
      • event_handler()
      • request_handler()
      • resolve_entry_point()
    • 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
      • EventLogFormatter
    • flux.future module
      • Future
      • FutureExt
      • WaitAllFuture
      • continuation_callback()
      • init_callback()
    • flux.hostlist module
      • Hostlist
      • HostlistIterator
      • decode()
    • flux.idset module
      • IDset
      • IDsetIterator
      • decode()
    • flux.importer module
      • import_path()
      • import_plugins()
      • import_plugins_pkg()
    • flux.kvs module
      • KVSDir
      • KVSTxn
      • KVSWatchFuture
      • KVSWrapper
      • WatchImplementation
      • commit()
      • commit_async()
      • exists()
      • get()
      • get_dir()
      • get_key_direct()
      • isdir()
      • join()
      • kvs_checkpoint_lookup()
      • 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
      • MessageWatcher
      • msg_typestr()
    • flux.modprobe module
      • Architecture
      • Usage Example
      • Configuration
      • CodeTask
      • ConfigLoader
      • Context
      • DependencySolver
      • Modprobe
      • Module
      • ModuleList
      • RankConditional
      • RankIDset
      • Task
      • TaskDB
      • default_flux_confdir()
      • rank_conditional()
      • run_all_rc_scripts()
      • task()
    • flux.proctitle module
      • set_proctitle()
    • flux.progress module
      • Bottombar
      • ElapsedTime
      • ProgressBar
    • flux.queue module
      • QueueDefaults
      • QueueInfo
      • QueueLimits
      • QueueList
      • QueueResourceCounts
      • QueueResources
    • flux.rpc module
      • RPC
    • flux.scheduler module
      • AllocRequest
      • PendingJob
      • ResourcePool
      • Scheduler
    • flux.security module
      • SecurityContext
      • SecurityFunctionWrapper
    • flux.slurm module
      • slurm_timeleft()
    • flux.subprocess module
      • Subprocess
      • SubprocessBackgroundRexecRPC
      • SubprocessListRPC
      • SubprocessWaitRPC
      • command_create()
      • kill()
      • list()
      • rexec_bg()
      • wait()
    • flux.util module
      • CLIMain
      • check_future_error()
      • encode_payload()
      • encode_topic()
      • parse_fsd()
    • flux.wrapper module
      • ErrorPrinter
      • FunctionWrapper
      • InvalidArguments
      • MissingFunctionError
      • Wrapper
      • WrapperBase
      • WrapperPimpl
      • WrongNumArguments