summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2011-07-09 13:55:38 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2011-07-09 13:55:38 (GMT)
commit87fd76edb601322b8ce54444bed5ba864ad2c7bb (patch)
treebbd2daec87d2c5e8975efb148039b0b145655fdb /Doc/library/sys.rst
parentd3b41c63a6fc4f335773a1e2b834859ed48f604f (diff)
parenta83cdaae89b9565bd3c6f78c14a23befcac24e76 (diff)
downloadcpython-87fd76edb601322b8ce54444bed5ba864ad2c7bb.zip
cpython-87fd76edb601322b8ce54444bed5ba864ad2c7bb.tar.gz
cpython-87fd76edb601322b8ce54444bed5ba864ad2c7bb.tar.bz2
Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index dfc2412..517ba63 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -705,6 +705,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:
================ ===========================
@@ -717,6 +723,12 @@ always available.
OS/2 EMX ``'os2emx'``
================ ===========================
+ .. 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