3
Pf͕ @ sb d Z ddlZddlZddlZddlZddlZddlZddlZejj dsXe
dj ejdZ dZ
i Zddd Zd
diZejd Zejd Zd
dde
dfZd:ddZdd Zd;ddZdd d Zd?d d Zd@d!d"Z d#d$ Z d%d& Z dAd'd(Z d)d* Z d+d, Z!d-d. Z"d/d0 Z#d1d2 Z$d3d4 Z%G d5d6 d6e&Z'e' Z(d7d8 Z)e*d9kr^e) dS )Ba,
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 a renewed alternative implementation for Python's original
:py:func:`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.7 is expected to remove it
altogether. Its predecessor function :py:func:`platform.dist` was already
deprecated since Python 2.6 and is also expected to be removed in Python 3.7.
Still, there are many cases in which access to Linux distribution information
is needed. See `Python issue 1322 `_ for
more information.
NlinuxzUnsupported platform: {0}z/etcz
os-releaseZoracleZrhel)ZenterpriseenterpriseZredhatenterpriseworkstationZredhatzA(?:[^)]*\)(.*)\()? *(?:STL )?([\d.+\-a-z]*\d) *(?:esaeler *)?(.+)z(\w+)[-_](release|version)$Zdebian_versionz lsb-releasez oem-releasezsystem-releaseTc C s
t j| S )a$
Return information about the current Linux 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 Linux 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 Linux distributions.
)_distrolinux_distribution)full_distribution_name r /usr/lib/python3.6/distro.pyr ` s r c C s t j S )a
Return the distro ID of the current Linux distribution, as a
machine-readable string.
For a number of Linux 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
============== =========================================
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 Linux 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.
)r idr r r r r | s Hr Fc C s
t j| S )an
Return the name of the current Linux 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 "" 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 "" field of the distro release file, appended
with the value of the pretty version ("" and ""
fields) of the distro release file, if available.
)r name)prettyr r r r s $r c C s t j| |S )ay
Return the version of the current Linux 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 "" 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.
)r version)r
bestr r r r s )r c C s
t j| S )a
Return the version of the current Linux 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.
)r
version_parts)r r r r r
s r
c C s
t j| S )a8
Return the major version of the current Linux 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.
)r
major_version)r r r r r + s
r c C s
t j| S )a9
Return the minor version of the current Linux 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.
)r
minor_version)r r r r r 8 s
r c C s
t j| S )a6
Return the build number of the current Linux 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.
)r build_number)r r r r r E s
r c C s t j S )a
Return a space-separated list of distro IDs of distributions that are
closely related to the current Linux 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
`_.
)r liker r r r r R s r c C s t j S )a
Return the codename for the release of the current Linux 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 "" field of the distro release file.
)r codenamer r r r r c s r c C s t j| |S )a
Return certain machine-readable information items about the current Linux
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.
)r info)r
r r r r r { s )r c C s t j S )z
Return a dictionary containing key-value pairs for the information items
from the os-release file data source of the current Linux distribution.
See `os-release file`_ for details about these information items.
)r os_release_infor r r r r s r c C s t j S )z
Return a dictionary containing key-value pairs for the information items
from the lsb_release command data source of the current Linux distribution.
See `lsb_release command output`_ for details about these information
items.
)r lsb_release_infor r r r r s r c C s t j S )z
Return a dictionary containing key-value pairs for the information items
from the distro release file data source of the current Linux distribution.
See `distro release file`_ for details about these information items.
)r distro_release_infor r r r r s r c C s
t j| S )a
Return a single named information item from the os-release file data source
of the current Linux 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.
)r os_release_attr) attributer r r r s r c C s
t j| S )a
Return a single named information item from the lsb_release command output
data source of the current Linux 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.
)r lsb_release_attr)r r r r r s r c C s
t j| S )a
Return a single named information item from the distro release file
data source of the current Linux 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.
)r distro_release_attr)r r r r r s r c @ s e Zd ZdZd:ddZdd Zd;dd Zd
d ZdddZ
d?ddZ d@ddZ dAddZ
dd Zdd ZdBd d Zd d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Zd+d, Zed-d. Zd/d0 Zed1d2 Zd3d4 Z d5d6 Z ed7d8 Z d9S )CLinuxDistributiona
Provides information about a Linux 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 Linux 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.
T c C sH |pt jjtt| _|pd| _| j | _|r4| j ni | _
| j | _ dS )a8
The initialization method of this class gathers information from the
available data sources, and stores that in private instance attributes.
Subsequent access to the information items uses these private instance
attributes, so that the data sources are read only once.
Parameters:
* ``include_lsb`` (bool): Controls whether the
`lsb_release command output`_ is included as a data source.
If the lsb_release command is not available in the program execution
path, the data source for the lsb_release command will be empty.
* ``os_release_file`` (string): The path name of the
`os-release file`_ that is to be used as a data source.
An empty string (the default) will cause the default path name to
be used (see `os-release file`_ for details).
If the specified or defaulted os-release file does not exist, the
data source for the os-release file will be empty.
* ``distro_release_file`` (string): The path name of the
`distro release file`_ that is to be used as a data source.
An empty string (the default) will cause a default search algorithm
to be used (see `distro release file`_ for details).
If the specified distro release file does not exist, or if no default
distro release file can be found, the data source for the distro
release file will be empty.
Public instance attributes:
* ``os_release_file`` (string): The path name of the
`os-release file`_ that is actually used as a data source. The
empty string if no distro release file is used as a data source.
* ``distro_release_file`` (string): The path name of the
`distro release file`_ that is actually used as a data source. The
empty string if no distro release file is used as a data source.
Raises:
* :py:exc:`IOError`: Some I/O issue with an os-release file or distro
release file.
* :py:exc:`subprocess.CalledProcessError`: The lsb_release command had
some issue (other than not being available in the program execution
path).
* :py:exc:`UnicodeError`: A data source has unexpected characters or
uses an unexpected encoding.
r N)
ospathjoin _UNIXCONFDIR_OS_RELEASE_BASENAMEos_release_filedistro_release_file_get_os_release_info_os_release_info_get_lsb_release_info_lsb_release_info_get_distro_release_info_distro_release_info)selfZ include_lsbr" r# r r r __init__ s ;
zLinuxDistribution.__init__c C s dj | j| j| j| j| jS )z Return repr of all info
zLinuxDistribution(os_release_file={0!r}, distro_release_file={1!r}, _os_release_info={2!r}, _lsb_release_info={3!r}, _distro_release_info={4!r}))formatr" r# r% r' r) )r* r r r __repr__U s zLinuxDistribution.__repr__c C s" |r | j n| j | j | j fS )z
Return information about the Linux distribution that is compatible
with Python's :func:`platform.linux_distribution`, supporting a subset
of its parameters.
For details, see :func:`distro.linux_distribution`.
)r r r r )r* r r r r r e s z$LinuxDistribution.linux_distributionc C sT dd }| j d}|r ||tS | jd}|r8||tS | jd}|rP||tS dS )zrReturn the distro ID of the Linux distribution, as a string.
For details, see :func:`distro.id`.
c S s | j jdd} |j| | S )N _)lowerreplaceget) distro_idtabler r r normalizex s z'LinuxDistribution.id..normalizer distributor_idr )r NORMALIZED_OS_IDr NORMALIZED_LSB_IDr NORMALIZED_DISTRO_ID)r* r5 r3 r r r r s s
zLinuxDistribution.idFc C sh | j dp | jdp | jd}|r`| j dp4| jd}|s`| jd}| jdd}|r`|d | }|pfdS ) zx
Return the name of the Linux distribution, as a string.
For details, see :func:`distro.name`.
r r6 pretty_name descriptionT)r
r. r )r r r r )r* r
r r r r r r s
zLinuxDistribution.namec C s | j d| jd| jd| j| j djdd| j| jdjddg}d}|rxJ|D ]$}|jd|jdksv|dkrV|}qVW n x|D ]}|dkr|}P qW |r|r| j rdj|| j }|S )z~
Return the version of the Linux distribution, as a string.
For details, see :func:`distro.version`.
version_idreleaser: r r; .z {0} ({1}))r r r _parse_distro_release_contentr2 countr r, )r* r
r Zversionsr vr r r r s&
zLinuxDistribution.versionc C sL | j |d}|rHtjd}|j|}|rH|j \}}}||p>d|pDdfS dS )z
Return the version of the Linux distribution, as a tuple of version
numbers.
For details, see :func:`distro.version_parts`.
)r z(\d+)\.?(\d+)?\.?(\d+)?r )r r r )r recompilematchgroups)r* r Z version_strZ
version_regexmatchesmajorminorr r r r r
s
z LinuxDistribution.version_partsc C s | j |d S )z
Return the major version number of the current distribution.
For details, see :func:`distro.major_version`.
r )r
)r* r r r r r s z LinuxDistribution.major_versionc C s | j |d S )z
Return the minor version number of the Linux distribution.
For details, see :func:`distro.minor_version`.
)r
)r* r r r r r s z LinuxDistribution.minor_versionc C s | j |d S )z{
Return the build number of the Linux distribution.
For details, see :func:`distro.build_number`.
)r
)r* r r r r r s z LinuxDistribution.build_numberc C s | j dp dS )z
Return the IDs of distributions that are like the Linux distribution.
For details, see :func:`distro.like`.
Zid_liker )r )r* r r r r s zLinuxDistribution.likec C s" | j dp | jdp | jdp dS )zs
Return the codename of the Linux distribution.
For details, see :func:`distro.codename`.
r r )r r r )r* r r r r s
zLinuxDistribution.codenamec C sB t | j | j||t | j|| j|| j|d| j | j dS )z
Return certain machine-readable information about the Linux
distribution.
For details, see :func:`distro.info`.
)rG rH r )r r r
r r )dictr r r r r r r )r* r
r r r r r s
zLinuxDistribution.infoc C s | j S )z
Return a dictionary containing key-value pairs for the information
items from the os-release file data source of the Linux distribution.
For details, see :func:`distro.os_release_info`.
)r% )r* r r r r s z!LinuxDistribution.os_release_infoc C s | j S )z
Return a dictionary containing key-value pairs for the information
items from the lsb_release command data source of the Linux
distribution.
For details, see :func:`distro.lsb_release_info`.
)r' )r* r r r r s z"LinuxDistribution.lsb_release_infoc C s | j S )z
Return a dictionary containing key-value pairs for the information
items from the distro release file data source of the Linux
distribution.
For details, see :func:`distro.distro_release_info`.
)r) )r* r r r r s z%LinuxDistribution.distro_release_infoc C s | j j|dS )z
Return a single named information item from the os-release file data
source of the Linux distribution.
For details, see :func:`distro.os_release_attr`.
r )r% r2 )r* r r r r r ) s z!LinuxDistribution.os_release_attrc C s | j j|dS )z
Return a single named information item from the lsb_release command
output data source of the Linux distribution.
For details, see :func:`distro.lsb_release_attr`.
r )r' r2 )r* r r r r r 2 s z"LinuxDistribution.lsb_release_attrc C s | j j|dS )z
Return a single named information item from the distro release file
data source of the Linux distribution.
For details, see :func:`distro.distro_release_attr`.
r )r) r2 )r* r r r r r ; s z%LinuxDistribution.distro_release_attrc C s. t jj| jr*t| j }| j|S Q R X i S )z
Get the information items from the specified os-release file.
Returns:
A dictionary containing all information items.
N)r r isfiler" open_parse_os_release_content)r* Z release_filer r r r$ D s z&LinuxDistribution._get_os_release_infoc C s i }t j | dd}d|_tjd dkr@t|jtr@|jjd|_t|}x|D ]}d|krN|j dd\}}t|tr~|jd}|||j
< |d krt j d
|}|r|j
}|jd }|jd }|j }||d
< qd|d
< qNqNW |S )aD
Parse the lines of an os-release file.
Parameters:
* lines: Iterable through the lines in the os-release file.
Each line must be a unicode string or a UTF-8 encoded byte
string.
Returns:
A dictionary containing all information items.
T)posixr rJ z
iso-8859-1=rI zutf-8VERSIONz(\(\D+\))|,(\s+)?\D+z(),r r )shlexZwhitespace_splitsys version_info
isinstanceZ wordcharsbytesdecodelistsplitr0 rB searchgroupstrip)linespropsZlexertokenstokenkrA r r r r rN P s.
z+LinuxDistribution._parse_os_release_contentc C s d}t j|dt jt jd}|j \}}|jd|jd }}|j}|dkr\|j }| j|S |dkrhi S tj dd d
krt j
||||n@tj dd dkrt j
|||n tj dd dkrt j
||dS )z
Get the information items from the lsb_release command output.
Returns:
A dictionary containing all information items.
zlsb_release -aT)shellstdoutstderrzutf-8r NrJ )rg rh )rJ ri )rJ rj )
subprocessPopenPIPEZ communicaterX
returncode
splitlines_parse_lsb_release_contentrT rU ZCalledProcessError)r* cmdZprocessrd re codeZcontentr r r r& s(
z'LinuxDistribution._get_lsb_release_infoc C st i }xj| D ]b}t |tr"|jdn|}|jdjdd}t|dkrFq
|\}}|j|jddj |j i q
W |S )aM
Parse the output of the lsb_release command.
Parameters:
* lines: Iterable through the lines of the lsb_release output.
Each line must be a unicode string or a UTF-8 encoded byte
string.
Returns:
A dictionary containing all information items.
zutf-8
:rI rJ r. r/ ) rV rW rX r] rZ lenupdater1 r0 )r^ r_ lineZkvrb rA r r r rp s
"z,LinuxDistribution._parse_lsb_release_contentc C s | j r@| j| j }tjj| j }tj|}|r<|jd|d< |S tjt }|j
x\|D ]T}|t krfqXtj|}|rXtjj t |}| j|}d|krX|| _ |jd|d< |S qXW i S dS )z
Get the information items from the specified distro release file.
Returns:
A dictionary containing all information items.
rI r r N)
r# _parse_distro_release_filer r basename _DISTRO_RELEASE_BASENAME_PATTERNrD r\ listdirr sort _DISTRO_RELEASE_IGNORE_BASENAMESr )r* distro_infory rD Z basenamesfilepathr r r r( s,
z*LinuxDistribution._get_distro_release_infoc C s. t jj|r*t|}| j|j S Q R X i S )z
Parse a distro release file.
Parameters:
* filepath: Path name of the distro release file.
Returns:
A dictionary containing all information items.
N)r r rL rM r? readline)r* r fpr r r rx s
z,LinuxDistribution._parse_distro_release_filec C s t | tr| jd} tj| j ddd }i }|r|jdddd
|d< |jdrn|jdddd |d< |jdr|jdddd |d< n| r| j |d< |S )
a
Parse a line from a distro release file.
Parameters:
* line: Line from the distro release file. Must be a unicode string
or a UTF-8 encoded byte string.
Returns:
A dictionary containing all information items.
zutf-8NrI rg r rJ r< r r r r )rV rW rX (_DISTRO_RELEASE_CONTENT_REVERSED_PATTERNrD r] r\ )rw rF r~ r r r r? s
z/LinuxDistribution._parse_distro_release_contentN)Tr r )T)F)FF)F)F)F)F)FF) __name__
__module__ __qualname____doc__r+ r- r r r r r
r r r r r r r r r r r r r$ staticmethodrN r& rp r( rx r? r r r r r s:
@
!
< )r c C s dd l } tjt}|jtj |jtjtj | j
dd}|j ddddd |j }|j
rv|jt
jt d d
d nB|jd td
d
td
d
}|r|jd| t }|r|jd| d S )Nr zLinux distro info tool)r; z--jsonz-jz!Output in machine readable format
store_true)helpaction T)indentZ sort_keyszName: %s)r
z Version: %sz Codename: %s)argparseloggingZ getLoggerr ZsetLevelDEBUGZ
addHandlerZ
StreamHandlerrT rd ArgumentParser add_argument
parse_argsjsonr dumpsr r r )r ZloggerparserargsZdistribution_versionZdistribution_codenamer r r main s(
r __main__)T)F)FF)F)F)F)F)FF)+r r rB rT r rS r rk platform
startswith ImportErrorr, r r! r7 r8 r9 rC r rz r} r r r r r
r r r r r r r r r r r r objectr r r r r r r r sd
K
'
,
,