3 """ This module tries to retrieve as much platform-identifying data as
4 possible. It makes this information available via function APIs.
6 If called from the command line, it prints the platform
7 information concatenated as single string to stdout. The output
8 format is useable as part of a filename.
11 # This module is maintained by Marc-Andre Lemburg <mal@egenix.com>.
12 # If you find problems, please submit bug reports/patches via the
13 # Python SourceForge Project Page and assign them to "lemburg".
15 # Note: Please keep this module compatible to Python 1.5.2.
18 # * more support for WinCE
19 # * support for MS-DOS (PythonDX ?)
20 # * support for Amiga and other still unsupported platforms running Python
21 # * support for additional Linux distributions
23 # Many thanks to all those who helped adding platform-specific
24 # checks (in no particular order):
26 # Charles G Waldman, David Arnold, Gordon McMillan, Ben Darnell,
27 # Jeff Bauer, Cliff Crawford, Ivan Van Laningham, Josef
28 # Betancourt, Randall Hopper, Karl Putland, John Farrell, Greg
29 # Andruk, Just van Rossum, Thomas Heller, Mark R. Levinson, Mark
30 # Hammond, Bill Tutt, Hans Nowak, Uwe Zessin (OpenVMS support),
31 # Colin Kong, Trent Mick, Guido van Rossum, Anthony Baxter
35 # <see CVS and SVN checkin messages for history>
37 # 1.0.6 - added linux_distribution()
38 # 1.0.5 - fixed Java support to allow running the module on Jython
39 # 1.0.4 - added IronPython support
40 # 1.0.3 - added normalization of Windows system name
41 # 1.0.2 - added more Windows support
42 # 1.0.1 - reformatted to make doc.py happy
43 # 1.0.0 - reformatted a bit and checked into Python CVS
44 # 0.8.0 - added sys.version parser and various new access
45 # APIs (python_version(), python_compiler(), etc.)
46 # 0.7.2 - fixed architecture() to use sizeof(pointer) where available
47 # 0.7.1 - added support for Caldera OpenLinux
48 # 0.7.0 - some fixes for WinCE; untabified the source file
49 # 0.6.2 - support for OpenVMS - requires version 1.5.2-V006 or higher and
50 # vms_lib.getsyi() configured
51 # 0.6.1 - added code to prevent 'uname -p' on platforms which are
52 # known not to support it
53 # 0.6.0 - fixed win32_ver() to hopefully work on Win95,98,NT and Win2k;
54 # did some cleanup of the interfaces - some APIs have changed
55 # 0.5.5 - fixed another type in the MacOS code... should have
56 # used more coffee today ;-)
57 # 0.5.4 - fixed a few typos in the MacOS code
58 # 0.5.3 - added experimental MacOS support; added better popen()
59 # workarounds in _syscmd_ver() -- still not 100% elegant
61 # 0.5.2 - fixed uname() to return '' instead of 'unknown' in all
62 # return values (the system uname command tends to return
63 # 'unknown' instead of just leaving the field emtpy)
64 # 0.5.1 - included code for slackware dist; added exception handlers
65 # to cover up situations where platforms don't have os.popen
66 # (e.g. Mac) or fail on socket.gethostname(); fixed libc
68 # 0.5.0 - changed the API names referring to system commands to *syscmd*;
69 # added java_ver(); made syscmd_ver() a private
70 # API (was system_ver() in previous versions) -- use uname()
71 # instead; extended the win32_ver() to also return processor
73 # 0.4.0 - added win32_ver() and modified the platform() output for WinXX
74 # 0.3.4 - fixed a bug in _follow_symlinks()
75 # 0.3.3 - fixed popen() and "file" command invokation bugs
76 # 0.3.2 - added architecture() API and support for it in platform()
77 # 0.3.1 - fixed syscmd_ver() RE to support Windows NT
78 # 0.3.0 - added system alias support
79 # 0.2.3 - removed 'wince' again... oh well.
80 # 0.2.2 - added 'wince' to syscmd_ver() supported platforms
81 # 0.2.1 - added cache logic and changed the platform string format
82 # 0.2.0 - changed the API to use functions instead of module globals
83 # since some action take too long to be run on module import
84 # 0.1.0 - first release
86 # You can always get the latest version of this module at:
88 # http://www.egenix.com/files/python/platform.py
90 # If that URL should fail, try contacting the author.
93 Copyright (c) 1999-2000, Marc-Andre Lemburg; mailto:mal@lemburg.com
94 Copyright (c) 2000-2008, eGenix.com Software GmbH; mailto:info@egenix.com
96 Permission to use, copy, modify, and distribute this software and its
97 documentation for any purpose and without fee or royalty is hereby granted,
98 provided that the above copyright notice appear in all copies and that
99 both that copyright notice and this permission notice appear in
100 supporting documentation or portions thereof, including modifications,
103 EGENIX.COM SOFTWARE GMBH DISCLAIMS ALL WARRANTIES WITH REGARD TO
104 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
105 FITNESS, IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL,
106 INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
107 FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
108 NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
109 WITH THE USE OR PERFORMANCE OF THIS SOFTWARE !
113 __version__
= '1.0.6'
115 import sys
,string
,os
,re
117 ### Platform specific APIs
119 _libc_search
= re
.compile(r
'(__libc_init)'
123 '(libc(_\w+)?\.so(?:\.(\d[0-9.]*))?)')
125 def libc_ver(executable
=sys
.executable
,lib
='',version
='',
129 """ Tries to determine the libc version that the file executable
130 (which defaults to the Python interpreter) is linked against.
132 Returns a tuple of strings (lib,version) which default to the
133 given parameters in case the lookup fails.
135 Note that the function has intimate knowledge of how different
136 libc versions add symbols to the executable and thus is probably
137 only useable for executables compiled using gcc.
139 The file is read and scanned in chunks of chunksize bytes.
142 if hasattr(os
.path
, 'realpath'):
143 # Python 2.2 introduced os.path.realpath(); it is used
144 # here to work around problems with Cygwin not being
145 # able to open symlinks for reading
146 executable
= os
.path
.realpath(executable
)
147 f
= open(executable
,'rb')
148 binary
= f
.read(chunksize
)
151 m
= _libc_search
.search(binary
,pos
)
153 binary
= f
.read(chunksize
)
158 libcinit
,glibc
,glibcversion
,so
,threads
,soversion
= m
.groups()
159 if libcinit
and not lib
:
164 version
= glibcversion
165 elif glibcversion
> version
:
166 version
= glibcversion
170 if soversion
> version
:
172 if threads
and version
[-len(threads
):] != threads
:
173 version
= version
+ threads
178 def _dist_try_harder(distname
,version
,id):
180 """ Tries some special tricks to get the distribution
181 information in case the default method fails.
183 Currently supports older SuSE Linux, Caldera OpenLinux and
184 Slackware Linux distributions.
187 if os
.path
.exists('/var/adm/inst-log/info'):
188 # SuSE Linux stores distribution information in that file
189 info
= open('/var/adm/inst-log/info').readlines()
192 tv
= string
.split(line
)
197 if tag
== 'MIN_DIST_VERSION':
198 version
= string
.strip(value
)
199 elif tag
== 'DIST_IDENT':
200 values
= string
.split(value
,'-')
202 return distname
,version
,id
204 if os
.path
.exists('/etc/.installed'):
205 # Caldera OpenLinux has some infos in that file (thanks to Colin Kong)
206 info
= open('/etc/.installed').readlines()
208 pkg
= string
.split(line
,'-')
209 if len(pkg
) >= 2 and pkg
[0] == 'OpenLinux':
210 # XXX does Caldera support non Intel platforms ? If yes,
211 # where can we find the needed id ?
212 return 'OpenLinux',pkg
[1],id
214 if os
.path
.isdir('/usr/lib/setup'):
215 # Check for slackware verson tag file (thanks to Greg Andruk)
216 verfiles
= os
.listdir('/usr/lib/setup')
217 for n
in range(len(verfiles
)-1, -1, -1):
218 if verfiles
[n
][:14] != 'slack-version-':
222 distname
= 'slackware'
223 version
= verfiles
[-1][14:]
224 return distname
,version
,id
226 return distname
,version
,id
228 _release_filename
= re
.compile(r
'(\w+)[-_](release|version)')
229 _lsb_release_version
= re
.compile(r
'(.+)'
232 '[^(]*(?:\((.+)\))?')
233 _release_version
= re
.compile(r
'([^0-9]+)'
236 '[^(]*(?:\((.+)\))?')
238 # See also http://www.novell.com/coolsolutions/feature/11251.html
239 # and http://linuxmafia.com/faq/Admin/release-files.html
240 # and http://data.linux-ntfs.org/rpm/whichrpm
241 # and http://www.die.net/doc/linux/man/man1/lsb_release.1.html
244 'SuSE', 'debian', 'fedora', 'redhat', 'centos',
245 'mandrake', 'mandriva', 'rocks', 'slackware', 'yellowdog', 'gentoo',
246 'UnitedLinux', 'turbolinux')
248 def _parse_release_file(firstline
):
250 # Parse the first line
251 m
= _lsb_release_version
.match(firstline
)
253 # LSB format: "distro release x.x (codename)"
254 return tuple(m
.groups())
256 # Pre-LSB format: "distro x.x (codename)"
257 m
= _release_version
.match(firstline
)
259 return tuple(m
.groups())
261 # Unkown format... take the first two words
262 l
= string
.split(string
.strip(firstline
))
269 return '', version
, id
271 def _test_parse_release_file():
273 for input, output
in (
274 # Examples of release file contents:
275 ('SuSE Linux 9.3 (x86-64)', ('SuSE Linux ', '9.3', 'x86-64'))
276 ('SUSE LINUX 10.1 (X86-64)', ('SUSE LINUX ', '10.1', 'X86-64'))
277 ('SUSE LINUX 10.1 (i586)', ('SUSE LINUX ', '10.1', 'i586'))
278 ('Fedora Core release 5 (Bordeaux)', ('Fedora Core', '5', 'Bordeaux'))
279 ('Red Hat Linux release 8.0 (Psyche)', ('Red Hat Linux', '8.0', 'Psyche'))
280 ('Red Hat Linux release 9 (Shrike)', ('Red Hat Linux', '9', 'Shrike'))
281 ('Red Hat Enterprise Linux release 4 (Nahant)', ('Red Hat Enterprise Linux', '4', 'Nahant'))
282 ('CentOS release 4', ('CentOS', '4', None))
283 ('Rocks release 4.2.1 (Cydonia)', ('Rocks', '4.2.1', 'Cydonia'))
285 parsed
= _parse_release_file(input)
287 print (input, parsed
)
289 def linux_distribution(distname
='', version
='', id='',
291 supported_dists
=_supported_dists
,
292 full_distribution_name
=1):
294 """ Tries to determine the name of the Linux OS distribution name.
296 The function first looks for a distribution release file in
297 /etc and then reverts to _dist_try_harder() in case no
298 suitable files are found.
300 supported_dists may be given to define the set of Linux
301 distributions to look for. It defaults to a list of currently
302 supported Linux distributions identified by their release file
305 If full_distribution_name is true (default), the full
306 distribution read from the OS is returned. Otherwise the short
307 name taken from supported_dists is used.
309 Returns a tuple (distname,version,id) which default to the
310 args given as parameters.
314 etc
= os
.listdir('/etc')
316 # Probably not a Unix system
317 return distname
,version
,id
320 m
= _release_filename
.match(file)
322 _distname
,dummy
= m
.groups()
323 if _distname
in supported_dists
:
327 return _dist_try_harder(distname
,version
,id)
329 # Read the first line
330 f
= open('/etc/'+file, 'r')
331 firstline
= f
.readline()
333 _distname
, _version
, _id
= _parse_release_file(firstline
)
335 if _distname
and full_distribution_name
:
341 return distname
, version
, id
343 # To maintain backwards compatibility:
345 def dist(distname
='',version
='',id='',
347 supported_dists
=_supported_dists
):
349 """ Tries to determine the name of the Linux OS distribution name.
351 The function first looks for a distribution release file in
352 /etc and then reverts to _dist_try_harder() in case no
353 suitable files are found.
355 Returns a tuple (distname,version,id) which default to the
356 args given as parameters.
359 return linux_distribution(distname
, version
, id,
360 supported_dists
=supported_dists
,
361 full_distribution_name
=0)
365 """ Fairly portable (alternative) popen implementation.
367 This is mostly needed in case os.popen() is not available, or
368 doesn't work as advertised, e.g. in Win9X GUI programs like
371 Writing to the pipe is currently not supported.
379 def __init__(self
,cmd
,mode
='r',bufsize
=None):
382 raise ValueError,'popen()-emulation only supports read mode'
384 self
.tmpfile
= tmpfile
= tempfile
.mktemp()
385 os
.system(cmd
+ ' > %s' % tmpfile
)
386 self
.pipe
= open(tmpfile
,'rb')
387 self
.bufsize
= bufsize
392 return self
.pipe
.read()
396 if self
.bufsize
is not None:
397 return self
.pipe
.readlines()
401 remove
=os
.unlink
,error
=os
.error
):
404 rc
= self
.pipe
.close()
417 def popen(cmd
, mode
='r', bufsize
=None):
419 """ Portable popen() interface.
421 # Find a working popen implementation preferring win32pipe.popen
422 # over os.popen over _popen
424 if os
.environ
.get('OS','') == 'Windows_NT':
425 # On NT win32pipe should work; on Win9x it hangs due to bugs
426 # in the MS C lib (see MS KnowledgeBase article Q150956)
432 popen
= win32pipe
.popen
434 if hasattr(os
,'popen'):
436 # Check whether it works... it doesn't in GUI programs
437 # on Windows platforms
438 if sys
.platform
== 'win32': # XXX Others too ?
446 return popen(cmd
,mode
)
448 return popen(cmd
,mode
,bufsize
)
450 def _norm_version(version
, build
=''):
452 """ Normalize the version and build strings and return a single
453 version string using the format major.minor.build (or patchlevel).
455 l
= string
.split(version
,'.')
463 strings
= map(str,ints
)
464 version
= string
.join(strings
[:3],'.')
467 _ver_output
= re
.compile(r
'(?:([\w ]+) ([\w.]+) '
471 def _syscmd_ver(system
='', release
='', version
='',
473 supported_platforms
=('win32','win16','dos','os2')):
475 """ Tries to figure out the OS version used and returns
476 a tuple (system,release,version).
478 It uses the "ver" shell command for this which is known
479 to exists on Windows, DOS and OS/2. XXX Others too ?
481 In case this fails, the given parameters are used as
485 if sys
.platform
not in supported_platforms
:
486 return system
,release
,version
488 # Try some common cmd strings
489 for cmd
in ('ver','command /c ver','cmd /c ver'):
494 raise os
.error
,'command failed'
495 # XXX How can I supress shell errors from being written
498 #print 'Command %s failed: %s' % (cmd,why)
501 #print 'Command %s failed: %s' % (cmd,why)
506 return system
,release
,version
509 info
= string
.strip(info
)
510 m
= _ver_output
.match(info
)
512 system
,release
,version
= m
.groups()
513 # Strip trailing dots from version and release
514 if release
[-1] == '.':
515 release
= release
[:-1]
516 if version
[-1] == '.':
517 version
= version
[:-1]
518 # Normalize the version and build strings (eliminating additional
520 version
= _norm_version(version
)
521 return system
,release
,version
523 def _win32_getvalue(key
,name
,default
=''):
525 """ Read a value for name from the registry key.
527 In case this fails, default is returned.
531 # Use win32api if available
532 from win32api
import RegQueryValueEx
534 # On Python 2.0 and later, emulate using _winreg
536 RegQueryValueEx
= _winreg
.QueryValueEx
538 return RegQueryValueEx(key
,name
)
542 def win32_ver(release
='',version
='',csd
='',ptype
=''):
544 """ Get additional version information from the Windows Registry
545 and return a tuple (version,csd,ptype) referring to version
546 number, CSD level and OS type (multi/single
549 As a hint: ptype returns 'Uniprocessor Free' on single
550 processor NT machines and 'Multiprocessor Free' on multi
551 processor machines. The 'Free' refers to the OS version being
552 free of debugging code. It could also state 'Checked' which
553 means the OS version uses debugging code, i.e. code that
554 checks arguments, ranges, etc. (Thomas Heller).
556 Note: this function works best with Mark Hammond's win32
557 package installed, but also on Python 2.3 and later. It
558 obviously only runs on Win32 compatible platforms.
561 # XXX Is there any way to find out the processor type on WinXX ?
562 # XXX Is win32 available on Windows CE ?
564 # Adapted from code posted by Karl Putland to comp.lang.python.
566 # The mappings between reg. values and release names can be found
567 # here: http://msdn.microsoft.com/library/en-us/sysinfo/base/osversioninfo_str.asp
569 # Import the needed APIs
572 from win32api
import RegQueryValueEx
, RegOpenKeyEx
, \
573 RegCloseKey
, GetVersionEx
574 from win32con
import HKEY_LOCAL_MACHINE
, VER_PLATFORM_WIN32_NT
, \
575 VER_PLATFORM_WIN32_WINDOWS
, VER_NT_WORKSTATION
577 # Emulate the win32api module using Python APIs
579 sys
.getwindowsversion
580 except AttributeError:
581 # No emulation possible, so return the defaults...
582 return release
,version
,csd
,ptype
584 # Emulation using _winreg (added in Python 2.0) and
585 # sys.getwindowsversion() (added in Python 2.3)
587 GetVersionEx
= sys
.getwindowsversion
588 RegQueryValueEx
= _winreg
.QueryValueEx
589 RegOpenKeyEx
= _winreg
.OpenKeyEx
590 RegCloseKey
= _winreg
.CloseKey
591 HKEY_LOCAL_MACHINE
= _winreg
.HKEY_LOCAL_MACHINE
592 VER_PLATFORM_WIN32_WINDOWS
= 1
593 VER_PLATFORM_WIN32_NT
= 2
594 VER_NT_WORKSTATION
= 1
596 # Find out the registry key and some general version infos
597 maj
,min,buildno
,plat
,csd
= GetVersionEx()
598 version
= '%i.%i.%i' % (maj
,min,buildno
& 0xFFFF)
599 if csd
[:13] == 'Service Pack ':
600 csd
= 'SP' + csd
[13:]
601 if plat
== VER_PLATFORM_WIN32_WINDOWS
:
602 regkey
= 'SOFTWARE\\Microsoft\\Windows\\CurrentVersion'
603 # Try to guess the release name
615 elif plat
== VER_PLATFORM_WIN32_NT
:
616 regkey
= 'SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'
625 release
= '2003Server'
630 # Per http://msdn2.microsoft.com/en-us/library/ms724429.aspx
632 productType
= GetVersionEx(1)[8]
634 # sys.getwindowsversion() doesn't take any arguments, so
635 # we cannot detect 2008 Server that way.
636 # XXX Add some other means of detecting 2008 Server ?!
639 if productType
== VER_NT_WORKSTATION
:
642 release
= '2008Server'
644 release
= 'post2008Server'
647 # E.g. Win3.1 with win32s
648 release
= '%i.%i' % (maj
,min)
649 return release
,version
,csd
,ptype
651 # Open the registry key
653 keyCurVer
= RegOpenKeyEx(HKEY_LOCAL_MACHINE
, regkey
)
654 # Get a value to make sure the key exists...
655 RegQueryValueEx(keyCurVer
, 'SystemRoot')
657 return release
,version
,csd
,ptype
660 #subversion = _win32_getvalue(keyCurVer,
661 # 'SubVersionNumber',
664 # release = release + subversion # 95a, 95b, etc.
665 build
= _win32_getvalue(keyCurVer
,
666 'CurrentBuildNumber',
668 ptype
= _win32_getvalue(keyCurVer
,
673 version
= _norm_version(version
,build
)
676 RegCloseKey(keyCurVer
)
677 return release
,version
,csd
,ptype
679 def _mac_ver_lookup(selectors
,default
=None):
681 from gestalt
import gestalt
685 for selector
in selectors
:
687 append(gestalt(selector
))
688 except (RuntimeError, MacOS
.Error
):
696 def mac_ver(release
='',versioninfo
=('','',''),machine
=''):
698 """ Get MacOS version information and return it as tuple (release,
699 versioninfo, machine) with versioninfo being a tuple (version,
700 dev_stage, non_release_version).
702 Entries which cannot be determined are set to the paramter values
703 which default to ''. All tuple entries are strings.
705 Thanks to Mark R. Levinson for mailing documentation links and
706 code examples for this function. Documentation for the
707 gestalt() API is available online at:
709 http://www.rgaros.nl/gestalt/
712 # Check whether the version info module is available
717 return release
,versioninfo
,machine
719 sysv
,sysu
,sysa
= _mac_ver_lookup(('sysv','sysu','sysa'))
722 major
= (sysv
& 0xFF00) >> 8
723 minor
= (sysv
& 0x00F0) >> 4
724 patch
= (sysv
& 0x000F)
726 if (major
, minor
) >= (10, 4):
727 # the 'sysv' gestald cannot return patchlevels
728 # higher than 9. Apple introduced 3 new
729 # gestalt codes in 10.4 to deal with this
730 # issue (needed because patch levels can
731 # run higher than 9, such as 10.4.11)
732 major
,minor
,patch
= _mac_ver_lookup(('sys1','sys2','sys3'))
733 release
= '%i.%i.%i' %(major
, minor
, patch
)
735 release
= '%s.%i.%i' % (_bcd2str(major
),minor
,patch
)
738 # NOTE: this block is left as documentation of the
739 # intention of this function, the 'sysu' gestalt is no
740 # longer available and there are no alternatives.
741 major
= int((sysu
& 0xFF000000L
) >> 24)
742 minor
= (sysu
& 0x00F00000) >> 20
743 bugfix
= (sysu
& 0x000F0000) >> 16
744 stage
= (sysu
& 0x0000FF00) >> 8
745 nonrel
= (sysu
& 0x000000FF)
746 version
= '%s.%i.%i' % (_bcd2str(major
),minor
,bugfix
)
747 nonrel
= _bcd2str(nonrel
)
748 stage
= {0x20:'development',
751 0x80:'final'}.get(stage
,'')
752 versioninfo
= (version
,stage
,nonrel
)
756 machine
= {0x1: '68k',
758 0xa: 'i386'}.get(sysa
,'')
759 return release
,versioninfo
,machine
761 def _java_getprop(name
,default
):
763 from java
.lang
import System
765 value
= System
.getProperty(name
)
769 except AttributeError:
772 def java_ver(release
='',vendor
='',vminfo
=('','',''),osinfo
=('','','')):
774 """ Version interface for Jython.
776 Returns a tuple (release,vendor,vminfo,osinfo) with vminfo being
777 a tuple (vm_name,vm_release,vm_vendor) and osinfo being a
778 tuple (os_name,os_version,os_arch).
780 Values which cannot be determined are set to the defaults
781 given as parameters (which all default to '').
784 # Import the needed APIs
788 return release
,vendor
,vminfo
,osinfo
790 vendor
= _java_getprop('java.vendor', vendor
)
791 release
= _java_getprop('java.version', release
)
792 vm_name
, vm_release
, vm_vendor
= vminfo
793 vm_name
= _java_getprop('java.vm.name', vm_name
)
794 vm_vendor
= _java_getprop('java.vm.vendor', vm_vendor
)
795 vm_release
= _java_getprop('java.vm.version', vm_release
)
796 vminfo
= vm_name
, vm_release
, vm_vendor
797 os_name
, os_version
, os_arch
= osinfo
798 os_arch
= _java_getprop('java.os.arch', os_arch
)
799 os_name
= _java_getprop('java.os.name', os_name
)
800 os_version
= _java_getprop('java.os.version', os_version
)
801 osinfo
= os_name
, os_version
, os_arch
803 return release
, vendor
, vminfo
, osinfo
805 ### System name aliasing
807 def system_alias(system
,release
,version
):
809 """ Returns (system,release,version) aliased to common
810 marketing names used for some systems.
812 It also does some reordering of the information in some cases
813 where it would otherwise cause confusion.
816 if system
== 'Rhapsody':
817 # Apple's BSD derivative
818 # XXX How can we determine the marketing release number ?
819 return 'MacOS X Server',system
+release
,version
821 elif system
== 'SunOS':
824 # These releases use the old name SunOS
825 return system
,release
,version
826 # Modify release (marketing release = SunOS release - 3)
827 l
= string
.split(release
,'.')
836 release
= string
.join(l
,'.')
840 # XXX Whatever the new SunOS marketing name is...
843 elif system
== 'IRIX64':
844 # IRIX reports IRIX64 on platforms with 64-bit support; yet it
845 # is really a version and not a different platform, since 32-bit
846 # apps are also supported..
849 version
= version
+ ' (64bit)'
853 elif system
in ('win32','win16'):
854 # In case one of the other tricks
857 return system
,release
,version
859 ### Various internal helpers
861 def _platform(*args
):
863 """ Helper to format the platform string in a filename
864 compatible format e.g. "system-version-machine".
866 # Format the platform string
867 platform
= string
.join(
872 # Cleanup some possible filename obstacles...
873 replace
= string
.replace
874 platform
= replace(platform
,' ','_')
875 platform
= replace(platform
,'/','-')
876 platform
= replace(platform
,'\\','-')
877 platform
= replace(platform
,':','-')
878 platform
= replace(platform
,';','-')
879 platform
= replace(platform
,'"','-')
880 platform
= replace(platform
,'(','-')
881 platform
= replace(platform
,')','-')
883 # No need to report 'unknown' information...
884 platform
= replace(platform
,'unknown','')
886 # Fold '--'s and remove trailing '-'
888 cleaned
= replace(platform
,'--','-')
889 if cleaned
== platform
:
892 while platform
[-1] == '-':
893 platform
= platform
[:-1]
897 def _node(default
=''):
899 """ Helper to determine the node name of this machine.
907 return socket
.gethostname()
909 # Still not working...
912 # os.path.abspath is new in Python 1.5.2:
913 if not hasattr(os
.path
,'abspath'):
917 isabs
=os
.path
.isabs
,join
=os
.path
.join
,getcwd
=os
.getcwd
,
918 normpath
=os
.path
.normpath
):
921 path
= join(getcwd(), path
)
922 return normpath(path
)
926 _abspath
= os
.path
.abspath
928 def _follow_symlinks(filepath
):
930 """ In case filepath is a symlink, follow it until a
931 real file is reached.
933 filepath
= _abspath(filepath
)
934 while os
.path
.islink(filepath
):
935 filepath
= os
.path
.normpath(
936 os
.path
.join(filepath
,os
.readlink(filepath
)))
939 def _syscmd_uname(option
,default
=''):
941 """ Interface to the system's uname command.
943 if sys
.platform
in ('dos','win32','win16','os2'):
947 f
= os
.popen('uname %s 2> /dev/null' % option
)
948 except (AttributeError,os
.error
):
950 output
= string
.strip(f
.read())
957 def _syscmd_file(target
,default
=''):
959 """ Interface to the system's file command.
961 The function uses the -b option of the file command to have it
962 ommit the filename in its output and if possible the -L option
963 to have the command follow symlinks. It returns default in
964 case the command should fail.
967 target
= _follow_symlinks(target
)
969 f
= os
.popen('file %s 2> /dev/null' % target
)
970 except (AttributeError,os
.error
):
972 output
= string
.strip(f
.read())
979 ### Information about the used architecture
981 # Default values for architecture; non-empty strings override the
982 # defaults given as parameters
983 _default_architecture
= {
984 'win32': ('','WindowsPE'),
985 'win16': ('','Windows'),
989 _architecture_split
= re
.compile(r
'[\s,]').split
991 def architecture(executable
=sys
.executable
,bits
='',linkage
=''):
993 """ Queries the given executable (defaults to the Python interpreter
994 binary) for various architecture information.
996 Returns a tuple (bits,linkage) which contains information about
997 the bit architecture and the linkage format used for the
998 executable. Both values are returned as strings.
1000 Values that cannot be determined are returned as given by the
1001 parameter presets. If bits is given as '', the sizeof(pointer)
1002 (or sizeof(long) on Python version < 1.5.2) is used as
1003 indicator for the supported pointer size.
1005 The function relies on the system's "file" command to do the
1006 actual work. This is available on most if not all Unix
1007 platforms. On some non-Unix platforms where the "file" command
1008 does not exist and the executable is set to the Python interpreter
1009 binary defaults from _default_architecture are used.
1012 # Use the sizeof(pointer) as default number of bits if nothing
1013 # else is given as default.
1017 size
= struct
.calcsize('P')
1018 except struct
.error
:
1019 # Older installations can only query longs
1020 size
= struct
.calcsize('l')
1021 bits
= str(size
*8) + 'bit'
1023 # Get data from the 'file' system command
1025 output
= _syscmd_file(executable
, '')
1030 executable
== sys
.executable
:
1031 # "file" command did not return anything; we'll try to provide
1032 # some sensible defaults then...
1033 if _default_architecture
.has_key(sys
.platform
):
1034 b
,l
= _default_architecture
[sys
.platform
]
1041 # Split the output into a list of strings omitting the filename
1042 fileout
= _architecture_split(output
)[1:]
1044 if 'executable' not in fileout
:
1045 # Format not supported
1049 if '32-bit' in fileout
:
1051 elif 'N32' in fileout
:
1054 elif '64-bit' in fileout
:
1058 if 'ELF' in fileout
:
1060 elif 'PE' in fileout
:
1061 # E.g. Windows uses this format
1062 if 'Windows' in fileout
:
1063 linkage
= 'WindowsPE'
1066 elif 'COFF' in fileout
:
1068 elif 'MS-DOS' in fileout
:
1071 # XXX the A.OUT format also falls under this class...
1076 ### Portable uname() interface
1082 """ Fairly portable uname interface. Returns a tuple
1083 of strings (system,node,release,version,machine,processor)
1084 identifying the underlying platform.
1086 Note that unlike the os.uname function this also returns
1087 possible processor information as an additional tuple entry.
1089 Entries which cannot be determined are set to ''.
1094 if _uname_cache
is not None:
1097 # Get some infos from the builtin os.uname API...
1099 system
,node
,release
,version
,machine
= os
.uname()
1101 except AttributeError:
1102 # Hmm, no uname... we'll have to poke around the system then.
1103 system
= sys
.platform
1111 # Try win32_ver() on win32 platforms
1112 if system
== 'win32':
1113 release
,version
,csd
,ptype
= win32_ver()
1114 if release
and version
:
1116 # Try to use the PROCESSOR_* environment variables
1117 # available on Win XP and later; see
1118 # http://support.microsoft.com/kb/888731 and
1119 # http://www.geocities.com/rick_lively/MANUALS/ENV/MSWIN/PROCESSI.HTM
1120 machine
= os
.environ
.get('PROCESSOR_ARCHITECTURE', '')
1121 processor
= os
.environ
.get('PROCESSOR_IDENTIFIER', machine
)
1123 # Try the 'ver' system command available on some
1126 system
,release
,version
= _syscmd_ver(system
)
1127 # Normalize system to what win32_ver() normally returns
1128 # (_syscmd_ver() tends to return the vendor name as well)
1129 if system
== 'Microsoft Windows':
1131 elif system
== 'Microsoft' and release
== 'Windows':
1132 # Under Windows Vista and Windows Server 2008,
1133 # Microsoft changed the output of the ver command. The
1134 # release is no longer printed. This causes the
1135 # system and release to be misidentified.
1137 if '6.0' == version
[:3]:
1142 # In case we still don't know anything useful, we'll try to
1144 if system
in ('win32','win16'):
1146 if system
== 'win32':
1152 elif system
[:4] == 'java':
1153 release
,vendor
,vminfo
,osinfo
= java_ver()
1155 version
= string
.join(vminfo
,', ')
1159 elif os
.name
== 'mac':
1160 release
,(version
,stage
,nonrel
),machine
= mac_ver()
1164 # System specific extensions
1165 if system
== 'OpenVMS':
1166 # OpenVMS seems to have release and version mixed up
1167 if not release
or release
== '0':
1170 # Get processor information
1176 csid
, cpu_number
= vms_lib
.getsyi('SYI$_CPU',0)
1177 if (cpu_number
>= 128):
1182 # Get processor information from the uname system command
1183 processor
= _syscmd_uname('-p','')
1185 # 'unknown' is not really any useful as information; we'll convert
1186 # it to '' which is more portable
1187 if system
== 'unknown':
1189 if node
== 'unknown':
1191 if release
== 'unknown':
1193 if version
== 'unknown':
1195 if machine
== 'unknown':
1197 if processor
== 'unknown':
1201 if system
== 'Microsoft' and release
== 'Windows':
1205 _uname_cache
= system
,node
,release
,version
,machine
,processor
1208 ### Direct interfaces to some of the uname() return values
1212 """ Returns the system/OS name, e.g. 'Linux', 'Windows' or 'Java'.
1214 An empty string is returned if the value cannot be determined.
1221 """ Returns the computer's network name (which may not be fully
1224 An empty string is returned if the value cannot be determined.
1231 """ Returns the system's release, e.g. '2.2.0' or 'NT'
1233 An empty string is returned if the value cannot be determined.
1240 """ Returns the system's release version, e.g. '#3 on degas'
1242 An empty string is returned if the value cannot be determined.
1249 """ Returns the machine type, e.g. 'i386'
1251 An empty string is returned if the value cannot be determined.
1258 """ Returns the (true) processor name, e.g. 'amdk6'
1260 An empty string is returned if the value cannot be
1261 determined. Note that many platforms do not provide this
1262 information or simply return the same value as for machine(),
1263 e.g. NetBSD does this.
1268 ### Various APIs for extracting information from sys.version
1270 _sys_version_parser
= re
.compile(
1272 '\(#?([^,]+),\s*([\w ]+),\s*([\w :]+)\)\s*'
1275 _jython_sys_version_parser
= re
.compile(
1278 _ironpython_sys_version_parser
= re
.compile(
1281 '(?: \(([\d\.]+)\))?'
1282 ' on (.NET [\d\.]+)')
1284 _sys_version_cache
= {}
1286 def _sys_version(sys_version
=None):
1288 """ Returns a parsed version of Python's sys.version as tuple
1289 (name, version, branch, revision, buildno, builddate, compiler)
1290 referring to the Python implementation name, version, branch,
1291 revision, build number, build date/time as string and the compiler
1292 identification string.
1294 Note that unlike the Python sys.version, the returned value
1295 for the Python version will always include the patchlevel (it
1298 The function returns empty strings for tuple entries that
1299 cannot be determined.
1301 sys_version may be given to parse an alternative version
1302 string, e.g. if the version was read from a different Python
1306 # Get the Python version
1307 if sys_version
is None:
1308 sys_version
= sys
.version
1310 # Try the cache first
1311 result
= _sys_version_cache
.get(sys_version
, None)
1312 if result
is not None:
1316 if sys_version
[:10] == 'IronPython':
1319 match
= _ironpython_sys_version_parser
.match(sys_version
)
1322 'failed to parse IronPython sys.version: %s' %
1324 version
, alt_version
, compiler
= match
.groups()
1330 elif sys
.platform
[:4] == 'java':
1333 match
= _jython_sys_version_parser
.match(sys_version
)
1336 'failed to parse Jython sys.version: %s' %
1338 version
, = match
.groups()
1341 compiler
= sys
.platform
1347 match
= _sys_version_parser
.match(sys_version
)
1350 'failed to parse CPython sys.version: %s' %
1352 version
, buildno
, builddate
, buildtime
, compiler
= \
1354 if hasattr(sys
, 'subversion'):
1355 # sys.subversion was added in Python 2.5
1356 name
, branch
, revision
= sys
.subversion
1361 builddate
= builddate
+ ' ' + buildtime
1363 # Add the patchlevel version if missing
1364 l
= string
.split(version
, '.')
1367 version
= string
.join(l
, '.')
1369 # Build and cache the result
1370 result
= (name
, version
, branch
, revision
, buildno
, builddate
, compiler
)
1371 _sys_version_cache
[sys_version
] = result
1374 def _test_sys_version():
1376 _sys_version_cache
.clear()
1377 for input, output
in (
1378 ('2.4.3 (#1, Jun 21 2006, 13:54:21) \n[GCC 3.3.4 (pre 3.3.5 20040809)]',
1379 ('CPython', '2.4.3', '', '', '1', 'Jun 21 2006 13:54:21', 'GCC 3.3.4 (pre 3.3.5 20040809)')),
1380 ('IronPython 1.0.60816 on .NET 2.0.50727.42',
1381 ('IronPython', '1.0.60816', '', '', '', '', '.NET 2.0.50727.42')),
1382 ('IronPython 1.0 (1.0.61005.1977) on .NET 2.0.50727.42',
1383 ('IronPython', '1.0.0', '', '', '', '', '.NET 2.0.50727.42')),
1385 parsed
= _sys_version(input)
1386 if parsed
!= output
:
1387 print (input, parsed
)
1389 def python_implementation():
1391 """ Returns a string identifying the Python implementation.
1393 Currently, the following implementations are identified:
1394 'CPython' (C implementation of Python),
1395 'IronPython' (.NET implementation of Python),
1396 'Jython' (Java implementation of Python).
1399 return _sys_version()[0]
1401 def python_version():
1403 """ Returns the Python version as string 'major.minor.patchlevel'
1405 Note that unlike the Python sys.version, the returned value
1406 will always include the patchlevel (it defaults to 0).
1409 if hasattr(sys
, 'version_info'):
1410 return '%i.%i.%i' % sys
.version_info
[:3]
1411 return _sys_version()[1]
1413 def python_version_tuple():
1415 """ Returns the Python version as tuple (major, minor, patchlevel)
1418 Note that unlike the Python sys.version, the returned value
1419 will always include the patchlevel (it defaults to 0).
1422 if hasattr(sys
, 'version_info'):
1423 return sys
.version_info
[:3]
1424 return tuple(string
.split(_sys_version()[1], '.'))
1426 def python_branch():
1428 """ Returns a string identifying the Python implementation
1431 For CPython this is the Subversion branch from which the
1432 Python binary was built.
1434 If not available, an empty string is returned.
1438 return _sys_version()[2]
1440 def python_revision():
1442 """ Returns a string identifying the Python implementation
1445 For CPython this is the Subversion revision from which the
1446 Python binary was built.
1448 If not available, an empty string is returned.
1451 return _sys_version()[3]
1455 """ Returns a tuple (buildno, builddate) stating the Python
1456 build number and date as strings.
1459 return _sys_version()[4:6]
1461 def python_compiler():
1463 """ Returns a string identifying the compiler used for compiling
1467 return _sys_version()[6]
1469 ### The Opus Magnum of platform strings :-)
1471 _platform_cache
= {}
1473 def platform(aliased
=0, terse
=0):
1475 """ Returns a single string identifying the underlying platform
1476 with as much useful information as possible (but no more :).
1478 The output is intended to be human readable rather than
1479 machine parseable. It may look different on different
1480 platforms and this is intended.
1482 If "aliased" is true, the function will use aliases for
1483 various platforms that report system names which differ from
1484 their common names, e.g. SunOS will be reported as
1485 Solaris. The system_alias() function is used to implement
1488 Setting terse to true causes the function to return only the
1489 absolute minimum information needed to identify the platform.
1492 result
= _platform_cache
.get((aliased
, terse
), None)
1493 if result
is not None:
1496 # Get uname information and then apply platform specific cosmetics
1498 system
,node
,release
,version
,machine
,processor
= uname()
1499 if machine
== processor
:
1502 system
,release
,version
= system_alias(system
,release
,version
)
1504 if system
== 'Windows':
1506 rel
,vers
,csd
,ptype
= win32_ver(version
)
1508 platform
= _platform(system
,release
)
1510 platform
= _platform(system
,release
,version
,csd
)
1512 elif system
in ('Linux',):
1513 # Linux based systems
1514 distname
,distversion
,distid
= dist('')
1515 if distname
and not terse
:
1516 platform
= _platform(system
,release
,machine
,processor
,
1518 distname
,distversion
,distid
)
1520 # If the distribution name is unknown check for libc vs. glibc
1521 libcname
,libcversion
= libc_ver(sys
.executable
)
1522 platform
= _platform(system
,release
,machine
,processor
,
1524 libcname
+libcversion
)
1525 elif system
== 'Java':
1527 r
,v
,vminfo
,(os_name
,os_version
,os_arch
) = java_ver()
1528 if terse
or not os_name
:
1529 platform
= _platform(system
,release
,version
)
1531 platform
= _platform(system
,release
,version
,
1533 os_name
,os_version
,os_arch
)
1535 elif system
== 'MacOS':
1538 platform
= _platform(system
,release
)
1540 platform
= _platform(system
,release
,machine
)
1545 platform
= _platform(system
,release
)
1547 bits
,linkage
= architecture(sys
.executable
)
1548 platform
= _platform(system
,release
,machine
,processor
,bits
,linkage
)
1550 _platform_cache
[(aliased
, terse
)] = platform
1553 ### Command line interface
1555 if __name__
== '__main__':
1556 # Default is to print the aliased verbose platform string
1557 terse
= ('terse' in sys
.argv
or '--terse' in sys
.argv
)
1558 aliased
= (not 'nonaliased' in sys
.argv
and not '--nonaliased' in sys
.argv
)
1559 print platform(aliased
,terse
)