mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

#1718017: document the relation of os.path and the posixpath, ntpath etc. modules better.

Browse source
This commit is contained in:
Georg Brandl 2009-04-05 10:41:02 +00:00
parent 75f1107b7c
commit 5d19610f8d
2 changed files with 16 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/library/os.path.rst
View file

@ -1,11 +1,9 @@
:mod:`os.path` --- Common pathname manipulations :mod:`os.path` --- Common pathname manipulations
================================================ ================================================
.. module:: os.path .. module:: os.path
:synopsis: Operations on pathnames. :synopsis: Operations on pathnames.
.. index:: single: path; operations .. index:: single: path; operations
This module implements some useful functions on pathnames. To read or 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. :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) .. function:: abspath(path)
Return a normalized absolutized version of the pathname *path*. On most Return a normalized absolutized version of the pathname *path*. On most

9
Doc/library/os.rst
View file

@ -46,15 +46,6 @@ the :mod:`os` module, but using them is of course a threat to portability!
``'ce'``, ``'java'``, ``'riscos'``. ``'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: .. _os-procinfo:
Process Parameters Process Parameters