platform.py 48.1 KB
Newer Older
1
#!/usr/bin/env python3
2

Brett Cannon's avatar
Brett Cannon committed
3
""" This module tries to retrieve as much platform-identifying data as
4 5 6 7 8 9 10 11 12
    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.

"""
#    This module is maintained by Marc-Andre Lemburg <mal@egenix.com>.
#    If you find problems, please submit bug reports/patches via the
Benjamin Peterson's avatar
Benjamin Peterson committed
13
#    Python bug tracker (http://bugs.python.org) and assign them to "lemburg".
14 15 16 17 18 19 20
#
#    Still needed:
#    * more support for WinCE
#    * support for MS-DOS (PythonDX ?)
#    * support for Amiga and other still unsupported platforms running Python
#    * support for additional Linux distributions
#
Brett Cannon's avatar
Brett Cannon committed
21
#    Many thanks to all those who helped adding platform-specific
22 23 24 25 26 27 28
#    checks (in no particular order):
#
#      Charles G Waldman, David Arnold, Gordon McMillan, Ben Darnell,
#      Jeff Bauer, Cliff Crawford, Ivan Van Laningham, Josef
#      Betancourt, Randall Hopper, Karl Putland, John Farrell, Greg
#      Andruk, Just van Rossum, Thomas Heller, Mark R. Levinson, Mark
#      Hammond, Bill Tutt, Hans Nowak, Uwe Zessin (OpenVMS support),
29
#      Colin Kong, Trent Mick, Guido van Rossum, Anthony Baxter
30 31
#
#    History:
32 33 34
#
#    <see CVS and SVN checkin messages for history>
#
35
#    1.0.7 - added DEV_NULL
36 37 38
#    1.0.6 - added linux_distribution()
#    1.0.5 - fixed Java support to allow running the module on Jython
#    1.0.4 - added IronPython support
39
#    1.0.3 - added normalization of Windows system name
40
#    1.0.2 - added more Windows support
41
#    1.0.1 - reformatted to make doc.py happy
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
#    1.0.0 - reformatted a bit and checked into Python CVS
#    0.8.0 - added sys.version parser and various new access
#            APIs (python_version(), python_compiler(), etc.)
#    0.7.2 - fixed architecture() to use sizeof(pointer) where available
#    0.7.1 - added support for Caldera OpenLinux
#    0.7.0 - some fixes for WinCE; untabified the source file
#    0.6.2 - support for OpenVMS - requires version 1.5.2-V006 or higher and
#            vms_lib.getsyi() configured
#    0.6.1 - added code to prevent 'uname -p' on platforms which are
#            known not to support it
#    0.6.0 - fixed win32_ver() to hopefully work on Win95,98,NT and Win2k;
#            did some cleanup of the interfaces - some APIs have changed
#    0.5.5 - fixed another type in the MacOS code... should have
#            used more coffee today ;-)
#    0.5.4 - fixed a few typos in the MacOS code
#    0.5.3 - added experimental MacOS support; added better popen()
#            workarounds in _syscmd_ver() -- still not 100% elegant
#            though
#    0.5.2 - fixed uname() to return '' instead of 'unknown' in all
#            return values (the system uname command tends to return
#            'unknown' instead of just leaving the field emtpy)
#    0.5.1 - included code for slackware dist; added exception handlers
#            to cover up situations where platforms don't have os.popen
#            (e.g. Mac) or fail on socket.gethostname(); fixed libc
#            detection RE
#    0.5.0 - changed the API names referring to system commands to *syscmd*;
#            added java_ver(); made syscmd_ver() a private
#            API (was system_ver() in previous versions) -- use uname()
#            instead; extended the win32_ver() to also return processor
#            type information
#    0.4.0 - added win32_ver() and modified the platform() output for WinXX
#    0.3.4 - fixed a bug in _follow_symlinks()
#    0.3.3 - fixed popen() and "file" command invokation bugs
#    0.3.2 - added architecture() API and support for it in platform()
#    0.3.1 - fixed syscmd_ver() RE to support Windows NT
#    0.3.0 - added system alias support
#    0.2.3 - removed 'wince' again... oh well.
#    0.2.2 - added 'wince' to syscmd_ver() supported platforms
#    0.2.1 - added cache logic and changed the platform string format
#    0.2.0 - changed the API to use functions instead of module globals
#            since some action take too long to be run on module import
#    0.1.0 - first release
#
#    You can always get the latest version of this module at:
#
#             http://www.egenix.com/files/python/platform.py
#
#    If that URL should fail, try contacting the author.

__copyright__ = """
    Copyright (c) 1999-2000, Marc-Andre Lemburg; mailto:mal@lemburg.com
93
    Copyright (c) 2000-2010, eGenix.com Software GmbH; mailto:info@egenix.com
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

    Permission to use, copy, modify, and distribute this software and its
    documentation for any purpose and without fee or royalty is hereby granted,
    provided that the above copyright notice appear in all copies and that
    both that copyright notice and this permission notice appear in
    supporting documentation or portions thereof, including modifications,
    that you make.

    EGENIX.COM SOFTWARE GMBH DISCLAIMS ALL WARRANTIES WITH REGARD TO
    THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
    FITNESS, IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL,
    INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
    FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
    NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
    WITH THE USE OR PERFORMANCE OF THIS SOFTWARE !

"""

112
__version__ = '1.0.7'
113

114
import sys, os, re
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
### Globals & Constants

# Determine the platform's /dev/null device
try:
    DEV_NULL = os.devnull
except AttributeError:
    # os.devnull was added in Python 2.4, so emulate it for earlier
    # Python versions
    if sys.platform in ('dos','win32','win16','os2'):
        # Use the old CP/M NUL as device name
        DEV_NULL = 'NUL'
    else:
        # Standard Unix uses /dev/null
        DEV_NULL = '/dev/null'

