Python API

Version parsing and management utilities for Isaac Sim.

class Version

Bases: object

A data structure for storing parsed version information.

This class represents a structured version object that holds the different components of a version string after parsing. It provides separate attributes for major, minor, and patch version numbers, as well as prerelease and build metadata.

The version components are initially empty strings and are populated by parsing functions like parse_version(). This allows for easy access to individual version parts for comparison, display, or other version-related operations.

Version strings typically follow semantic versioning patterns like “1.2.3-alpha.1+build123”, which get broken down into their constituent parts and stored in the respective attributes of this class.

get_version() → tuple[str, str, str, str, str, str, str, str]

Retrieve version from the App VERSION file.

Returns:

Tuple containing core version, pre-release tag and build number, major version, minor version, patch version, pre-release tag, build number, and build tag.

parse_version(

full_version: str,

) → Version

Parse a version string into a version object.

Parameters:

full_version – Full version string read from a VERSION file

Returns:

Parsed version object