Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.

Also, point to the various alternatives.
This commit is contained in:
Antoine Pitrou 2011-07-09 15:48:29 +02:00
parent 4a4a0fed07
commit ea901ad2c6
2 changed files with 19 additions and 0 deletions

View File

@ -53,6 +53,13 @@ Notes on the availability of these functions:
names have currently been registered: ``'posix'``, ``'nt'``,
``'os2'``, ``'ce'``, ``'java'``, ``'riscos'``.
.. seealso::
:attr:`sys.platform` has a finer granularity. :func:`os.uname` gives
system-dependent version information.
The :mod:`platform` module provides detailed checks for the
system's identity.
.. _os-procinfo:

View File

@ -726,6 +726,12 @@ always available.
For Unix systems, this is the lowercased OS name as returned by ``uname -s``
with the first part of the version as returned by ``uname -r`` appended,
e.g. ``'sunos5'`` or ``'linux2'``, *at the time when Python was built*.
Unless you want to test for a specific system version, it is therefore
recommended to use the following idiom::
if sys.platform.startswith('linux'):
# Linux-specific code here...
For other systems, the values are:
================ ===========================
@ -740,6 +746,12 @@ always available.
AtheOS ``'atheos'``
================ ===========================
.. seealso::
:attr:`os.name` has a coarser granularity. :func:`os.uname` gives
system-dependent version information.
The :mod:`platform` module provides detailed checks for the
system's identity.
.. data:: prefix