131 132
### Platform specific APIs

133 134
_libc_search = re.compile(r'(__libc_init)'
                          '|'
Tim Peters's avatar
Tim Peters committed
135 136
                          '(GLIBC_([0-9.]+))'
                          '|'
137
                          '(libc(_\w+)?\.so(?:\.(\d[0-9.]*))?)', re.ASCII)
138

139 140
def libc_ver(executable=sys.executable,lib='',version='',

141
             chunksize=2048):
142

Brett Cannon's avatar
Brett Cannon committed
143 144
    """ Tries to determine the libc version that the file executable
        (which defaults to the Python interpreter) is linked against.
145 146 147 148 149

        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
Brett Cannon's avatar
Brett Cannon committed
150 151
        libc versions add symbols to the executable and thus is probably
        only useable for executables compiled using gcc.
152 153 154 155

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

    """
156 157 158 159 160
    if hasattr(os.path, 'realpath'):
        # Python 2.2 introduced os.path.realpath(); it is used
        # here to work around problems with Cygwin not being
        # able to open symlinks for reading
        executable = os.path.realpath(executable)
161
    f = open(executable,'rb')
162
    binary = f.read(chunksize).decode('latin-1')
163 164
    pos = 0
    while 1:
165
        m = _libc_search.search(binary,pos)
166
        if not m:
167
            binary = f.read(chunksize).decode('latin-1')
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
            if not binary:
                break
            pos = 0
            continue
        libcinit,glibc,glibcversion,so,threads,soversion = m.groups()
        if libcinit and not lib:
            lib = 'libc'
        elif glibc:
            if lib != 'glibc':
                lib = 'glibc'
                version = glibcversion
            elif glibcversion > version:
                version = glibcversion
        elif so:
            if lib != 'glibc':
                lib = 'libc'
                if soversion > version:
                    version = soversion
                if threads and version[-len(threads):] != threads:
                    version = version + threads
        pos = m.end()
    f.close()
    return lib,version

def _dist_try_harder(distname,version,id):

Tim Peters's avatar
Tim Peters committed
194
    """ Tries some special tricks to get the distribution
195 196 197 198 199 200 201 202 203
        information in case the default method fails.

        Currently supports older SuSE Linux, Caldera OpenLinux and
        Slackware Linux distributions.

    """
    if os.path.exists('/var/adm/inst-log/info'):
        # SuSE Linux stores distribution information in that file
        distname = 'SuSE'
204
        for line in open('/var/adm/inst-log/info'):
205
            tv = line.split()
206 207 208 209 210
            if len(tv) == 2:
                tag,value = tv
            else:
                continue
            if tag == 'MIN_DIST_VERSION':
211
                version = value.strip()
212
            elif tag == 'DIST_IDENT':
213
                values = value.split('-')
214 215 216 217 218
                id = values[2]
        return distname,version,id

    if os.path.exists('/etc/.installed'):
        # Caldera OpenLinux has some infos in that file (thanks to Colin Kong)
219
        for line in open('/etc/.installed'):
220
            pkg = line.split('-')
221 222 223 224 225 226 227 228
            if len(pkg) >= 2 and pkg[0] == 'OpenLinux':
                # XXX does Caldera support non Intel platforms ? If yes,
                #     where can we find the needed id ?
                return 'OpenLinux',pkg[1],id

    if os.path.isdir('/usr/lib/setup'):
        # Check for slackware verson tag file (thanks to Greg Andruk)
        verfiles = os.listdir('/usr/lib/setup')
229
        for n in range(len(verfiles)-1, -1, -1):
230 231 232 233 234 235 236 237 238 239
            if verfiles[n][:14] != 'slack-version-':
                del verfiles[n]
        if verfiles:
            verfiles.sort()
            distname = 'slackware'
            version = verfiles[-1][14:]
            return distname,version,id

    return distname,version,id

240
_release_filename = re.compile(r'(\w+)[-_](release|version)', re.ASCII)
241 242 243
_lsb_release_version = re.compile(r'(.+)'
                                   ' release '
                                   '([\d.]+)'
244
                                   '[^(]*(?:\((.+)\))?', re.ASCII)
245 246 247
_release_version = re.compile(r'([^0-9]+)'
                               '(?: release )?'
                               '([\d.]+)'
248
                               '[^(]*(?:\((.+)\))?', re.ASCII)
249 250

# See also http://www.novell.com/coolsolutions/feature/11251.html
251
# and http://linuxmafia.com/faq/Admin/release-files.html
252 253 254
# and http://data.linux-ntfs.org/rpm/whichrpm
# and http://www.die.net/doc/linux/man/man1/lsb_release.1.html

Christian Heimes's avatar
Christian Heimes committed
255 256 257 258
_supported_dists = (
    'SuSE', 'debian', 'fedora', 'redhat', 'centos',
    'mandrake', 'mandriva', 'rocks', 'slackware', 'yellowdog', 'gentoo',
    'UnitedLinux', 'turbolinux')
259 260

def _parse_release_file(firstline):
261

262 263 264 265 266 267
    # Default to empty 'version' and 'id' strings.  Both defaults are used
    # when 'firstline' is empty.  'id' defaults to empty when an id can not
    # be deduced.
    version = ''
    id = ''

268 269 270 271 272 273 274 275 276 277 278 279
    # Parse the first line
    m = _lsb_release_version.match(firstline)
    if m is not None:
        # LSB format: "distro release x.x (codename)"
        return tuple(m.groups())

    # Pre-LSB format: "distro x.x (codename)"
    m = _release_version.match(firstline)
    if m is not None:
        return tuple(m.groups())

    # Unkown format... take the first two words
280
    l = firstline.strip().split()
281 282 283 284 285 286 287 288 289 290
    if l:
        version = l[0]
        if len(l) > 1:
            id = l[1]
    return '', version, id

