CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased on the 22.5.x branch

Added

• New Classes to interact with Database Associations (WIP)
  • pyslurm.db.Association
  • pyslurm.db.Associations
• New Classes to interact with Database QoS (WIP)
  • pyslurm.db.QualityOfService
  • pyslurm.db.QualitiesOfService

22.5.3 - 2023-07-19

Added

• Ability to modify Database Jobs
• New classes to interact with the Partition API
  • [pyslurm.Partition][]
  • [pyslurm.Partitions][]
• New attributes for a Database Job:
  • extra
  • failed_node
• Added a new Base Class [MultiClusterMap][pyslurm.xcollections.MultiClusterMap] that some Collections inherit from.
• Added to_json function to all Collections

Fixed

• Fixes a problem that prevented loading specific Jobs from the Database if the following two conditions were met:
  • no start/end time was specified
  • the Job was older than a day

Changed

• Improved Docs
• Renamed JobSearchFilter to [pyslurm.db.JobFilter][]
• Renamed as_dict function of some classes to to_dict

22.5.2 - 2023-05-21

Added

• Classes to interact with the Job and Submission API (PR #283 by tazend)
  • pyslurm.Job
  • pyslurm.Jobs
  • pyslurm.JobStep
  • pyslurm.JobSteps
  • pyslurm.JobSubmitDescription
• Classes to interact with the Database Job API (PR #283 by tazend)
  • pyslurm.db.Job
  • pyslurm.db.Jobs
  • pyslurm.db.JobStep
  • pyslurm.db.JobSearchFilter
• Classes to interact with the Node API (PR #283 by tazend)
  • pyslurm.Node
  • pyslurm.Nodes
• Exceptions added (PR #283 by tazend)
  • pyslurm.PyslurmError
  • pyslurm.RPCError
• Utility Functions

Changed

• Completely overhaul the documentation (PR #283 by tazend)
• Switch to mkdocs for generating documentation (PR #271 by tazend,multimeric)
• Rework the tests: Split them into unit and integration tests (PR #283 by tazend)

Deprecated

• Following classes are superseded by new ones:
  • pyslurm.job
  • pyslurm.node
  • pyslurm.jobstep
  • pyslurm.slurmdb_jobs

22.5.1 - 2023-02-26

Added

• wait_finished method to pyslurm.job class, which blocks until a specified job is finished (PR #242 by JonaOtto)
• Support updating end_time in slurm_update_reservation (PR #255 by pllopsis)

Changed

• Actually retrieve and return the batch script as a string, instead of just printing it (PR #258 by tazend)
• Raise ValueError on slurm_update_reservation instead of just returning the error code (PR #257 by pllopsis)

Fixed

• Fix some typos in pyslurm.job class (PR #243 by JonaOtto, PR #252 by schluenz)
• Fix not being able to create RPMs with bdist_rpm (PR #248 by tazend)
• Fix formatting error for reservation_list example (PR #256 by pllopsis)
• Fix RPC strings, bringing them in sync with slurm 22.05 when getting Slurm statistics via the statistics class (PR #261 by wresch)

22.5.0 - 2022-08-06

Added

• Support for Slurm 22.05.x (PR #238 by tazend)
• A pyproject.toml file to ease installation (PR #239 by tazend)
• Allow specifying Slurm lib-dir and include-dir via SLURM_LIB_DIR and SLURM_INCLUDE_DIR environment variables on install (PR #239 by tazend)

Changed

• Now actually link to libslurm.so instead of libslurmfull.so (PR #238 by tazend)

Removed

• stats key from the job-allocation dictionary itself when doing slurmdb_jobs.get() (PR #238 by tazend). Support for it was removed upstream here. Note that stats for job-steps are still accessible