v25.11.0

Added

• Support for Slurm 25.11.x
• Added new member metrics_type to pyslurm.slurmctld.Config
• The following new members have been added to the pyslurm.Job class:
  • submit_session_id
  • allocated_licenses
  • container_id
  • kill_step_when_oom
  • submit_line
  • extra
  • failed_node

Fixed

• Fixed an issue when parsing additional configs like cgroup.conf or mpi.conf when loading the slurm configuration with pyslurm.slurmctld.Config.load()

Changed

• Split up prolog_epilog_timeout in prolog_timeout and epilog_timeout in pyslurm.slurmctld.Config
• Renamed job_container_type to namespace_plugin in pyslurm.slurmctld.Config
• The uid_to_name and gid_to_name functions that are used in a few places now don't error by default if the user/group doesn't exist anymore.
  Now, if the user/group is gone already, the UID/GID is simply returned as a str.

Removed

• Removed member accounting_storage_user from pyslurm.slurmctld.Config

• Removed preempt_mode from deprecated class pyslurm.qos - class will be replaced soon.

• Removed deprecated functions from the old API:

  • pyslurm.slurm_signal_job_step - use send_signal() method on pyslurm.JobStep
  • pyslurm.slurm_complete_job
  • pyslurm.slurm_terminate_job_step
  • pyslurm.slurm_kill_job_step - use cancel() from pyslurm.JobStep
  • pyslurm.slurm_ping - use pyslurm.slurmctld.ping(), pyslurm.slurmctld.ping_all(), pyslurm.slurmctld.ping_primary() or pyslurm.slurmctld.ping_backup()
  • pyslurm.reconfigure - use pyslurm.slurmctld.reconfigure()
  • pyslurm.slurm_shutdown - use pyslurm.slurmctld.shutdown()
  • pyslurm.slurm_takeover - use pyslurm.slurmctld.takeover()
  • pyslurm.slurm_set_debug_level - use pyslurm.slurmctld.set_log_level()
  • pyslurm.slurm_set_debugflags - use pyslurm.slurmctld.add_debug_flags()
  • pyslurm.slurm_set_schedlog_level - use pyslurm.slurmctld.enable_scheduler_logging()
  • pyslurm.slurm_suspend - use suspend() method on pyslurm.Job
  • pyslurm.slurm_resume - use unsuspend() method on pyslurm.Job
  • pyslurm.slurm_requeue - use requeue() method on pyslurm.Job
  • pyslurm.slurm_signal_job - use send_signal() method on either pyslurm.Job or pyslurm.JobStep
  • pyslurm.slurm_kill_job - use send_signal() or cancel() method on either pyslurm.Job or pyslurm.JobStep
  • pyslurm.slurm_kill_job2
  • pyslurm.slurm_notify_job - use notify() method on pyslurm.Job
  • pyslurm.get_job_state_reason - access state_reason member on a pyslurm.Job instance (Job info must be loaded first)
  • pyslurm.get_job_state - access state member on a pyslurm.Job instance (Job info must be loaded first)
  • pyslurm.get_partition_state - access state member on a pyslurm.Partition instance (Partition info must be loaded first)
  • pyslurm.get_preempt_mode - run pyslurm.slurmctld.Config.load() and access preempt_mode member
  • pyslurm.get_node_state - access state member on a pyslurm.Node instance (Node info must be loaded first)
  • pyslurm.get_debug_flags - use pyslurm.slurmctld.get_debug_flags()
  • pyslurm.get_node_use - just returned the node state, which is redundant
  • pyslurm.get_last_slurm_error - use pyslurm.error.get_last_slurm_error()
  • pyslurm.mins2time_str - use pyslurm.utils.mins_to_timestr
  • pyslurm.secs2time_str - use pyslurm.utils.secs_to_timestr
  • pyslurm.get_private_data_list - run pyslurm.slurmctld.Config.load() and access private_data member