def linux_distribution(distname='', version='', id='',

                       supported_dists=_supported_dists,
                       full_distribution_name=1):
291

Brett Cannon's avatar
Brett Cannon committed
292
    """ Tries to determine the name of the Linux OS distribution name.
293 294 295 296 297

        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.

298 299 300 301 302 303 304 305 306
        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.

Brett Cannon's avatar
Brett Cannon committed
307
        Returns a tuple (distname,version,id) which default to the
308 309 310 311 312 313 314 315
        args given as parameters.

    """
    try:
        etc = os.listdir('/etc')
    except os.error:
        # Probably not a Unix system
        return distname,version,id
316
    etc.sort()
317
    for file in etc:
318
        m = _release_filename.match(file)
319
        if m is not None:
320 321 322 323 324 325
            _distname,dummy = m.groups()
            if _distname in supported_dists:
                distname = _distname
                break
    else:
        return _dist_try_harder(distname,version,id)
326

327
    # Read the first line
328 329
    with open('/etc/'+file, 'r') as f:
        firstline = f.readline()
330 331 332 333 334 335 336 337 338 339 340
    _distname, _version, _id = _parse_release_file(firstline)

    if _distname and full_distribution_name:
        distname = _distname
    if _version:
        version = _version
    if _id:
        id = _id
    return distname, version, id

# To maintain backwards compatibility:
341

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
def dist(distname='',version='',id='',

         supported_dists=_supported_dists):

    """ 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.

    """
    return linux_distribution(distname, version, id,
                              supported_dists=supported_dists,
                              full_distribution_name=0)
359 360 361 362 363

def popen(cmd, mode='r', bufsize=None):

    """ Portable popen() interface.
    """
364
    return os.popen(cmd, mode, bufsize)
365

366
def _norm_version(version, build=''):
367

Brett Cannon's avatar
Brett Cannon committed
368
    """ Normalize the version and build strings and return a single
Walter Dörwald's avatar
Walter Dörwald committed
369
        version string using the format major.minor.build (or patchlevel).
370
    """
371
    l = version.split('.')
372 373 374 375 376 377 378
    if build:
        l.append(build)
    try:
        ints = map(int,l)
    except ValueError:
        strings = l
    else:
379
        strings = list(map(str,ints))
380
    version = '.'.join(strings[:3])
381 382
    return version

383 384
_ver_output = re.compile(r'(?:([\w ]+) ([\w.]+) '
                         '.*'
385 386 387 388 389 390 391 392 393 394
                         '\[.* ([\d.]+)\])')

# Examples of VER command output:
#
#   Windows 2000:  Microsoft Windows 2000 [Version 5.00.2195]
#   Windows XP:    Microsoft Windows XP [Version 5.1.2600]
#   Windows Vista: Microsoft Windows [Version 6.0.6002]
#
# Note that the "Version" string gets localized on different
# Windows versions.
395

396
def _syscmd_ver(system='', release='', version='',
397

398
               supported_platforms=('win32','win16','dos','os2')):
399 400 401

    """ Tries to figure out the OS version used and returns
        a tuple (system,release,version).
Tim Peters's avatar
Tim Peters committed
402

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
        It uses the "ver" shell command for this which is known
        to exists on Windows, DOS and OS/2. XXX Others too ?

        In case this fails, the given parameters are used as
        defaults.

    """
    if sys.platform not in supported_platforms:
        return system,release,version

    # Try some common cmd strings
    for cmd in ('ver','command /c ver','cmd /c ver'):
        try:
            pipe = popen(cmd)
            info = pipe.read()
            if pipe.close():
419
                raise os.error('command failed')
420 421
            # XXX How can I supress shell errors from being written
            #     to stderr ?
422
        except os.error as why:
423 424
            #print 'Command %s failed: %s' % (cmd,why)
            continue
425
        except IOError as why:
426 427 428 429 430 431 432 433
            #print 'Command %s failed: %s' % (cmd,why)
            continue
        else:
            break
    else:
        return system,release,version

    # Parse the output
434
    info = info.strip()
435
    m = _ver_output.match(info)
436
    if m is not None:
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
        system,release,version = m.groups()
        # Strip trailing dots from version and release
        if release[-1] == '.':
            release = release[:-1]
        if version[-1] == '.':
            version = version[:-1]
        # Normalize the version and build strings (eliminating additional
        # zeros)
        version = _norm_version(version)
    return system,release,version

def _win32_getvalue(key,name,default=''):

    """ Read a value for name from the registry key.

        In case this fails, default is returned.

    """
455 456 457 458
    try:
        # Use win32api if available
        from win32api import RegQueryValueEx
    except ImportError:
459 460 461
        # On Python 2.0 and later, emulate using winreg
        import winreg
        RegQueryValueEx = winreg.QueryValueEx
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    try:
        return RegQueryValueEx(key,name)
    except:
        return default

def win32_ver(release='',version='',csd='',ptype=''):

    """ Get additional version information from the Windows Registry
        and return a tuple (version,csd,ptype) referring to version
        number, CSD level and OS type (multi/single
        processor).

        As a hint: ptype returns 'Uniprocessor Free' on single
        processor NT machines and 'Multiprocessor Free' on multi
        processor machines. The 'Free' refers to the OS version being
        free of debugging code. It could also state 'Checked' which
        means the OS version uses debugging code, i.e. code that
        checks arguments, ranges, etc. (Thomas Heller).

481 482 483
        Note: this function works best with Mark Hammond's win32
        package installed, but also on Python 2.3 and later. It
        obviously only runs on Win32 compatible platforms.
484 485 486 487

    """
    # XXX Is there any way to find out the processor type on WinXX ?
    # XXX Is win32 available on Windows CE ?
488
    #
489
    # Adapted from code posted by Karl Putland to comp.lang.python.
