mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Issue #15176: Clarified behavior, documentation, and implementation

Browse source 
of os.listdir().
This commit is contained in:
Larry Hastings 2012-06-25 04:42:23 -07:00
parent 3b52778c74
commit fdaea06d3c
4 changed files with 45 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Doc/library/os.rst
View file

@ -1488,16 +1488,19 @@ features:
.. function:: listdir(path='.')
Return a list containing the names of the entries in the directory given by
*path* (default: ``'.'``). The list is in arbitrary order. It does not
include the special entries ``'.'`` and ``'..'`` even if they are present in
the directory.
*path*. The list is in arbitrary order, and does not include the special
entries ``'.'`` and ``'..'`` even if they are present in the directory.
This function can be called with a bytes or string argument, and returns
filenames of the same datatype.
*path* may be either of type ``str`` or of type ``bytes``. If *path*
is of type ``bytes``, the filenames returned will also be of type ``bytes``;
in all other circumstances, they will be of type ``str``.
This function can also support :ref:`specifying a file descriptor
<path_fd>`; the file descriptor must refer to a directory.
.. note::
To encode ``str`` filenames to ``bytes``, use :func:`~os.fsencode`.
Availability: Unix, Windows.
.. versionchanged:: 3.2