# [Python-checkins] r53752 - python/trunk/Doc/lib/libtarfile.tex

lars.gustaebel python-checkins at python.org
Mon Feb 12 10:25:54 CET 2007

Author: lars.gustaebel
Date: Mon Feb 12 10:25:53 2007
New Revision: 53752

Modified:
python/trunk/Doc/lib/libtarfile.tex
Log:
Bug #1656581: Point out that external file objects are supposed to be
at position 0.

Modified: python/trunk/Doc/lib/libtarfile.tex
==============================================================================
--- python/trunk/Doc/lib/libtarfile.tex	(original)
+++ python/trunk/Doc/lib/libtarfile.tex	Mon Feb 12 10:25:53 2007
@@ -49,8 +49,8 @@
avoid this.  If a compression method is not supported,
\exception{CompressionError} is raised.

-    If \var{fileobj} is specified, it is used as an alternative to
-    a file object opened for \var{name}.
+    If \var{fileobj} is specified, it is used as an alternative to a file
+    object opened for \var{name}. It is supposed to be at position 0.

For special purposes, there is a second format for \var{mode}:
\code{'filemode|[compression]'}.  \function{open()} will return a
@@ -161,6 +161,7 @@

If \var{fileobj} is given, it is used for reading or writing data.
If it can be determined, \var{mode} is overridden by \var{fileobj}'s mode.
+    \var{fileobj} will be used from position 0.
\begin{notice}
\var{fileobj} is not closed, when \class{TarFile} is closed.
\end{notice}