490 491 492
    #
    # The mappings between reg. values and release names can be found
    # here: http://msdn.microsoft.com/library/en-us/sysinfo/base/osversioninfo_str.asp
493 494 495 496

    # Import the needed APIs
    try:
        import win32api
497 498 499 500
        from win32api import RegQueryValueEx, RegOpenKeyEx, \
             RegCloseKey, GetVersionEx
        from win32con import HKEY_LOCAL_MACHINE, VER_PLATFORM_WIN32_NT, \
             VER_PLATFORM_WIN32_WINDOWS, VER_NT_WORKSTATION
501
    except ImportError:
502 503 504 505 506 507 508
        # Emulate the win32api module using Python APIs
        try:
            sys.getwindowsversion
        except AttributeError:
            # No emulation possible, so return the defaults...
            return release,version,csd,ptype
        else:
509
            # Emulation using winreg (added in Python 2.0) and
510
            # sys.getwindowsversion() (added in Python 2.3)
511
            import winreg
512
            GetVersionEx = sys.getwindowsversion
513 514 515 516
            RegQueryValueEx = winreg.QueryValueEx
            RegOpenKeyEx = winreg.OpenKeyEx
            RegCloseKey = winreg.CloseKey
            HKEY_LOCAL_MACHINE = winreg.HKEY_LOCAL_MACHINE
517 518 519
            VER_PLATFORM_WIN32_WINDOWS = 1
            VER_PLATFORM_WIN32_NT = 2
            VER_NT_WORKSTATION = 1
520 521
            VER_NT_SERVER = 3
            REG_SZ = 1
522 523

    # Find out the registry key and some general version infos
524 525
    winver = GetVersionEx()
    maj,min,buildno,plat,csd = winver
526
    version = '%i.%i.%i' % (maj,min,buildno & 0xFFFF)
527 528 529 530 531 532
    if hasattr(winver, "service_pack"):
        if winver.service_pack != "":
            csd = 'SP%s' % winver.service_pack_major
    else:
        if csd[:13] == 'Service Pack ':
            csd = 'SP' + csd[13:]
533

534 535 536 537 538 539
    if plat == VER_PLATFORM_WIN32_WINDOWS:
        regkey = 'SOFTWARE\\Microsoft\\Windows\\CurrentVersion'
        # Try to guess the release name
        if maj == 4:
            if min == 0:
                release = '95'
540
            elif min == 10:
541
                release = '98'
542 543 544 545
            elif min == 90:
                release = 'Me'
            else:
                release = 'postMe'
546 547
        elif maj == 5:
            release = '2000'
548

549 550 551 552 553
    elif plat == VER_PLATFORM_WIN32_NT:
        regkey = 'SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'
        if maj <= 4:
            release = 'NT'
        elif maj == 5:
554 555 556 557 558 559 560 561
            if min == 0:
                release = '2000'
            elif min == 1:
                release = 'XP'
            elif min == 2:
                release = '2003Server'
            else:
                release = 'post2003'
562
        elif maj == 6:
563 564 565 566 567 568 569
            if hasattr(winver, "product_type"):
                product_type = winver.product_type
            else:
                product_type = VER_NT_WORKSTATION
                # Without an OSVERSIONINFOEX capable sys.getwindowsversion(),
                # or help from the registry, we cannot properly identify
                # non-workstation versions.
570
                try:
571 572 573 574 575 576 577 578 579 580 581
                    key = RegOpenKeyEx(HKEY_LOCAL_MACHINE, regkey)
                    name, type = RegQueryValueEx(key, "ProductName")
                    # Discard any type that isn't REG_SZ
                    if type == REG_SZ and name.find("Server") != -1:
                        product_type = VER_NT_SERVER
                except WindowsError:
                    # Use default of VER_NT_WORKSTATION
                    pass

            if min == 0:
                if product_type == VER_NT_WORKSTATION:
582 583
                    release = 'Vista'
                else:
584 585 586 587 588 589
                    release = '2008Server'
            elif min == 1:
                if product_type == VER_NT_WORKSTATION:
                    release = '7'
                else:
                    release = '2008ServerR2'
590 591
            else:
                release = 'post2008Server'
592

593 594 595 596 597 598 599 600
    else:
        if not release:
            # E.g. Win3.1 with win32s
            release = '%i.%i' % (maj,min)
        return release,version,csd,ptype

    # Open the registry key
    try:
601
        keyCurVer = RegOpenKeyEx(HKEY_LOCAL_MACHINE, regkey)
602
        # Get a value to make sure the key exists...
603
        RegQueryValueEx(keyCurVer, 'SystemRoot')
604 605
    except:
        return release,version,csd,ptype
Tim Peters's avatar
Tim Peters committed
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
    # Parse values
    #subversion = _win32_getvalue(keyCurVer,
    #                            'SubVersionNumber',
    #                            ('',1))[0]
    #if subversion:
    #   release = release + subversion # 95a, 95b, etc.
    build = _win32_getvalue(keyCurVer,
                            'CurrentBuildNumber',
                            ('',1))[0]
    ptype = _win32_getvalue(keyCurVer,
                           'CurrentType',
                           (ptype,1))[0]

    # Normalize version
    version = _norm_version(version,build)

    # Close key
    RegCloseKey(keyCurVer)
    return release,version,csd,ptype

def _mac_ver_lookup(selectors,default=None):

629
    from _gestalt import gestalt
630 631 632 633 634
    l = []
    append = l.append
    for selector in selectors:
        try:
            append(gestalt(selector))
635
        except (RuntimeError, OSError):
636 637 638 639 640 641 642
            append(default)
    return l

def _bcd2str(bcd):

    return hex(bcd)[2:]

643 644
def _mac_ver_gestalt():
    """
645 646 647 648 649 650 651 652
        Thanks to Mark R. Levinson for mailing documentation links and
        code examples for this function. Documentation for the
        gestalt() API is available online at:

           http://www.rgaros.nl/gestalt/
    """
    # Check whether the version info module is available
    try:
