ioformat.ioformat.Versioning Class Reference

Inheritance diagram for ioformat.ioformat.Versioning:

Public Member Functions
	__init__ (self)

Static Public Member Functions
	version ()
	version_string ()
	sha ()
	check_compatibility (*args)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Versioning tool to check library infos.

Member Function Documentation

check_compatibility()

ioformat.ioformat.Versioning.check_compatibility ( *  args )

static

    *Overload 1:*

    Checks if the version of the loaded library is compatible with the one given in argument.

    A version is compatible if:
     - The major version is the same
     - The library minor version is greater than the given one.

    :type version: :py:class:`VersionInfo`
    :param version: The version to check compatibility for.

    |

    *Overload 2:*

    Check if the loaded library is compatible with the one defined in the header.

sha()

ioformat.ioformat.Versioning.sha ( )

static

Return the SHA of the commit used to build this version of IOFormat.

version()

ioformat.ioformat.Versioning.version ( )

static

Return the version of the currently loaded IOFormat library.

version_string()

ioformat.ioformat.Versioning.version_string ( )

static

Return a description string of the currently loaded IOFormat library.

---

The documentation for this class was generated from the following file:

• Release/python/ioformat/ioformat.py