]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
SF patch 1094011: Docs for file() vs open().
authorRaymond Hettinger <python@rcn.com>
Fri, 7 Jan 2005 04:35:08 +0000 (04:35 +0000)
committerRaymond Hettinger <python@rcn.com>
Fri, 7 Jan 2005 04:35:08 +0000 (04:35 +0000)
Doc/lib/libfuncs.tex

index 65e25484ea532c12952b2c241a086924bc590890..3d185dbbc12bf17ba6d2009b20adb19a0ab99568 100644 (file)
@@ -416,9 +416,12 @@ class C:
     after any I/O has been performed, and there's no reliable way to
     determine whether this is the case.}
 
-  The \function{file()} constructor is new in Python 2.2.  The previous
-  spelling, \function{open()}, is retained for compatibility, and is an
-  alias for \function{file()}.
+  The \function{file()} constructor is new in Python 2.2 and is an
+  alias for \function{open()}.  Both spellings are equivalent.  The
+  intent is for \function{open()} to continue to be preferred for use
+  as a factory function which returns a new \class{file} object.  The
+  spelling, \class{file} is more suited to type testing (for example,
+  writing \samp{isinstance(f, file)}).
 \end{funcdesc}
 
 \begin{funcdesc}{filter}{function, list}