653
        import _gestalt
654
    except ImportError:
655
        return None
656
    # Get the infos
657
    sysv, sysa = _mac_ver_lookup(('sysv','sysa'))
658 659 660 661 662
    # Decode the infos
    if sysv:
        major = (sysv & 0xFF00) >> 8
        minor = (sysv & 0x00F0) >> 4
        patch = (sysv & 0x000F)
663 664 665 666 667 668 669 670 671 672 673

        if (major, minor) >= (10, 4):
            # the 'sysv' gestald cannot return patchlevels
            # higher than 9. Apple introduced 3 new
            # gestalt codes in 10.4 to deal with this
            # issue (needed because patch levels can
            # run higher than 9, such as 10.4.11)
            major,minor,patch = _mac_ver_lookup(('sys1','sys2','sys3'))
            release = '%i.%i.%i' %(major, minor, patch)
        else:
            release = '%s.%i.%i' % (_bcd2str(major),minor,patch)
674

675
    if sysa:
Tim Peters's avatar
Tim Peters committed
676
        machine = {0x1: '68k',
677 678
                   0x2: 'PowerPC',
                   0xa: 'i386'}.get(sysa,'')
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695

    return release,versioninfo,machine

def _mac_ver_xml():
    fn = '/System/Library/CoreServices/SystemVersion.plist'
    if not os.path.exists(fn):
        return None

    try:
        import plistlib
    except ImportError:
        return None

    pl = plistlib.readPlist(fn)
    release = pl['ProductVersion']
    versioninfo=('', '', '')
    machine = os.uname()[4]
696
    if machine in ('ppc', 'Power Macintosh'):
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
        # for compatibility with the gestalt based code
        machine = 'PowerPC'

    return release,versioninfo,machine


def mac_ver(release='',versioninfo=('','',''),machine=''):

    """ 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 paramter values
        which default to ''. All tuple entries are strings.
    """

    # First try reading the information from an XML file which should
    # always be present
    info = _mac_ver_xml()
    if info is not None:
        return info

    # If that doesn't work for some reason fall back to reading the
    # information using gestalt calls.
    info = _mac_ver_gestalt()
    if info is not None:
        return info

    # If that also doesn't work return the default values
726 727
    return release,versioninfo,machine

728
def _java_getprop(name,default):
729 730 731

    from java.lang import System
    try:
732 733 734 735 736
        value = System.getProperty(name)
        if value is None:
            return default
        return value
    except AttributeError:
737 738 739
        return default

def java_ver(release='',vendor='',vminfo=('','',''),osinfo=('','','')):
Tim Peters's avatar
Tim Peters committed
740

Brett Cannon's avatar
Brett Cannon committed
741
    """ Version interface for Jython.
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756

        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 '').

    """
    # Import the needed APIs
    try:
        import java.lang
    except ImportError:
        return release,vendor,vminfo,osinfo

757 758 759 760 761 762 763 764 765 766 767 768 769 770
    vendor = _java_getprop('java.vendor', vendor)
    release = _java_getprop('java.version', release)
    vm_name, vm_release, vm_vendor = vminfo
    vm_name = _java_getprop('java.vm.name', vm_name)
    vm_vendor = _java_getprop('java.vm.vendor', vm_vendor)
    vm_release = _java_getprop('java.vm.version', vm_release)
    vminfo = vm_name, vm_release, vm_vendor
    os_name, os_version, os_arch = osinfo
    os_arch = _java_getprop('java.os.arch', os_arch)
    os_name = _java_getprop('java.os.name', os_name)
    os_version = _java_getprop('java.os.version', os_version)
    osinfo = os_name, os_version, os_arch

    return release, vendor, vminfo, osinfo
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793

### System name aliasing

def system_alias(system,release,version):

    """ 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.

    """
    if system == 'Rhapsody':
        # Apple's BSD derivative
        # XXX How can we determine the marketing release number ?
        return 'MacOS X Server',system+release,version

    elif system == 'SunOS':
        # Sun's OS
        if release < '5':
            # These releases use the old name SunOS
            return system,release,version
        # Modify release (marketing release = SunOS release - 3)
794
        l = release.split('.')
795 796 797 798 799 800 801 802
        if l:
            try:
                major = int(l[0])
            except ValueError:
                pass
            else:
                major = major - 3
                l[0] = str(major)
803
                release = '.'.join(l)
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
        if release < '6':
            system = 'Solaris'
        else:
            # XXX Whatever the new SunOS marketing name is...
            system = 'Solaris'

    elif system == 'IRIX64':
        # IRIX reports IRIX64 on platforms with 64-bit support; yet it
        # is really a version and not a different platform, since 32-bit
        # apps are also supported..
        system = 'IRIX'
        if version:
            version = version + ' (64bit)'
        else:
            version = '64bit'

    elif system in ('win32','win16'):
        # In case one of the other tricks
        system = 'Windows'

    return system,release,version

### Various internal helpers

def _platform(*args):

    """ Helper to format the platform string in a filename
        compatible format e.g. "system-version-machine".
    """
    # Format the platform string
834
    platform = '-'.join(x.strip() for x in filter(len, args))
835 836

    # Cleanup some possible filename obstacles...
837 838 839 840 841 842 843 844
    platform = platform.replace(' ','_')
    platform = platform.replace('/','-')
    platform = platform.replace('\\','-')
    platform = platform.replace(':','-')
    platform = platform.replace(';','-')
    platform = platform.replace('"','-')
    platform = platform.replace('(','-')
    platform = platform.replace(')','-')
845 846

    # No need to report 'unknown' information...
847
    platform = platform.replace('unknown','')
848 849 850

    # Fold '--'s and remove trailing '-'
    while 1:
