idmtools_calibra.utilities.distro module#

The distro package (distro stands for Linux Distribution) provides information about the Linux distribution it runs on, such as a reliable machine-readable distro ID, or version information.

It is the recommended replacement for Python’s original platform.linux_distribution() function, but it provides much more functionality. An alternative implementation became necessary because Python 3.5 deprecated this function, and Python 3.8 will remove it altogether. Its predecessor function platform.dist() was already deprecated since Python 2.6 and will also be removed in Python 3.8. Still, there are many cases in which access to OS distribution information is needed. See Python issue 1322 for more information.

idmtools_calibra.utilities.distro.NORMALIZED_OS_ID = {}#

Translation table for normalizing the “ID” attribute defined in os-release files, for use by the distro.id() method.

Key: Value as defined in the os-release file, translated to lower case, with blanks translated to underscores.
Value: Normalized value.

idmtools_calibra.utilities.distro.NORMALIZED_LSB_ID = {'enterpriseenterprise': 'oracle', 'redhatenterpriseserver': 'rhel', 'redhatenterpriseworkstation': 'rhel'}#

Translation table for normalizing the “Distributor ID” attribute returned by the lsb_release command, for use by the distro.id() method.

Key: Value as returned by the lsb_release command, translated to lower case, with blanks translated to underscores.
Value: Normalized value.

idmtools_calibra.utilities.distro.NORMALIZED_DISTRO_ID = {'redhat': 'rhel'}#

Translation table for normalizing the distro ID derived from the file name of distro release files, for use by the distro.id() method.

Key: Value as derived from the file name of a distro release file, translated to lower case, with blanks translated to underscores.
Value: Normalized value.

idmtools_calibra.utilities.distro.linux_distribution(full_distribution_name=True)[source]#

Return information about the current OS distribution as a tuple (id_name, version, codename) with items as follows:

id_name: If full_distribution_name is false, the result of distro.id(). Otherwise, the result of distro.name().
version: The result of distro.version().
codename: The result of distro.codename().

The interface of this function is compatible with the original platform.linux_distribution() function, supporting a subset of its parameters.

The data it returns may not exactly be the same, because it uses more data sources than the original function, and that may lead to different data if the OS distribution is not consistent across multiple data sources it provides (there are indeed such distributions …).

Another reason for differences is the fact that the distro.id() method normalizes the distro ID string to a reliable machine-readable value for a number of popular OS distributions.

idmtools_calibra.utilities.distro.id()[source]#

Return the distro ID of the current distribution, as a machine-readable string.

For a number of OS distributions, the returned distro ID value is reliable, in the sense that it is documented and that it does not change across releases of the distribution.

This package maintains the following reliable distro ID values:

Distro ID	Distribution
“ubuntu”	Ubuntu
“debian”	Debian
“rhel”	RedHat Enterprise Linux
“centos”	CentOS
“fedora”	Fedora
“sles”	SUSE Linux Enterprise Server
“opensuse”	openSUSE
“amazon”	Amazon Linux
“arch”	Arch Linux
“cloudlinux”	CloudLinux OS
“exherbo”	Exherbo Linux
“gentoo”	GenToo Linux
“ibm_powerkvm”	IBM PowerKVM
“kvmibm”	KVM for IBM z Systems
“linuxmint”	Linux Mint
“mageia”	Mageia
“mandriva”	Mandriva Linux
“parallels”	Parallels
“pidora”	Pidora
“raspbian”	Raspbian
“oracle”	Oracle Linux (and Oracle Enterprise Linux)
“scientific”	Scientific Linux
“slackware”	Slackware
“xenserver”	XenServer
“openbsd”	OpenBSD
“netbsd”	NetBSD
“freebsd”	FreeBSD

If you have a need to get distros for reliable IDs added into this set, or if you find that the distro.id() function returns a different distro ID for one of the listed distros, please create an issue in the distro issue tracker.

Lookup hierarchy and transformations:

First, the ID is obtained from the following sources, in the specified order. The first available and non-empty value is used:

the value of the “ID” attribute of the os-release file,
the value of the “Distributor ID” attribute returned by the lsb_release command,
the first part of the file name of the distro release file,

The so determined ID value then passes the following transformations, before it is returned by this method:

it is translated to lower case,
blanks (which should not be there anyway) are translated to underscores,
a normalization of the ID is performed, based upon normalization tables. The purpose of this normalization is to ensure that the ID is as reliable as possible, even across incompatible changes in the OS distributions. A common reason for an incompatible change is the addition of an os-release file, or the addition of the lsb_release command, with ID values that differ from what was previously determined from the distro release file name.

idmtools_calibra.utilities.distro.name(pretty=False)[source]#

Return the name of the current OS distribution, as a human-readable string.

If pretty is false, the name is returned without version or codename. (e.g. “CentOS Linux”)

If pretty is true, the version and codename are appended. (e.g. “CentOS Linux 7.1.1503 (Core)”)

Lookup hierarchy:

