[Python-checkins] cpython (merge 3.2 -> default): Issue #12326: document the recommended idiom for checking sys.platform on Unix
antoine.pitrou
python-checkins at python.org
Sat Jul 9 15:56:39 CEST 2011
http://hg.python.org/cpython/rev/19b3b2d93a63
changeset: 71286:19b3b2d93a63
parent: 71283:3a4b983dd70b
parent: 71285:8bc9dbc61ba6
user: Antoine Pitrou <solipsis at pitrou.net>
date: Sat Jul 09 15:55:38 2011 +0200
summary:
Issue #12326: document the recommended idiom for checking sys.platform on Unix systems.
Also, point to the various alternatives.
files:
Doc/library/os.rst | 7 +++++++
Doc/library/sys.rst | 12 ++++++++++++
2 files changed, 19 insertions(+), 0 deletions(-)
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -61,6 +61,13 @@
names have currently been registered: ``'posix'``, ``'nt'``, ``'mac'``,
``'os2'``, ``'ce'``, ``'java'``.
+ .. 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-filenames:
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -705,6 +705,12 @@
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 @@
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
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list