• Removed the following long deprecated old-api classes:

  • pyslurm.jobstep - use pyslurm.JobStep and pyslurm.JobSteps
  • pyslurm.statistics use pyslurm.slurmctld.diag() to get pyslurm.slurmctld.Statistics
  • pyslurm.job - use pyslurm.Job, pyslurm.Jobs and pyslurm.JobSubmitDescription
  • pyslurm.reservation - use pyslurm.Reservation and pyslurm.Reservations

  Reason for the removal: interfering with upgrades, and the fact that they haven't
  been maintained in years anyway and better documented replacement classes are available.
  Also speeds up compilation time.

v25.5.0

Added

• Support for Slurm 25.05.x

Changed

• Split up prolog_epilog_timeout in prolog_timeout and epilog_timeout in pyslurm.slurmctld.Config

Removed

• get_environment_timeout member in pyslurm.slurmctld.Config class

• The following long deprecated classes have been removed:

  • pyslurm.node (use pyslurm.Node instead)
  • pyslurm.config (use pyslurm.slurmctld.Config instead)
  • pyslurm.front_end (no replacement, functionality has been removed from Slurm)
  • pyslurm.partition (use pyslurm.Partition instead)
  • pyslurm.topology (no replacement, this was heavily reworked in 25.05 and needs separate followup)

  Reason for the removal: interfering with the 25.05 upgrade, they haven't
  been maintained in years anyway and better documented replacement classes are available.

v23.2.3

https://pyslurm.github.io/23.2/changelog/

Added

• Add truncate_time option to pyslurm.db.JobFilter, which is the same as -T /
  --truncate from sacct.
• Add new Attributes to pyslurm.db.Jobs that help gathering statistics for a
  collection of Jobs more convenient.
• Add new idle_memory and allocated_tres attributes to pyslurm.Node class
• Added stats attribute to both pyslurm.Job, pyslurm.Jobs and
  pyslurm.db.Jobs
• Added pids attribute to pyslurm.Job which contains Process-IDs of the Job
  organized by node-name
• Added load_stats method to pyslurm.Job and pyslurm.Jobs classes.
  Together with the stats and pids attributes mentioned above, it is now
  possible to fetch live statistics (like sstat)
• Switch to link with libslurmfull.so instead of libslurm.so
  
  This change really has no impact from a user perspective. Everything will
  keep working the same, except that Slurms more internal library
  libslurmfull.so is linked with (which is located alongside the plugins
  inside the slurm directory, which itself is next to libslurm.so)
  
  Why the change? Because it will likely make development easier. It allows
  access to more functions that might be needed in some places, without
  completely having to implement them on our own. Implementing the
  live-statistics feature, so basically sstat, is for example not possible
  with libslurm.so
  
  You can keep providing the directory where libslurm.so resided as
  $SLURM_LIB_DIR to pyslurm, and it will automatically find libslurmfull.so
  from there.
• Added run_time_remaining and elapsed_cpu_time attributes to pyslurm.JobStep
• Added run_time_remaining attribute to pyslurm.Job

Fixed

• Fix allocated_gres attribute in the pyslurm.Node Class returning nothing.
• Fix Node State being displayed as ALLOCATED when it should actually be
  MIXED.
• Fix crash for the gres_per_node attribute of the pyslurm.Job class when
  the GRES String received from Slurm contains no count.
• Fixed total_cpu_time, system_cpu_time and user_cpu_time not getting
  calculated correctly for Job statistics
• Actually make sure that avg_cpu_time, min_cpu_time, total_cpu_time,
  system_cpu_time and user_cpu_time are integers, not float.

Changed

• Breaking: rename cpu_time to elapsed_cpu_time in pyslurm.Job and
  pyslurm.Jobs classes
• Breaking: rename attribute alloc_cpus to just cpus in pyslurm.JobStep
• Breaking: removed the following attributes from pyslurm.db.Jobs:
  
  • consumed_energy
  • disk_read
  • disk_write
  • page_faults
  • resident_memory
  • virtual_memory
  • elapsed_cpu_time
  • total_cpu_time
  • user_cpu_time
  • system_cpu_time