The name is obtained from the following sources, in the specified order. The first available and non-empty value is used:

If pretty is false:
- the value of the “NAME” attribute of the os-release file,
- the value of the “Distributor ID” attribute returned by the lsb_release command,
- the value of the “<name>” field of the distro release file.
If pretty is true:
- the value of the “PRETTY_NAME” attribute of the os-release file,
- the value of the “Description” attribute returned by the lsb_release command,
- the value of the “<name>” field of the distro release file, appended with the value of the pretty version (“<version_id>” and “<codename>” fields) of the distro release file, if available.

idmtools_calibra.utilities.distro.version(pretty=False, best=False)[source]#

Return the version of the current OS distribution, as a human-readable string.

If pretty is false, the version is returned without codename (e.g. “7.0”).

If pretty is true, the codename in parenthesis is appended, if the codename is non-empty (e.g. “7.0 (Maipo)”).

Some distributions provide version numbers with different precisions in the different sources of distribution information. Examining the different sources in a fixed priority order does not always yield the most precise version (e.g. for Debian 8.2, or CentOS 7.1).

The best parameter can be used to control the approach for the returned version:

If best is false, the first non-empty version number in priority order of the examined sources is returned.

If best is true, the most precise version number out of all examined sources is returned.

Lookup hierarchy:

In all cases, the version number is obtained from the following sources. If best is false, this order represents the priority order:

the value of the “VERSION_ID” attribute of the os-release file,
the value of the “Release” attribute returned by the lsb_release command,
the version number parsed from the “<version_id>” field of the first line of the distro release file,
the version number parsed from the “PRETTY_NAME” attribute of the os-release file, if it follows the format of the distro release files.
the version number parsed from the “Description” attribute returned by the lsb_release command, if it follows the format of the distro release files.

idmtools_calibra.utilities.distro.version_parts(best=False)[source]#

Return the version of the current OS distribution as a tuple (major, minor, build_number) with items as follows:

major: The result of distro.major_version().
minor: The result of distro.minor_version().
build_number: The result of distro.build_number().

For a description of the best parameter, see the distro.version() method.

idmtools_calibra.utilities.distro.major_version(best=False)[source]#

Return the major version of the current OS distribution, as a string, if provided. Otherwise, the empty string is returned. The major version is the first part of the dot-separated version string.

For a description of the best parameter, see the distro.version() method.

idmtools_calibra.utilities.distro.minor_version(best=False)[source]#

Return the minor version of the current OS distribution, as a string, if provided. Otherwise, the empty string is returned. The minor version is the second part of the dot-separated version string.

For a description of the best parameter, see the distro.version() method.

idmtools_calibra.utilities.distro.build_number(best=False)[source]#

Return the build number of the current OS distribution, as a string, if provided. Otherwise, the empty string is returned. The build number is the third part of the dot-separated version string.

For a description of the best parameter, see the distro.version() method.

idmtools_calibra.utilities.distro.like()[source]#

Return a space-separated list of distro IDs of distributions that are closely related to the current OS distribution in regards to packaging and programming interfaces, for example distributions the current distribution is a derivative from.

Lookup hierarchy:

This information item is only provided by the os-release file. For details, see the description of the “ID_LIKE” attribute in the os-release man page.

idmtools_calibra.utilities.distro.codename()[source]#

Return the codename for the release of the current OS distribution, as a string.

If the distribution does not have a codename, an empty string is returned.

Note that the returned codename is not always really a codename. For example, openSUSE returns “x86_64”. This function does not handle such cases in any special way and just returns the string it finds, if any.

Lookup hierarchy:

the codename within the “VERSION” attribute of the os-release file, if provided,
the value of the “Codename” attribute returned by the lsb_release command,
the value of the “<codename>” field of the distro release file.

idmtools_calibra.utilities.distro.info(pretty=False, best=False)[source]#

Return certain machine-readable information items about the current OS distribution in a dictionary, as shown in the following example:

{
    'id': 'rhel',
    'version': '7.0',
    'version_parts': {
        'major': '7',
        'minor': '0',
        'build_number': ''
    },
    'like': 'fedora',
    'codename': 'Maipo'
}

The dictionary structure and keys are always the same, regardless of which information items are available in the underlying data sources. The values for the various keys are as follows:

id: The result of distro.id().
version: The result of distro.version().
version_parts -> major: The result of distro.major_version().
version_parts -> minor: The result of distro.minor_version().
version_parts -> build_number: The result of distro.build_number().
like: The result of distro.like().
codename: The result of distro.codename().

For a description of the pretty and best parameters, see the distro.version() method.

idmtools_calibra.utilities.distro.os_release_info()[source]#

Return a dictionary containing key-value pairs for the information items from the os-release file data source of the current OS distribution.

See os-release file for details about these information items.

idmtools_calibra.utilities.distro.lsb_release_info()[source]#

Return a dictionary containing key-value pairs for the information items from the lsb_release command data source of the current OS distribution.

See lsb-release command output for details about these information items.