851
        cleaned = platform.replace('--','-')
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
        if cleaned == platform:
            break
        platform = cleaned
    while platform[-1] == '-':
        platform = platform[:-1]

    return platform

def _node(default=''):

    """ Helper to determine the node name of this machine.
    """
    try:
        import socket
    except ImportError:
        # No sockets...
        return default
    try:
        return socket.gethostname()
    except socket.error:
        # Still not working...
        return default

def _follow_symlinks(filepath):

    """ In case filepath is a symlink, follow it until a
        real file is reached.
    """
Georg Brandl's avatar
Georg Brandl committed
880
    filepath = os.path.abspath(filepath)
881 882
    while os.path.islink(filepath):
        filepath = os.path.normpath(
883
            os.path.join(os.path.dirname(filepath),os.readlink(filepath)))
884 885 886 887 888 889 890 891 892 893
    return filepath

def _syscmd_uname(option,default=''):

    """ Interface to the system's uname command.
    """
    if sys.platform in ('dos','win32','win16','os2'):
        # XXX Others too ?
        return default
    try:
894
        f = os.popen('uname %s 2> %s' % (option, DEV_NULL))
895 896
    except (AttributeError,os.error):
        return default
897
    output = f.read().strip()
898 899 900 901 902 903 904 905 906 907 908
    rc = f.close()
    if not output or rc:
        return default
    else:
        return output

def _syscmd_file(target,default=''):

    """ Interface to the system's file command.

        The function uses the -b option of the file command to have it
909 910
        omit the filename in its output. Follow the symlinks. It returns
        default in case the command should fail.
911 912

    """
913 914 915
    if sys.platform in ('dos','win32','win16','os2'):
        # XXX Others too ?
        return default
916
    target = _follow_symlinks(target).replace('"', '\\"')
917
    try:
918
        f = os.popen('file -b "%s" 2> %s' % (target, DEV_NULL))
919 920
    except (AttributeError,os.error):
        return default
921 922
    output = f.read().strip()
    rc = f.close()
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
    if not output or rc:
        return default
    else:
        return output

### Information about the used architecture

# Default values for architecture; non-empty strings override the
# defaults given as parameters
_default_architecture = {
    'win32': ('','WindowsPE'),
    'win16': ('','Windows'),
    'dos': ('','MSDOS'),
}

938
def architecture(executable=sys.executable,bits='',linkage=''):
939 940

    """ Queries the given executable (defaults to the Python interpreter
Brett Cannon's avatar
Brett Cannon committed
941
        binary) for various architecture information.
942

Brett Cannon's avatar
Brett Cannon committed
943
        Returns a tuple (bits,linkage) which contains information about
944 945 946 947 948 949 950 951 952 953
        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
Brett Cannon's avatar
Brett Cannon committed
954 955 956
        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.
957 958 959 960 961 962 963 964 965 966 967 968

    """
    # Use the sizeof(pointer) as default number of bits if nothing
    # else is given as default.
    if not bits:
        import struct
        try:
            size = struct.calcsize('P')
        except struct.error:
            # Older installations can only query longs
            size = struct.calcsize('l')
        bits = str(size*8) + 'bit'
Tim Peters's avatar
Tim Peters committed
969

970
    # Get data from the 'file' system command
971
    if executable:
972
        fileout = _syscmd_file(executable, '')
973
    else:
974
        fileout = ''
975

976
    if not fileout and \
977 978
       executable == sys.executable:
        # "file" command did not return anything; we'll try to provide
Tim Peters's avatar
Tim Peters committed
979
        # some sensible defaults then...
980
        if sys.platform in _default_architecture:
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
            b,l = _default_architecture[sys.platform]
            if b:
                bits = b
            if l:
                linkage = l
        return bits,linkage

    if 'executable' not in fileout:
        # Format not supported
        return bits,linkage

    # Bits
    if '32-bit' in fileout:
        bits = '32bit'
    elif 'N32' in fileout:
        # On Irix only
        bits = 'n32bit'
    elif '64-bit' in fileout:
        bits = '64bit'

    # Linkage
    if 'ELF' in fileout:
        linkage = 'ELF'
    elif 'PE' in fileout:
        # E.g. Windows uses this format
        if 'Windows' in fileout:
            linkage = 'WindowsPE'
        else:
            linkage = 'PE'
    elif 'COFF' in fileout:
        linkage = 'COFF'
    elif 'MS-DOS' in fileout:
        linkage = 'MSDOS'
    else:
        # XXX the A.OUT format also falls under this class...
        pass

    return bits,linkage

### Portable uname() interface
Tim Peters's avatar
Tim Peters committed
1021

1022 1023 1024 1025 1026 1027 1028 1029 1030
_uname_cache = None

def uname():

    """ 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
Brett Cannon's avatar
Brett Cannon committed
1031
        possible processor information as an additional tuple entry.
1032 1033 1034 1035 1036

        Entries which cannot be determined are set to ''.

    """
    global _uname_cache
Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1037
    no_os_uname = 0
1038 1039 1040 1041

    if _uname_cache is not None:
        return _uname_cache

Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1042 1043
    processor = ''

1044 1045 1046 1047
    # Get some infos from the builtin os.uname API...
    try:
        system,node,release,version,machine = os.uname()
    except AttributeError:
Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1048 1049
        no_os_uname = 1

1050
    if no_os_uname or not list(filter(None, (system, node, release, version, machine))):
Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1051 1052 1053 1054 1055 1056 1057 1058 1059
        # Hmm, no there is either no uname or uname has returned
        #'unknowns'... we'll have to poke around the system then.
        if no_os_uname:
            system = sys.platform
            release = ''
            version = ''
            node = _node()
            machine = ''

1060
        use_syscmd_ver = 1
1061 1062 1063 1064 1065 1066

        # Try win32_ver() on win32 platforms
        if system == 'win32':
            release,version,csd,ptype = win32_ver()
            if release and version:
                use_syscmd_ver = 0
