[Python-checkins] r60873 - python/trunk/Doc/library/codecs.rst

[georg.brandl]

Author: georg.brandl
Date: Sun Feb 17 12:33:38 2008
New Revision: 60873

Modified:
   python/trunk/Doc/library/codecs.rst
Log:
#2131: note that codecs.open() always opens files in binary mode.


Modified: python/trunk/Doc/library/codecs.rst
==============================================================================
--- python/trunk/Doc/library/codecs.rst	(original)
+++ python/trunk/Doc/library/codecs.rst	Sun Feb 17 12:33:38 2008
@@ -206,7 +206,8 @@
 .. function:: open(filename, mode[, encoding[, errors[, buffering]]])
 
    Open an encoded file using the given *mode* and return a wrapped version
-   providing transparent encoding/decoding.
+   providing transparent encoding/decoding.  The default file mode is ``'r'``
+   meaning to open the file in read mode.
 
    .. note::
 
@@ -214,6 +215,13 @@
       i.e. Unicode objects for most built-in codecs.  Output is also codec-dependent
       and will usually be Unicode as well.
 
+   .. note::
+
+      Files are always opened in binary mode, even if no binary mode was
+      specified.  This is done to avoid data loss due to encodings using 8-bit
+      values.  This means that no automatic conversion of ``'\n'`` is done
+      on reading and writing.
+
    *encoding* specifies the encoding which is to be used for the file.
 
    *errors* may be given to define the error handling. It defaults to ``'strict'``