1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

merge heads

Browse Source
This commit is contained in:
Gregory P. Smith 2012-06-25 01:15:53 -07:00
commit 68d34f48bf
1 changed files with 22 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
Doc/library/os.rst
View File

@ -1204,8 +1204,8 @@ features:
* For some functions, the *path* argument can be not only a string giving a path * For some functions, the *path* argument can be not only a string giving a path
name, but also a file descriptor. The function will then operate on the file name, but also a file descriptor. The function will then operate on the file
referred to by the descriptor. (For POSIX systems, this will use the ``f...`` referred to by the descriptor. (For POSIX systems, Python will call the
version of the function.) ``f...`` version of the function.)
You can check whether or not *path* can be specified as a file descriptor on You can check whether or not *path* can be specified as a file descriptor on
your platform using :data:`os.supports_fd`. If it is unavailable, using it your platform using :data:`os.supports_fd`. If it is unavailable, using it
@ -1219,8 +1219,8 @@ features:
* For functions with a *dir_fd* parameter: If *dir_fd* is not ``None``, it * For functions with a *dir_fd* parameter: If *dir_fd* is not ``None``, it
should be a file descriptor referring to a directory, and the path to operate should be a file descriptor referring to a directory, and the path to operate
on should be relative; path will then be relative to that directory. If the on should be relative; path will then be relative to that directory. If the
path is absolute, *dir_fd* is ignored. (For POSIX systems, this will use the path is absolute, *dir_fd* is ignored. (For POSIX systems, Python will call
``f...at`` version of the function.) the ``...at`` version of the function.)
You can check whether or not *dir_fd* is supported on your platform using You can check whether or not *dir_fd* is supported on your platform using
:data:`os.supports_dir_fd`. If it is unavailable, using it will raise a :data:`os.supports_dir_fd`. If it is unavailable, using it will raise a
@ -1231,7 +1231,7 @@ features:
* For functions ith a *follow_symlinks* parameter: If *follow_symlinks* is * For functions ith a *follow_symlinks* parameter: If *follow_symlinks* is
``False``, and the last element of the path to operate on is a symbolic link, ``False``, and the last element of the path to operate on is a symbolic link,
the function will operate on the symbolic link itself instead of the file the the function will operate on the symbolic link itself instead of the file the
link points to. (For POSIX systems, this will use the ``l...`` version of link points to. (For POSIX systems, Python will call the ``l...`` version of
the function.) the function.)
You can check whether or not *follow_symlinks* is supported on your platform You can check whether or not *follow_symlinks* is supported on your platform
@ -1471,17 +1471,9 @@ features:
Create a hard link pointing to *src* named *dst*. Create a hard link pointing to *src* named *dst*.
If either *src_dir_fd* or *dst_dir_fd* is not ``None``, it should be a file This function can support specifying *src_dir_fd* and/or *dst_dir_fd* to
descriptor referring to a directory, and the corresponding path (*src* or supply :ref:`paths relative to directory descriptors <dir_fd>`, and :ref:`not
*dst*) should be relative; that path will then be relative to that directory. following symlinks <follow_symlinks>`.
(If *src* is absolute, *src_dir_fd* is ignored; the same goes for *dst* and
*dst_dir_fd*.) *src_dir_fd* and *dst_dir_fd* may not be supported on your
platform; you can check whether or not they are available using
:data:`os.supports_dir_fd`. If they are unavailable, using either will raise
a :exc:`NotImplementedError`.
This function can also support :ref:`not following symlinks
<follow_symlinks>`.
Availability: Unix, Windows. Availability: Unix, Windows.
@ -1729,14 +1721,8 @@ features:
Windows, if *dst* already exists, :exc:`OSError` will be raised even if it is a Windows, if *dst* already exists, :exc:`OSError` will be raised even if it is a
file. file.
If either *src_dir_fd* or *dst_dir_fd* is not ``None``, it should be a This function can support specifying *src_dir_fd* and/or *dst_dir_fd* to
file descriptor referring to a directory, and the corresponding path supply :ref:`paths relative to directory descriptors <dir_fd>`.
(*src* or *dst*) should be relative; that path will then be relative to
that directory. (If *src* is absolute, *src_dir_fd* is ignored; the same
goes for *dst* and *dst_dir_fd*.)
*src_dir_fd* and *dst_dir_fd* may not be supported on your platform;
you can check whether or not they are available using :data:`os.supports_dir_fd`.
If they are unavailable, using either will raise a :exc:`NotImplementedError`.
If you want cross-platform overwriting of the destination, use :func:`replace`. If you want cross-platform overwriting of the destination, use :func:`replace`.
@ -1767,14 +1753,8 @@ features:
if *src* and *dst* are on different filesystems. If successful, if *src* and *dst* are on different filesystems. If successful,
the renaming will be an atomic operation (this is a POSIX requirement). the renaming will be an atomic operation (this is a POSIX requirement).
If either *src_dir_fd* or *dst_dir_fd* is not ``None``, it should be a This function can support specifying *src_dir_fd* and/or *dst_dir_fd* to
file descriptor referring to a directory, and the corresponding path supply :ref:`paths relative to directory descriptors <dir_fd>`.
(*src* or *dst*) should be relative; that path will then be relative to
that directory. (If *src* is absolute, *src_dir_fd* is ignored; the same
goes for *dst* and *dst_dir_fd*.)
*src_dir_fd* and *dst_dir_fd* may not be supported on your platform;
you can check whether or not they are available using :data:`os.supports_dir_fd`.
If they are unavailable, using either will raise a :exc:`NotImplementedError`.
Availability: Unix, Windows. Availability: Unix, Windows.
@ -1955,8 +1935,8 @@ features:
.. data:: supports_dir_fd .. data:: supports_dir_fd
An object implementing collections.Set indicating which functions in the A :class:`~collections.Set` object indicating which functions in the
:mod:`os` permit use of their *dir_fd* parameter. Different platforms :mod:`os` module permit use of their *dir_fd* parameter. Different platforms
provide different functionality, and an option that might work on one might provide different functionality, and an option that might work on one might
be unsupported on another. For consistency's sakes, functions that support be unsupported on another. For consistency's sakes, functions that support
*dir_fd* always allow specifying the parameter, but will throw an exception *dir_fd* always allow specifying the parameter, but will throw an exception
@ -1977,10 +1957,10 @@ features:
.. data:: supports_effective_ids .. data:: supports_effective_ids
An object implementing collections.Set indicating which functions in the A :class:`~collections.Set` object indicating which functions in the
:mod:`os` permit use of the *effective_ids* parameter for :func:`os.access`. :mod:`os` module permit use of the *effective_ids* parameter for
If the local platform supports it, the collection will contain :func:`os.access`. If the local platform supports it, the collection will
:func:`os.access`, otherwise it will be empty. contain :func:`os.access`, otherwise it will be empty.
To check whether you can use the *effective_ids* parameter for To check whether you can use the *effective_ids* parameter for
:func:`os.access`, use the ``in`` operator on ``supports_dir_fd``, like so:: :func:`os.access`, use the ``in`` operator on ``supports_dir_fd``, like so::
@ -1995,8 +1975,8 @@ features:
.. data:: supports_fd .. data:: supports_fd
An object implementing collections.Set indicating which functions in the A :class:`~collections.Set` object indicating which functions in the
:mod:`os` permit specifying their *path* parameter as an open file :mod:`os` module permit specifying their *path* parameter as an open file
descriptor. Different platforms provide different functionality, and an descriptor. Different platforms provide different functionality, and an
option that might work on one might be unsupported on another. For option that might work on one might be unsupported on another. For
consistency's sakes, functions that support *fd* always allow specifying consistency's sakes, functions that support *fd* always allow specifying
@ -2016,8 +1996,8 @@ features:
.. data:: supports_follow_symlinks .. data:: supports_follow_symlinks
An object implementing collections.Set indicating which functions in the A :class:`~collections.Set` object indicating which functions in the
:mod:`os` permit use of their *follow_symlinks* parameter. Different :mod:`os` module permit use of their *follow_symlinks* parameter. Different
platforms provide different functionality, and an option that might work on platforms provide different functionality, and an option that might work on
one might be unsupported on another. For consistency's sakes, functions that one might be unsupported on another. For consistency's sakes, functions that
support *follow_symlinks* always allow specifying the parameter, but will support *follow_symlinks* always allow specifying the parameter, but will