• The removed attributes above are now all available within the stats
  attribute, which is of type pyslurm.db.JobStatistics
• Renamed the original class of pyslurm.db.JobStatistics to
  pyslurm.db.JobStepStatistics.
  
  All this class contains is really mostly applicable only to Steps, but
  doesn't fully apply at the Job Level.
  
  Therefore, the new pyslurm.db.JobStatistics class only contains all
  statistics that make sense at the Job-level.
• return 1 as a value for the cpus attribute in pyslurm.db.Job when there
  is no value set from Slurm's side.

Removed

• Removed pyslurm.version() function. Should use __version__ attribute directly.
• Removed --slurm-lib and --slurm-inc parameters to setup.py.
  
  SLURM_LIB_DIR and SLURM_INCLUDE_DIR environment variables should be used instead.

v24.11.0

Added

• Support for Slurm 24.11.x

v23.11.1

Added

• Added stats attribute to both pyslurm.Job, pyslurm.Jobs and
  pyslurm.db.Jobs
• Added pids attribute to pyslurm.Job which contains Process-IDs of the Job
  organized by node-name
• Added load_stats method to pyslurm.Job and pyslurm.Jobs classes.
  Together with the stats and pids attributes mentioned above, it is now
  possible to fetch live statistics (like sstat)
• Switch to link with libslurmfull.so instead of libslurm.so
  
  This change really has no impact from a user perspective. Everything will
  keep working the same, except that Slurms more internal library
  libslurmfull.so is linked with (which is located alongside the plugins
  inside the slurm directory, which itself is next to libslurm.so)
  
  Why the change? Because it will likely make development easier. It allows
  access to more functions that might be needed in some places, without
  completely having to implement them on our own. Implementing the
  live-statistics feature, so basically sstat, is for example not possible
  with libslurm.so
  
  You can keep providing the directory where libslurm.so resided as
  $SLURM_LIB_DIR to pyslurm, and it will automatically find libslurmfull.so
  from there.
• Added run_time_remaining and elapsed_cpu_time attributes to pyslurm.JobStep
• Added run_time_remaining attribute to pyslurm.Job

Fixed

• Fixed total_cpu_time, system_cpu_time and user_cpu_time not getting
  calculated correctly for Job statistics
• Actually make sure that avg_cpu_time, min_cpu_time, total_cpu_time,
  system_cpu_time and user_cpu_time are integers, not float.

Changed

• Breaking: rename cpu_time to elapsed_cpu_time in pyslurm.Job and
  pyslurm.Jobs classes
• Breaking: rename attribute alloc_cpus to just cpus in pyslurm.JobStep
• Breaking: removed the following attributes from pyslurm.db.Jobs:
  
  • consumed_energy
  • disk_read
  • disk_write
  • page_faults
  • resident_memory
  • virtual_memory
  • elapsed_cpu_time
  • total_cpu_time
  • user_cpu_time
  • system_cpu_time
• The removed attributes above are now all available within the stats
  attribute, which is of type pyslurm.db.JobStatistics
• Renamed the original class of pyslurm.db.JobStatistics to
  pyslurm.db.JobStepStatistics.
  
  All this class contains is really mostly applicable only to Steps, but
  doesn't fully apply at the Job Level.
  
  Therefore, the new pyslurm.db.JobStatistics class only contains all
  statistics that make sense at the Job-level.
• return 1 as a value for the cpus attribute in pyslurm.db.Job when there
  is no value set from Slurm's side.

Removed

• Removed pyslurm.version() function. Should use __version__ attribute directly.
• Removed --slurm-lib and --slurm-inc parameters to setup.py.
  
  SLURM_LIB_DIR and SLURM_INCLUDE_DIR environment variables should be used instead.

v24.5.1

Added

• Added stats attribute to both pyslurm.Job, pyslurm.Jobs and
  pyslurm.db.Jobs
