distro

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. Still, there are many cases in which access to OS distribution information is needed. See Python issue 1322 <https://bugs.python.org/issue1322>_ for more information.

Members

Functions

build_number
dstring build_number(bool best = false)

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 :func:distro.version method.

codename
dstring codename()

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.

distro_release_attr
dstring distro_release_attr(dstring attribute)

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

distro_release_info
dstring[dstring] distro_release_info()

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.

id
dstring id()

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 :func: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.

info
auto info(bool pretty = false, bool best = false)

Return certain machine-readable information items about the current OS distribution in a dictionary, as shown in the following example: .. sourcecode:: python { '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 :func:distro.id. `version`: The result of :func:distro.version. `version_parts -> major`: The result of :func:distro.major_version. `version_parts -> minor`: The result of :func:distro.minor_version. `version_parts -> build_number`: The result of :func:distro.build_number. `like`: The result of :func:distro.like. `codename`: The result of :func:distro.codename. For a description of the *pretty* and *best* parameters, see the :func:distro.version method.

like
dstring like()

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 <http://www.freedesktop.org/software/systemd/man/os-release.html>`_.

linux_distribution
auto linux_distribution(bool full_distribution_name = true)

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 :func:distro.id. Otherwise, the result of :func:distro.name. `version`: The result of :func:distro.version. `codename`: The result of :func:distro.codename. The interface of this function is compatible with the original :py:func: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 :func:distro.id method normalizes the distro ID string to a reliable machine-readable value for a number of popular OS distributions.

lsb_release_attr
dstring lsb_release_attr(dstring attribute)

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

lsb_release_info
dstring[dstring] lsb_release_info()

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.

major_version
dstring major_version(bool best = false)

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 :func:distro.version method.

minor_version
dstring minor_version(bool best = false)

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 :func:distro.version method.

name
dstring name(bool pretty = false)

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.

os_release_attr
dstring os_release_attr(dstring attribute)

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

os_release_info
dstring[dstring] os_release_info()

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.

uname_attr
dstring uname_attr(dstring attribute)

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

uname_info
dstring[dstring] uname_info()

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

version_
dstring version_(bool pretty = false, bool best = false)

Return the version of the current OS distribution, as a human-readable dstring. 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_parts
auto version_parts(bool best = false)

Return the version of the current OS distribution as a tuple `(major, minor, build_number)` with items as follows: `major`: The result of :func:distro.major_version. `minor`: The result of :func:distro.minor_version. `build_number`: The result of :func:distro.build_number. For a description of the *best* parameter, see the :func:distro.version method.

Mixin templates

Cached
mixin template Cached(string name, string baseName = '_' ~ name)

The following code makes cached (memoized) property f

Structs

LinuxDistribution
struct LinuxDistribution

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.

Variables

_distro
auto _distro;

TODO: Remove this as a global initilization?

Meta