1067
            # Try to use the PROCESSOR_* environment variables
1068 1069 1070
            # available on Win XP and later; see
            # http://support.microsoft.com/kb/888731 and
            # http://www.geocities.com/rick_lively/MANUALS/ENV/MSWIN/PROCESSI.HTM
Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1071
            if not machine:
1072 1073 1074 1075 1076
                # WOW64 processes mask the native architecture
                if "PROCESSOR_ARCHITEW6432" in os.environ:
                    machine = os.environ.get("PROCESSOR_ARCHITEW6432", '')
                else:
                    machine = os.environ.get('PROCESSOR_ARCHITECTURE', '')
Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1077 1078
            if not processor:
                processor = os.environ.get('PROCESSOR_IDENTIFIER', machine)
Tim Peters's avatar
Tim Peters committed
1079

1080 1081 1082 1083
        # Try the 'ver' system command available on some
        # platforms
        if use_syscmd_ver:
            system,release,version = _syscmd_ver(system)
1084 1085 1086 1087
            # Normalize system to what win32_ver() normally returns
            # (_syscmd_ver() tends to return the vendor name as well)
            if system == 'Microsoft Windows':
                system = 'Windows'
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
            elif system == 'Microsoft' and release == 'Windows':
                # Under Windows Vista and Windows Server 2008,
                # Microsoft changed the output of the ver command. The
                # release is no longer printed.  This causes the
                # system and release to be misidentified.
                system = 'Windows'
                if '6.0' == version[:3]:
                    release = 'Vista'
                else:
                    release = ''
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111

        # In case we still don't know anything useful, we'll try to
        # help ourselves
        if system in ('win32','win16'):
            if not version:
                if system == 'win32':
                    version = '32bit'
                else:
                    version = '16bit'
            system = 'Windows'

        elif system[:4] == 'java':
            release,vendor,vminfo,osinfo = java_ver()
            system = 'Java'
1112
            version = ', '.join(vminfo)
1113 1114 1115
            if not version:
                version = vendor

Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
    # System specific extensions
    if system == 'OpenVMS':
        # OpenVMS seems to have release and version mixed up
        if not release or release == '0':
            release = version
            version = ''
        # Get processor information
        try:
            import vms_lib
        except ImportError:
            pass
1127
        else:
Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1128 1129 1130 1131 1132 1133 1134 1135
            csid, cpu_number = vms_lib.getsyi('SYI$_CPU',0)
            if (cpu_number >= 128):
                processor = 'Alpha'
            else:
                processor = 'VAX'
    if not processor:
        # Get processor information from the uname system command
        processor = _syscmd_uname('-p','')
1136

Amaury Forgeot d'Arc's avatar
Amaury Forgeot d'Arc committed
1137
    #If any unknowns still exist, replace them with ''s, which are more portable
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    if system == 'unknown':
        system = ''
    if node == 'unknown':
        node = ''
    if release == 'unknown':
        release = ''
    if version == 'unknown':
        version = ''
    if machine == 'unknown':
        machine = ''
    if processor == 'unknown':
        processor = ''
1150 1151 1152 1153 1154 1155

    #  normalize name
    if system == 'Microsoft' and release == 'Windows':
        system = 'Windows'
        release = 'Vista'

1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
    _uname_cache = system,node,release,version,machine,processor
    return _uname_cache

### Direct interfaces to some of the uname() return values

def system():

    """ Returns the system/OS name, e.g. 'Linux', 'Windows' or 'Java'.

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

    """
    return uname()[0]

def node():

Brett Cannon's avatar
Brett Cannon committed
1172 1173
    """ Returns the computer's network name (which may not be fully
        qualified)
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220

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

    """
    return uname()[1]

def release():

    """ Returns the system's release, e.g. '2.2.0' or 'NT'

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

    """
    return uname()[2]

def version():

    """ Returns the system's release version, e.g. '#3 on degas'

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

    """
    return uname()[3]

def machine():

    """ Returns the machine type, e.g. 'i386'

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

    """
    return uname()[4]

def processor():

    """ 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.

    """
    return uname()[5]

### Various APIs for extracting information from sys.version

1221 1222 1223
_sys_version_parser = re.compile(
    r'([\w.+]+)\s*'
    '\(#?([^,]+),\s*([\w ]+),\s*([\w :]+)\)\s*'
1224
    '\[([^\]]+)\]?', re.ASCII)
1225 1226 1227 1228 1229

_ironpython_sys_version_parser = re.compile(
    r'IronPython\s*'
    '([\d\.]+)'
    '(?: \(([\d\.]+)\))?'
1230
    ' on (.NET [\d\.]+)', re.ASCII)
1231

Benjamin Peterson's avatar
Benjamin Peterson committed
1232 1233 1234 1235 1236
_pypy_sys_version_parser = re.compile(
    r'([\w.+]+)\s*'
    '\(#?([^,]+),\s*([\w ]+),\s*([\w :]+)\)\s*'
    '\[PyPy [^\]]+\]?')

1237 1238 1239
_sys_version_cache = {}

def _sys_version(sys_version=None):
1240 1241

    """ Returns a parsed version of Python's sys.version as tuple
1242 1243 1244 1245
        (name, version, branch, revision, buildno, builddate, compiler)
        referring to the Python implementation name, version, branch,
        revision, build number, build date/time as string and the compiler
        identification string.
1246 1247 1248 1249 1250

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

1251 1252 1253 1254 1255 1256 1257
        The function returns empty strings for tuple entries that
        cannot be determined.

        sys_version may be given to parse an alternative version
        string, e.g. if the version was read from a different Python
        interpreter.

1258
    """
1259 1260 1261
    # Get the Python version
    if sys_version is None:
        sys_version = sys.version
1262