• Added pids attribute to pyslurm.Job which contains Process-IDs of the Job
  organized by node-name
• Added load_stats method to pyslurm.Job and pyslurm.Jobs classes.
  Together with the stats and pids attributes mentioned above, it is now
  possible to fetch live statistics (like sstat)
• Switch to link with libslurmfull.so instead of libslurm.so
  
  This change really has no impact from a user perspective. Everything will
  keep working the same, except that Slurms more internal library
  libslurmfull.so is linked with (which is located alongside the plugins
  inside the slurm directory, which itself is next to libslurm.so)
  
  Why the change? Because it will likely make development easier. It allows
  access to more functions that might be needed in some places, without
  completely having to implement them on our own. Implementing the
  live-statistics feature, so basically sstat, is for example not possible
  with libslurm.so
  
  You can keep providing the directory where libslurm.so resided as
  $SLURM_LIB_DIR to pyslurm, and it will automatically find libslurmfull.so
  from there.
• Added run_time_remaining and elapsed_cpu_time attributes to pyslurm.JobStep
• Added run_time_remaining attribute to pyslurm.Job

Fixed

• Fixed total_cpu_time, system_cpu_time and user_cpu_time not getting
  calculated correctly for Job statistics
• Actually make sure that avg_cpu_time, min_cpu_time, total_cpu_time,
  system_cpu_time and user_cpu_time are integers, not float.

Changed

• Breaking: rename cpu_time to elapsed_cpu_time in pyslurm.Job and
  pyslurm.Jobs classes
• Breaking: rename attribute alloc_cpus to just cpus in pyslurm.JobStep
• Breaking: removed the following attributes from pyslurm.db.Jobs:
  
  • consumed_energy
  • disk_read
  • disk_write
  • page_faults
  • resident_memory
  • virtual_memory
  • elapsed_cpu_time
  • total_cpu_time
  • user_cpu_time
  • system_cpu_time
• The removed attributes above are now all available within the stats
  attribute, which is of type pyslurm.db.JobStatistics
• Renamed the original class of pyslurm.db.JobStatistics to
  pyslurm.db.JobStepStatistics.
  
  All this class contains is really mostly applicable only to Steps, but
  doesn't fully apply at the Job Level.
  
  Therefore, the new pyslurm.db.JobStatistics class only contains all
  statistics that make sense at the Job-level.
• return 1 as a value for the cpus attribute in pyslurm.db.Job when there
  is no value set from Slurm's side.

Removed

• Removed pyslurm.version() function. Should use __version__ attribute directly.
• Removed --slurm-lib and --slurm-inc parameters to setup.py.
  SLURM_LIB_DIR and SLURM_INCLUDE_DIR environment variables should be used instead.

v24.5.0

Added

• Support for Slurm 24.5.x
• add power_down_on_idle attribute to pyslurm.Partition class

Changed

• bump minimum Cython version to 0.29.37

Removed

• Removed power_options from JobSubmitDescription

v23.11.0

Added

• Support for Slurm 23.11.x
• Add truncate_time option to pyslurm.db.JobFilter, which is the same as -T /
  --truncate from sacct.
• Add new attributes to pyslurm.db.Jobs that help gathering statistics for a
  collection of Jobs more convenient.
• Add new attribute gres_tasks_per_sharing to pyslurm.Job and
  pyslurm.JobSubmitDescription

Fixed

• Fix allocated_gres attribute in the pyslurm.Node Class returning nothing.
• Add new idle_memory and allocated_tres attributes to pyslurm.Node class
• Fix Node State being displayed as ALLOCATED when it should actually be
  MIXED.
• Fix crash for the gres_per_node attribute of the pyslurm.Job class when
  the GRES String received from Slurm contains no count.

Removed

• route_plugin, job_credential_private_key and job_credential_public_certificate
  keys are removed from the output of pyslurm.config().get()
• Some deprecated and unused Slurm constants

v22.5.3

Check here for the full Changelog

v21.8.1

Check here for the full Changelog