platform

This module tries to retrieve as much platform-identifying data as possible. It makes this information available via function APIs.

If called from the command line, it prints the platform information concatenated as single string to stdout. The output format is useable as part of a filename.

platform.architecture(executable='/home/docs/checkouts/readthedocs.org/user_builds/casper-toolflow/envs/latest/bin/python', bits='', linkage='')[source]

Queries the given executable (defaults to the Python interpreter binary) for various architecture information.

Returns a tuple (bits,linkage) which contains information about the bit architecture and the linkage format used for the executable. Both values are returned as strings.

Values that cannot be determined are returned as given by the parameter presets. If bits is given as ‘’, the sizeof(pointer) (or sizeof(long) on Python version < 1.5.2) is used as indicator for the supported pointer size.

The function relies on the system’s “file” command to do the actual work. This is available on most if not all Unix platforms. On some non-Unix platforms where the “file” command does not exist and the executable is set to the Python interpreter binary defaults from _default_architecture are used.

platform.dist(distname='', version='', id='', supported_dists=('SuSE', 'debian', 'fedora', 'redhat', 'centos', 'mandrake', 'mandriva', 'rocks', 'slackware', 'yellowdog', 'gentoo', 'UnitedLinux', 'turbolinux'))[source]

Tries to determine the name of the Linux OS distribution name.

The function first looks for a distribution release file in /etc and then reverts to _dist_try_harder() in case no suitable files are found.

Returns a tuple (distname,version,id) which default to the args given as parameters.

platform.java_ver(release='', vendor='', vminfo=('', '', ''), osinfo=('', '', ''))[source]

Version interface for Jython.

Returns a tuple (release,vendor,vminfo,osinfo) with vminfo being a tuple (vm_name,vm_release,vm_vendor) and osinfo being a tuple (os_name,os_version,os_arch).

Values which cannot be determined are set to the defaults given as parameters (which all default to ‘’).

platform.libc_ver(executable='/home/docs/checkouts/readthedocs.org/user_builds/casper-toolflow/envs/latest/bin/python', lib='', version='', chunksize=2048)[source]

Tries to determine the libc version that the file executable (which defaults to the Python interpreter) is linked against.

Returns a tuple of strings (lib,version) which default to the given parameters in case the lookup fails.

Note that the function has intimate knowledge of how different libc versions add symbols to the executable and thus is probably only useable for executables compiled using gcc.

The file is read and scanned in chunks of chunksize bytes.

platform.linux_distribution(distname='', version='', id='', supported_dists=('SuSE', 'debian', 'fedora', 'redhat', 'centos', 'mandrake', 'mandriva', 'rocks', 'slackware', 'yellowdog', 'gentoo', 'UnitedLinux', 'turbolinux'), full_distribution_name=1)[source]

Tries to determine the name of the Linux OS distribution name.

The function first looks for a distribution release file in /etc and then reverts to _dist_try_harder() in case no suitable files are found.

supported_dists may be given to define the set of Linux distributions to look for. It defaults to a list of currently supported Linux distributions identified by their release file name.

If full_distribution_name is true (default), the full distribution read from the OS is returned. Otherwise the short name taken from supported_dists is used.

Returns a tuple (distname,version,id) which default to the args given as parameters.

platform.mac_ver(release='', versioninfo=('', '', ''), machine='')[source]

Get MacOS version information and return it as tuple (release, versioninfo, machine) with versioninfo being a tuple (version, dev_stage, non_release_version).

Entries which cannot be determined are set to the parameter values which default to ‘’. All tuple entries are strings.

platform.machine()[source]

Returns the machine type, e.g. ‘i386’

An empty string is returned if the value cannot be determined.

platform.node()[source]

Returns the computer’s network name (which may not be fully qualified)

An empty string is returned if the value cannot be determined.

platform.platform(aliased=0, terse=0)[source]

Returns a single string identifying the underlying platform with as much useful information as possible (but no more :).

The output is intended to be human readable rather than machine parseable. It may look different on different platforms and this is intended.

If “aliased” is true, the function will use aliases for various platforms that report system names which differ from their common names, e.g. SunOS will be reported as Solaris. The system_alias() function is used to implement this.

Setting terse to true causes the function to return only the absolute minimum information needed to identify the platform.

platform.popen(cmd, mode='r', bufsize=None)[source]

Portable popen() interface.

platform.processor()[source]

Returns the (true) processor name, e.g. ‘amdk6’

An empty string is returned if the value cannot be determined. Note that many platforms do not provide this information or simply return the same value as for machine(), e.g. NetBSD does this.

platform.python_branch()[source]

Returns a string identifying the Python implementation branch.

For CPython this is the Subversion branch from which the Python binary was built.

If not available, an empty string is returned.

platform.python_build()[source]

Returns a tuple (buildno, builddate) stating the Python build number and date as strings.

platform.python_compiler()[source]

Returns a string identifying the compiler used for compiling Python.

platform.python_implementation()[source]

Returns a string identifying the Python implementation.

Currently, the following implementations are identified:
‘CPython’ (C implementation of Python), ‘IronPython’ (.NET implementation of Python), ‘Jython’ (Java implementation of Python), ‘PyPy’ (Python implementation of Python).
platform.python_revision()[source]

Returns a string identifying the Python implementation revision.

For CPython this is the Subversion revision from which the Python binary was built.

If not available, an empty string is returned.

platform.python_version()[source]

Returns the Python version as string ‘major.minor.patchlevel’

Note that unlike the Python sys.version, the returned value will always include the patchlevel (it defaults to 0).

platform.python_version_tuple()[source]

Returns the Python version as tuple (major, minor, patchlevel) of strings.

Note that unlike the Python sys.version, the returned value will always include the patchlevel (it defaults to 0).

platform.release()[source]

Returns the system’s release, e.g. ‘2.2.0’ or ‘NT’

An empty string is returned if the value cannot be determined.

platform.system()[source]

Returns the system/OS name, e.g. ‘Linux’, ‘Windows’ or ‘Java’.

An empty string is returned if the value cannot be determined.

platform.system_alias(system, release, version)[source]

Returns (system,release,version) aliased to common marketing names used for some systems.

It also does some reordering of the information in some cases where it would otherwise cause confusion.

platform.uname()[source]

Fairly portable uname interface. Returns a tuple of strings (system,node,release,version,machine,processor) identifying the underlying platform.

Note that unlike the os.uname function this also returns possible processor information as an additional tuple entry.

Entries which cannot be determined are set to ‘’.

platform.version()[source]

Returns the system’s release version, e.g. ‘#3 on degas’

An empty string is returned if the value cannot be determined.

platform.win32_ver(release='', version='', csd='', ptype='')[source]