1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
    # Try the cache first
    result = _sys_version_cache.get(sys_version, None)
    if result is not None:
        return result

    # Parse it
    if sys_version[:10] == 'IronPython':
        # IronPython
        name = 'IronPython'
        match = _ironpython_sys_version_parser.match(sys_version)
        if match is None:
            raise ValueError(
                'failed to parse IronPython sys.version: %s' %
                repr(sys_version))
        version, alt_version, compiler = match.groups()
        buildno = ''
        builddate = ''

    elif sys.platform[:4] == 'java':
        # Jython
        name = 'Jython'
Benjamin Peterson's avatar
Benjamin Peterson committed
1284
        match = _sys_version_parser.match(sys_version)
1285 1286 1287 1288
        if match is None:
            raise ValueError(
                'failed to parse Jython sys.version: %s' %
                repr(sys_version))
Benjamin Peterson's avatar
Benjamin Peterson committed
1289
        version, buildno, builddate, buildtime, _ = match.groups()
1290
        compiler = sys.platform
Benjamin Peterson's avatar
Benjamin Peterson committed
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300

    elif "PyPy" in sys_version:
        # PyPy
        name = "PyPy"
        match = _pypy_sys_version_parser.match(sys_version)
        if match is None:
            raise ValueError("failed to parse PyPy sys.version: %s" %
                             repr(sys_version))
        version, buildno, builddate, buildtime = match.groups()
        compiler = ""
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310

    else:
        # CPython
        match = _sys_version_parser.match(sys_version)
        if match is None:
            raise ValueError(
                'failed to parse CPython sys.version: %s' %
                repr(sys_version))
        version, buildno, builddate, buildtime, compiler = \
              match.groups()
Benjamin Peterson's avatar
Benjamin Peterson committed
1311
        name = 'CPython'
1312 1313
        builddate = builddate + ' ' + buildtime

Benjamin Peterson's avatar
Benjamin Peterson committed
1314 1315 1316 1317 1318 1319 1320
    if hasattr(sys, 'subversion'):
        # sys.subversion was added in Python 2.5
        _, branch, revision = sys.subversion
    else:
        branch = ''
        revision = ''

1321
    # Add the patchlevel version if missing
1322
    l = version.split('.')
1323 1324
    if len(l) == 2:
        l.append('0')
1325
        version = '.'.join(l)
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342

    # Build and cache the result
    result = (name, version, branch, revision, buildno, builddate, compiler)
    _sys_version_cache[sys_version] = result
    return result

def python_implementation():

    """ 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).

    """
    return _sys_version()[0]
1343 1344 1345 1346 1347 1348 1349 1350 1351

def python_version():

    """ 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).

    """
1352
    return _sys_version()[1]
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362

def python_version_tuple():

    """ 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).

    """
1363
    return tuple(_sys_version()[1].split('.'))
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375

def python_branch():

    """ 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.

    """
1376

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
    return _sys_version()[2]

def python_revision():

    """ 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.

    """
    return _sys_version()[3]
1391 1392 1393 1394 1395 1396 1397

def python_build():

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

    """
1398
    return _sys_version()[4:6]
1399 1400 1401 1402 1403 1404 1405

def python_compiler():

    """ Returns a string identifying the compiler used for compiling
        Python.

    """
1406
    return _sys_version()[6]
1407 1408 1409

### The Opus Magnum of platform strings :-)

1410
_platform_cache = {}
1411 1412 1413 1414 1415

def platform(aliased=0, terse=0):

    """ Returns a single string identifying the underlying platform
        with as much useful information as possible (but no more :).
Tim Peters's avatar
Tim Peters committed
1416

1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
        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.

    """
1431 1432 1433
    result = _platform_cache.get((aliased, terse), None)
    if result is not None:
        return result
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466

    # Get uname information and then apply platform specific cosmetics
    # to it...
    system,node,release,version,machine,processor = uname()
    if machine == processor:
        processor = ''
    if aliased:
        system,release,version = system_alias(system,release,version)

    if system == 'Windows':
        # MS platforms
        rel,vers,csd,ptype = win32_ver(version)
        if terse:
            platform = _platform(system,release)
        else:
            platform = _platform(system,release,version,csd)

    elif system in ('Linux',):
        # Linux based systems
        distname,distversion,distid = dist('')
        if distname and not terse:
            platform = _platform(system,release,machine,processor,
                                 'with',
                                 distname,distversion,distid)
        else:
            # If the distribution name is unknown check for libc vs. glibc
            libcname,libcversion = libc_ver(sys.executable)
            platform = _platform(system,release,machine,processor,
                                 'with',
                                 libcname+libcversion)
    elif system == 'Java':
        # Java platforms
        r,v,vminfo,(os_name,os_version,os_arch) = java_ver()
1467
        if terse or not os_name:
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
            platform = _platform(system,release,version)
        else:
            platform = _platform(system,release,version,
                                 'on',
                                 os_name,os_version,os_arch)

    elif system == 'MacOS':
        # MacOS platforms
        if terse:
            platform = _platform(system,release)
        else:
            platform = _platform(system,release,machine)

    else:
        # Generic handler
        if terse:
            platform = _platform(system,release)
        else:
            bits,linkage = architecture(sys.executable)
            platform = _platform(system,release,machine,processor,bits,linkage)
Tim Peters's avatar
Tim Peters committed
1488

1489
    _platform_cache[(aliased, terse)] = platform
1490 1491 1492 1493 1494 1495
    return platform

### Command line interface

if __name__ == '__main__':
    # Default is to print the aliased verbose platform string
Tim Peters's avatar
Tim Peters committed
1496
    terse = ('terse' in sys.argv or '--terse' in sys.argv)
1497
    aliased = (not 'nonaliased' in sys.argv and not '--nonaliased' in sys.argv)
1498
    print(platform(aliased,terse))
1499
    sys.exit(0)