idmtools_calibra.utilities.distro.distro_release_info()[source]#

Return a dictionary containing key-value pairs for the information items from the distro release file data source of the current OS distribution.

See distro release file for details about these information items.

idmtools_calibra.utilities.distro.uname_info()[source]#: Return a dictionary containing key-value pairs for the information items from the distro release file data source of the current OS distribution.

idmtools_calibra.utilities.distro.os_release_attr(attribute)[source]#

Return a single named information item from the os-release file data source of the current OS distribution.

Parameters:

attribute (string): Key of the information item.

Returns:

(string): Value of the information item, if the item exists. The empty string, if the item does not exist.

See os-release file for details about these information items.

idmtools_calibra.utilities.distro.lsb_release_attr(attribute)[source]#

Return a single named information item from the lsb_release command output data source of the current OS distribution.

Parameters:

attribute (string): Key of the information item.

Returns:

(string): Value of the information item, if the item exists. The empty string, if the item does not exist.

See lsb-release command output for details about these information items.

idmtools_calibra.utilities.distro.distro_release_attr(attribute)[source]#

Return a single named information item from the distro release file data source of the current OS distribution.

Parameters:

attribute (string): Key of the information item.

Returns:

(string): Value of the information item, if the item exists. The empty string, if the item does not exist.

See distro release file for details about these information items.

idmtools_calibra.utilities.distro.uname_attr(attribute)[source]#

Return a single named information item from the distro release file data source of the current OS distribution.

Parameters:

attribute (string): Key of the information item.

Returns:

(string): Value of the information item, if the item exists.
The empty string, if the item does not exist.

class idmtools_calibra.utilities.distro.cached_property(f)[source]#

Bases: object

A version of @property which caches the value. On access, it calls the underlying function and sets the value in __dict__ so future accesses will not re-call the property.

class idmtools_calibra.utilities.distro.LinuxDistribution(include_lsb=True, os_release_file='', distro_release_file='', include_uname=True)[source]#

Bases: object

Provides information about a OS distribution.

This package creates a private module-global instance of this class with default initialization arguments, that is used by the consolidated accessor functions and single source accessor functions. By using default initialization arguments, that module-global instance returns data about the current OS distribution (i.e. the distro this package runs on).

Normally, it is not necessary to create additional instances of this class. However, in situations where control is needed over the exact data sources that are used, instances of this class can be created with a specific distro release file, or a specific os-release file, or without invoking the lsb_release command.

linux_distribution(full_distribution_name=True)[source]#

Return information about the OS distribution that is compatible with Python’s platform.linux_distribution(), supporting a subset of its parameters.

For details, see distro.linux_distribution().

id()[source]#

Return the distro ID of the OS distribution, as a string.

For details, see distro.id().

name(pretty=False)[source]#

Return the name of the OS distribution, as a string.

For details, see distro.name().

version(pretty=False, best=False)[source]#

Return the version of the OS distribution, as a string.

For details, see distro.version().

version_parts(best=False)[source]#

Return the version of the OS distribution, as a tuple of version numbers.

For details, see distro.version_parts().

major_version(best=False)[source]#

Return the major version number of the current distribution.

For details, see distro.major_version().

minor_version(best=False)[source]#

Return the minor version number of the current distribution.

For details, see distro.minor_version().

build_number(best=False)[source]#

Return the build number of the current distribution.

For details, see distro.build_number().

like()[source]#

Return the IDs of distributions that are like the OS distribution.

For details, see distro.like().

codename()[source]#

Return the codename of the OS distribution.

For details, see distro.codename().

info(pretty=False, best=False)[source]#

Return certain machine-readable information about the OS distribution.

For details, see distro.info().

os_release_info()[source]#

Return a dictionary containing key-value pairs for the information items from the os-release file data source of the OS distribution.

For details, see distro.os_release_info().

lsb_release_info()[source]#

Return a dictionary containing key-value pairs for the information items from the lsb_release command data source of the OS distribution.

For details, see distro.lsb_release_info().

distro_release_info()[source]#

Return a dictionary containing key-value pairs for the information items from the distro release file data source of the OS distribution.

For details, see distro.distro_release_info().

uname_info()[source]#

Return a dictionary containing key-value pairs for the information items from the uname command data source of the OS distribution.

For details, see distro.uname_info().

os_release_attr(attribute)[source]#

Return a single named information item from the os-release file data source of the OS distribution.

For details, see distro.os_release_attr().

lsb_release_attr(attribute)[source]#

Return a single named information item from the lsb_release command output data source of the OS distribution.

For details, see distro.lsb_release_attr().

distro_release_attr(attribute)[source]#

Return a single named information item from the distro release file data source of the OS distribution.

For details, see distro.distro_release_attr().

uname_attr(attribute)[source]#

Return a single named information item from the uname command output data source of the OS distribution.

For details, see distro.uname_release_attr().

idmtools_calibra.utilities.distro.main()[source]#

idmtools_calibra.utilities.distro.test()[source]#