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
  • Subpackages
    • flux.cli.plugins package
      • Submodules
  • Submodules
    • flux.cli.alloc module
      • AllocCmd
    • flux.cli.base module
      • BatchAllocCmd
      • BeginTimeAction
      • ConfAction
      • EnvFileAction
      • EnvFilterAction
      • MiniCmd
      • SubmitBaseCmd
      • SubmitBulkCmd
      • Xcmd
    • flux.cli.batch module
      • BatchCmd
    • flux.cli.bulksubmit module
      • BulkSubmitCmd
    • flux.cli.fortune module
      • FortuneCmd
    • flux.cli.plugin module
      • CLIPlugin
      • CLIPluginOption
      • CLIPluginRegistry
      • PluginArgsProxy
    • flux.cli.run module
      • RunCmd
    • flux.cli.submit module
      • SubmitCmd
• flux.constraint package
  • Submodules
    • flux.constraint.parser module
      • ConstraintLexer
      • ConstraintParser
      • ConstraintSyntaxError
• 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
      • CheckWatcher
      • FDWatcher
      • IdleWatcher
      • 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_counts()
      • 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()
      • job_raise()
      • job_raise_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.ResourceCount module
      • ResourceCount
    • flux.resource.ResourcePool module
      • ResourcePool
    • flux.resource.ResourcePoolImplementation module
      • InfeasibleRequest
      • InsufficientResources
      • ResourcePoolImplementation
    • flux.resource.ResourceSet module
      • ResourceSet
    • flux.resource.ResourceSetImplementation module
      • ResourceSetImplementation
    • flux.resource.Rv1Pool module
      • ResourceRequest
      • Rv1Pool
    • flux.resource.Rv1Set module
      • Rv1Set
    • flux.resource.journal module
      • ResourceJournalConsumer
      • ResourceJournalEvent
    • flux.resource.list module
      • ResourceListRPC
      • SchedResourceList
      • resource_list()
    • flux.resource.status module
      • DrainInfo
      • ResourceStatus
      • ResourceStatusRPC
      • resource_status()
• flux.sdexec package
  • Submodules
    • flux.sdexec.map module
      • Overview
      • GPU Device Discovery
      • Extension
      • Configuration
      • HwlocMapper
      • ResourceMapper
      • main()
• flux.shape package
  • Submodules
    • flux.shape.parser module
      • ShapeLexer
      • ShapeParser
      • ShapeSyntaxError
• flux.testing package
  • Submodules
    • flux.testing.fake_resources module
      • FakeResources
      • InjectFakeResources
      • build_R_encode_args()
      • load_amender()
      • saturation_count()
• flux.uri package
  • Submodules
    • flux.uri.uri module
      • FluxURIResolver
      • JobURI
      • URI
      • URIResolverPlugin
      • URIResolverURI

Submodules

• flux.brokermod module
  • BrokerLogger
    • BrokerLogger.LEVEL_NAMES
    • BrokerLogger.alert()
    • BrokerLogger.critical()
    • BrokerLogger.debug()
    • BrokerLogger.emerg()
    • BrokerLogger.error()
    • BrokerLogger.info()
    • BrokerLogger.level
    • BrokerLogger.level_name
    • BrokerLogger.notice()
    • BrokerLogger.warning()
  • BrokerModule
    • BrokerModule.args
    • BrokerModule.debug_test()
    • BrokerModule.handle
    • BrokerModule.name
    • BrokerModule.run()
    • BrokerModule.set_running()
    • BrokerModule.stop()
    • BrokerModule.stop_error()
  • 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
    • 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_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
    • Message.InnerWrapper
    • Message.decode()
    • Message.from_event_encode()
    • Message.payload
    • Message.payload_str
    • Message.rolemask
    • Message.topic
    • Message.type
    • Message.type_str
    • Message.userid
  • MessageWatcher
    • MessageWatcher.destroy()
    • MessageWatcher.start()
    • MessageWatcher.stop()
  • msg_typestr()
