SBVersionNumber#

This class describes a version number in SAMSON, composed of three non-negative integers:

  • a major version number

  • a minor version number

  • a patch version number

Because SAMSON Extensions depend on the version of the SDK with which they are developed, SAMSON has a strict versioning policy. Please refer to the section in the Developer Guide about Versioning for more information.

See also

SAMSON SDK: SBCContainerVersionNumber

class samson.SBVersionNumber(*args, **kwargs)#

Bases: pybind11_object

This class describes a version number in SAMSON, composed of three non-negative integers: - a major version number - a minor version number - a patch version number

Because SAMSON Extensions depend on the version of the SDK with which they are developed, SAMSON has a strict versioning policy. For more information, please refer to the SAMSON API Versioning.

Overloaded function.

  1. __init__(self: samson.SBVersionNumber) -> None

Constructs the 0.0.0 version number.

  1. __init__(self: samson.SBVersionNumber, major: int, minor: int, patch: int) -> None

Constructs a version number major.minor.patch.

Parameters:

  • major (int) – The major version number.

  • minor (int) – The minor version number.

  • patch (int) – The patch version number.

Examples

>>> print(SBVersionNumber(1, 2, 8))
1.2.8

  1. __init__(self: samson.SBVersionNumber, stringVersionNumber: str) -> None

Constructs a version number from a string that has the ‘MAJOR.MINOR.PATCH’ format.

Parameters:

stringVersionNumber (str) – A string representation of a version number.

Examples

>>> print(SBVersionNumber('1.2.0'))
1.2.0

  1. __init__(self: samson.SBVersionNumber, versionNumber: samson.SBVersionNumber) -> None

Copy constructor.

Parameters:

versionNumber (samson.SBVersionNumber) – Source version number.

__eq__(self: samson.SBVersionNumber, arg0: samson.SBVersionNumber) → bool#

Returns True when both versions are identical.

__ge__(self: samson.SBVersionNumber, arg0: samson.SBVersionNumber) → bool#

Semantic-version comparison (>=).

__gt__(self: samson.SBVersionNumber, arg0: samson.SBVersionNumber) → bool#

Semantic-version comparison (>).

__le__(self: samson.SBVersionNumber, arg0: samson.SBVersionNumber) → bool#

Semantic-version comparison (<=).

__lt__(self: samson.SBVersionNumber, arg0: samson.SBVersionNumber) → bool#

Semantic-version comparison (<).

__ne__(self: samson.SBVersionNumber, arg0: samson.SBVersionNumber) → bool#

Returns True when versions are different.

static getCompatibilityStatus(sdkVersionNumber: samson.SBVersionNumber, coreVersionNumber: samson.SBVersionNumber) → bool#

Returns whether sdkVersionNumber is compatible with coreVersionNumber.

For major version 0 (beta semantic versioning), compatibility requires same minor and sdk patch <= core patch. For major version > 0, compatibility requires same major and sdk minor <= core minor.

property isValid#

Returns True if at least one component is non-zero.

property major#

The major version number.

property minor#

The minor version number.

property patch#

The patch version number.