diff options
author | Martin v. Löwis <martin@v.loewis.de> | 2008-10-07 06:36:31 (GMT) |
---|---|---|
committer | Martin v. Löwis <martin@v.loewis.de> | 2008-10-07 06:36:31 (GMT) |
commit | a731b9929f6aeb55d484cf7b655e9c108e16f222 (patch) | |
tree | ed1bf878308ae66208d0662ef52bffabbab027fc /Doc/library/os.rst | |
parent | a5c2a51c1ee12bc4efa5861aa6fa43a63e0a1042 (diff) | |
download | cpython-a731b9929f6aeb55d484cf7b655e9c108e16f222.zip cpython-a731b9929f6aeb55d484cf7b655e9c108e16f222.tar.gz cpython-a731b9929f6aeb55d484cf7b655e9c108e16f222.tar.bz2 |
Patch #3187 (file 11721): Document byte vs. string parameters
and results.
Diffstat (limited to 'Doc/library/os.rst')
-rw-r--r-- | Doc/library/os.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 9e14003..0fd4094 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -693,13 +693,13 @@ Files and Directories .. function:: getcwd() - Return a bytestring representing the current working directory. + Return a string representing the current working directory. Availability: Unix, Windows. -.. function:: getcwdu() +.. function:: getcwdb() - Return a string representing the current working directory. + Return a bytestring representing the current working directory. Availability: Unix, Windows. @@ -801,8 +801,10 @@ Files and Directories ``'..'`` even if they are present in the directory. Availability: Unix, Windows. - On Windows NT/2k/XP and Unix, if *path* is a Unicode object, the result will be - a list of Unicode objects. + If *path* is a Unicode object, the result will be a list of Unicode objects. + If a filename can not be decoded to unicode, it is skipped. If *path* is a + bytes string, the result will be list of bytes objects included files + skipped by the unicode version. .. function:: lstat(path) @@ -916,7 +918,9 @@ Files and Directories be converted to an absolute pathname using ``os.path.join(os.path.dirname(path), result)``. - If the *path* is a Unicode object, the result will also be a Unicode object. + If the *path* is an Unicode object, the result will also be a Unicode object + and may raise an UnicodeDecodeError. If the *path* is a bytes object, the + result will be a bytes object. Availability: Unix. |