diff options
| author | Georg Brandl <georg@python.org> | 2009-04-05 10:41:02 +0000 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-04-05 10:41:02 +0000 |
| commit | 5d19610f8d12ad179a24db13b10b54dfdf36ab3e (patch) | |
| tree | bc868995defa22b783152a091d2a601f75b9d326 | |
| parent | 75f1107b7c34952e3aef1dfd0acb2282296040dd (diff) | |
| download | cpython-git-5d19610f8d12ad179a24db13b10b54dfdf36ab3e.tar.gz | |
#1718017: document the relation of os.path and the posixpath, ntpath etc. modules better.
| -rw-r--r-- | Doc/library/os.path.rst | 18 | ||||
| -rw-r--r-- | Doc/library/os.rst | 9 |
2 files changed, 16 insertions, 11 deletions
diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst index 01406e06b3..0e7f376516 100644 --- a/Doc/library/os.path.rst +++ b/Doc/library/os.path.rst @@ -1,11 +1,9 @@ - :mod:`os.path` --- Common pathname manipulations ================================================ .. module:: os.path :synopsis: Operations on pathnames. - .. index:: single: path; operations This module implements some useful functions on pathnames. To read or @@ -18,6 +16,22 @@ write files see :func:`open`, and for accessing the filesystem see the :func:`splitunc` and :func:`ismount` do handle them correctly. +.. note:: + + Since different operating systems have different path name conventions, there + are several versions of this module in the standard library. The + :mod:`os.path` module is always the path module suitable for the operating + system Python is running on, and therefore usable for local paths. However, + you can also import and use the individual modules if you want to manipulate + a path that is *always* in one of the different formats. They all have the + same interface: + + * :mod:`posixpath` for UNIX-style paths + * :mod:`ntpath` for Windows paths + * :mod:`macpath` for old-style MacOS paths + * :mod:`os2emxpath` for OS/2 EMX paths + + .. function:: abspath(path) Return a normalized absolutized version of the pathname *path*. On most diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 4ea6c7f5b3..061f1ce408 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -46,15 +46,6 @@ the :mod:`os` module, but using them is of course a threat to portability! ``'ce'``, ``'java'``, ``'riscos'``. -.. data:: path - - The corresponding operating system dependent standard module for pathname - operations, such as :mod:`posixpath` or :mod:`ntpath`. Thus, given the proper - imports, ``os.path.split(file)`` is equivalent to but more portable than - ``posixpath.split(file)``. Note that this is also an importable module: it may - be imported directly as :mod:`os.path`. - - .. _os-procinfo: Process Parameters |