• flux.modprobe module
  • Architecture
  • Usage Example
  • Configuration
  • CodeTask
    • CodeTask.dry_run()
    • CodeTask.run()
  • ConfigLoader
    • ConfigLoader.searchpath
    • ConfigLoader.print
    • ConfigLoader.build_searchpath()
    • ConfigLoader.get_rc_files()
    • ConfigLoader.get_toml_files()
  • Context
    • Context.verbose
    • Context.dry_run
    • Context.modprobe
    • Context.attr_get()
    • Context.bash()
    • Context.conf_get()
    • Context.enable()
    • Context.get()
    • Context.getenv()
    • Context.getopts()
    • Context.handle
    • Context.load_modules()
    • Context.print()
    • Context.rank
    • Context.remove_modules()
    • Context.rpc()
    • Context.set()
    • Context.set_alternative()
    • Context.setenv()
    • Context.setopt()
    • Context.tls
  • DependencySolver
    • DependencySolver.get_requires()
    • DependencySolver.get_reverse_requires()
    • DependencySolver.resolve_service()
    • DependencySolver.solve_execution_order()
    • DependencySolver.solve_needs()
    • DependencySolver.solve_removal()
    • DependencySolver.solve_requirements()
  • Modprobe
    • Modprobe.taskdb
    • Modprobe.context
    • Modprobe.solver
    • Modprobe.loader
    • Modprobe.handle
    • Modprobe.rank
    • Modprobe.exitcode
    • Modprobe.timing
    • Modprobe.activate_modules()
    • Modprobe.active_tasks
    • Modprobe.add_active_task()
    • Modprobe.add_modules()
    • Modprobe.add_task()
    • Modprobe.add_timing()
    • Modprobe.configure_modules()
    • Modprobe.disable()
    • Modprobe.get_deps()
    • Modprobe.get_requires()
    • Modprobe.get_task()
    • Modprobe.has_task()
    • Modprobe.load()
    • Modprobe.print()
    • Modprobe.read_rcfile()
    • Modprobe.remove()
    • Modprobe.resolve_service()
    • Modprobe.run()
    • Modprobe.save_task_timing()
    • Modprobe.set_alternative()
    • Modprobe.set_remove()
    • Modprobe.solve()
    • Modprobe.timestamp
    • Modprobe.update_module()
  • Module
    • Module.VALID_KEYS
    • Module.dry_run()
    • Module.set_remove()
    • Module.to_dict()
  • ModuleList
    • ModuleList.lookup()
  • RankConditional
    • RankConditional.test()
  • RankIDset
    • RankIDset.test()
  • Task
    • Task.VALID_ARGS
    • Task.dry_run()
    • Task.enabled()
    • Task.run()
    • Task.runtask()
  • TaskDB
    • TaskDB.TaskEntry
      • TaskDB.TaskEntry.index
      • TaskDB.TaskEntry.task
    • TaskDB.add()
    • TaskDB.disable()
    • TaskDB.enable()
    • TaskDB.get()
    • TaskDB.get_all()
    • TaskDB.get_entry()
    • TaskDB.has_enabled_provider()
    • TaskDB.set_alternative()
  • default_flux_confdir()
  • rank_conditional()
  • run_all_rc_scripts()
  • task()
• flux.proctitle module
  • set_proctitle()
• 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.scheduler module
  • AllocRequest
    • AllocRequest.jobid
    • AllocRequest.annotate()
    • AllocRequest.cancel()
    • AllocRequest.deny()
    • AllocRequest.jobid
    • AllocRequest.success()
  • PendingJob
    • PendingJob.jobid
    • PendingJob.priority
    • PendingJob.t_submit
    • PendingJob.request
    • PendingJob.resource_request
    • PendingJob.jobid
    • PendingJob.priority
    • PendingJob.request
    • PendingJob.resource_request
    • PendingJob.t_submit
  • ResourcePool
    • ResourcePool.InfeasibleRequest
    • ResourcePool.InsufficientResources
    • ResourcePool.alloc()
    • ResourcePool.check_feasibility()
    • ResourcePool.copy()
    • ResourcePool.copy_allocated()
    • ResourcePool.copy_down()
    • ResourcePool.dumps()
    • ResourcePool.expiration
    • ResourcePool.free()
    • ResourcePool.generation
    • ResourcePool.job_end_times()
    • ResourcePool.mark_down()
    • ResourcePool.mark_up()
    • ResourcePool.parse_resource_request()
    • ResourcePool.register_alloc()
    • ResourcePool.remove_ranks()
    • ResourcePool.set_expiration()
    • ResourcePool.set_starttime()
    • ResourcePool.to_dict()
    • ResourcePool.to_resource_set()
    • ResourcePool.update_expiration()
  • Scheduler
    • Scheduler.SCHED_DELAY_MAX
    • Scheduler.SCHED_EWMA_ALPHA
    • Scheduler.alloc()
    • Scheduler.alloc_annotate()
    • Scheduler.alloc_cancel()
    • Scheduler.alloc_deny()
    • Scheduler.alloc_success()
    • Scheduler.cancel()
    • Scheduler.expiration()
    • Scheduler.feasibility_check()
    • Scheduler.forecast()
    • Scheduler.free()
    • Scheduler.hello()
    • Scheduler.hello_partial_ok
    • Scheduler.pool_class
    • Scheduler.pool_kwargs
    • Scheduler.prioritize()
    • Scheduler.queue_depth
    • Scheduler.resource_update()
    • Scheduler.resources
    • Scheduler.run()
    • Scheduler.schedule()
    • Scheduler.start_schedule()
    • Scheduler.stats_get()
• flux.security module
  • SecurityContext
    • SecurityContext.InnerWrapper
      • SecurityContext.InnerWrapper.check_wrap()
    • SecurityContext.sign_unwrap()
    • SecurityContext.sign_wrap()
    • SecurityContext.sign_wrap_as()
  • SecurityFunctionWrapper
• flux.slurm module
  • slurm_timeleft()
• flux.subprocess module
  • Subprocess
    • Subprocess.cmd
    • Subprocess.label
    • Subprocess.pid
    • Subprocess.rank
    • Subprocess.state
  • SubprocessBackgroundRexecRPC
    • SubprocessBackgroundRexecRPC.get_pid()
    • SubprocessBackgroundRexecRPC.get_rank()
  • SubprocessListRPC
    • SubprocessListRPC.get_processes()
  • SubprocessWaitRPC
    • SubprocessWaitRPC.get_status()
  • 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
    • 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