traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Made improvements based on changes just made and comments from 

Bernhard Reiter <bernhard@csd.uwm.edu>.
This commit is contained in:
Fred Drake 1999-04-05 19:00:54 +00:00
parent fa1591c129
commit 1dc3a501a6
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Doc/lib/libgzip.tex
View File

@ -11,7 +11,10 @@ with that used by the GNU compression program \program{gzip}.
Accordingly, the \module{gzip} module provides the \class{GzipFile} Accordingly, the \module{gzip} module provides the \class{GzipFile}
class to read and write \program{gzip}-format files, automatically class to read and write \program{gzip}-format files, automatically
compressing or decompressing the data so it looks like an ordinary compressing or decompressing the data so it looks like an ordinary
file object. file object. Note that additional file formats which can be
decompressed by the \program{gzip} and \program{gunzip} programs, such
as those produced by \program{compress} and \program{pack}, are not
supported by this module.
The module defines the following items: The module defines the following items:
@ -34,10 +37,12 @@ to the filename of \var{fileobj}, if discernible; otherwise, it
defaults to the empty string, and in this case the original filename defaults to the empty string, and in this case the original filename
is not included in the header. is not included in the header.
The \var{mode} argument can be either \code{'r'} or \code{'w'}, The \var{mode} argument can be any of \code{'r'}, \code{'rb'},
depending on whether the file will be read or written. The default is \code{'a'}, \code{'ab'}, \code{'w'}, or \code{'wb'}, depending on
the mode of \var{fileobj} if discernible; otherwise, the default is whether the file will be read or written. The default is the mode of
\code{'r'}. \var{fileobj} if discernible; otherwise, the default is \code{'rb'}.
Be aware that only the \code{'rb'}, \code{'ab'}, and \code{'wb'}
values should be used for cross-platform portability.
The \var{compresslevel} argument is an integer from \code{1} to The \var{compresslevel} argument is an integer from \code{1} to
\code{9} controlling the level of compression; \code{1} is fastest and \code{9} controlling the level of compression; \code{1} is fastest and
@ -55,7 +60,7 @@ object's \method{getvalue()} method.
\begin{funcdesc}{open}{filename\optional{, mode\optional{, compresslevel}}} \begin{funcdesc}{open}{filename\optional{, mode\optional{, compresslevel}}}
This is a shorthand for \code{GzipFile(\var{filename},} This is a shorthand for \code{GzipFile(\var{filename},}
\code{\var{mode},} \code{\var{compresslevel})}. The \var{filename} \code{\var{mode},} \code{\var{compresslevel})}. The \var{filename}
argument is required; \var{mode} defaults to \code{'r'} and argument is required; \var{mode} defaults to \code{'rb'} and
\var{compresslevel} defaults to \code{9}. \var{compresslevel} defaults to \code{9}.
\end{funcdesc} \end{funcdesc}