Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
74810d5a
Commit
74810d5a
authored
Apr 03, 1998
by
Fred Drake
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Nits.
Add {excdesc} for zlib.error. Use {methoddesc} where appropriate.
parent
c3486318
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
66 additions
and
50 deletions
+66
-50
Doc/lib/libzlib.tex
Doc/lib/libzlib.tex
+33
-25
Doc/libzlib.tex
Doc/libzlib.tex
+33
-25
No files found.
Doc/lib/libzlib.tex
View file @
74810d5a
% XXX The module has been extended (by Jeremy) but this documentation hasn't been updated yet
% XXX The module has been extended (by Jeremy) but this documentation
% hasn't been updated yet
\section
{
Built-in Module
\
sectcod
e
{
zlib
}}
\section
{
Built-in Module
\
modul
e
{
zlib
}}
\label
{
module-zlib
}
\label
{
module-zlib
}
\bimodindex
{
zlib
}
\bimodindex
{
zlib
}
For applications that require data compression, the functions in this
For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library,
module allow compression and decompression, using the zlib library,
which is based on GNU zip. The zlib library has its own home page at
which is based on the GNU
\program
{
gzip
}
program. The zlib library
\url
{
http://www.cdrom.com/pub/infozip/zlib/
}
.
has its own home page at
Version 1.0.4 is the most recent version as of December, 1997; use a
\url
{
http://www.cdrom.com/pub/infozip/zlib/
}
. Version 1.0.4 is the
later version if one is available.
most recent version as of December, 1997; use a later version if one
is available.
The available exception and functions in this module are:
\begin{excdesc}
{
error
}
Exception raised on compression and decompression errors.
\end{excdesc}
The available functions in this module are:
\setindexsubitem
{
(in module zlib)
}
\begin{funcdesc}
{
adler32
}{
string
\optional
{
, value
}}
\begin{funcdesc}
{
adler32
}{
string
\optional
{
, value
}}
Computes a Adler-32 checksum of
\var
{
string
}
. (An Adler-32
Computes a Adler-32 checksum of
\var
{
string
}
. (An Adler-32
checksum is almost as reliable as a CRC32 but can be computed much
checksum is almost as reliable as a CRC32 but can be computed much
...
@@ -30,7 +36,7 @@ Compresses the data in \var{string}, returning a string contained
...
@@ -30,7 +36,7 @@ Compresses the data in \var{string}, returning a string contained
compressed data.
\var
{
level
}
is an integer from
\code
{
1
}
to
\code
{
9
}
compressed data.
\var
{
level
}
is an integer from
\code
{
1
}
to
\code
{
9
}
controlling the level of compression;
\code
{
1
}
is fastest and produces
controlling the level of compression;
\code
{
1
}
is fastest and produces
the least compression,
\code
{
9
}
is slowest and produces the most. The
the least compression,
\code
{
9
}
is slowest and produces the most. The
default value is
\code
{
6
}
. Raises the
\exception
{
zlib.
error
}
default value is
\code
{
6
}
. Raises the
\exception
{
error
}
exception if any error occurs.
exception if any error occurs.
\end{funcdesc}
\end{funcdesc}
...
@@ -43,17 +49,19 @@ exception if any error occurs.
...
@@ -43,17 +49,19 @@ exception if any error occurs.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
, value
}}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
, value
}}
Computes a CRC (Cyclic Redundancy Check) sum of
\var
{
string
}
. If
Computes a CRC (Cyclic Redundancy Check)
%
\var
{
value
}
is present, it is used as the starting value of the
\index
{
Cyclic Redundancy Check
}
checksum; otherwise, a fixed default value is used. This allows
checksum of
\var
{
string
}
. If
computing a running checksum over the concatenation of several
\var
{
value
}
is present, it is used as the starting value of the
input strings. The algorithm is not cryptographically strong, and
checksum; otherwise, a fixed default value is used. This allows
should not be used for authentication or digital signatures.
computing a running checksum over the concatenation of several
input strings. The algorithm is not cryptographically strong, and
should not be used for authentication or digital signatures.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
decompress
}{
string
}
\begin{funcdesc}
{
decompress
}{
string
}
Decompresses the data in
\var
{
string
}
, returning a string containing
Decompresses the data in
\var
{
string
}
, returning a string containing
the uncompressed data. Raises the
\exception
{
zlib.
error
}
exception if any
the uncompressed data. Raises the
\exception
{
error
}
exception if any
error occurs.
error occurs.
\end{funcdesc}
\end{funcdesc}
...
@@ -66,41 +74,41 @@ alone.
...
@@ -66,41 +74,41 @@ alone.
Compression objects support the following methods:
Compression objects support the following methods:
\begin{
funcdesc}
{
compress
}{
string
}
\begin{
methoddesc}
[Compress]
{
compress
}{
string
}
Compress
\var
{
string
}
, returning a string containing compressed data
Compress
\var
{
string
}
, returning a string containing compressed data
for at least part of the data in
\var
{
string
}
. This data should be
for at least part of the data in
\var
{
string
}
. This data should be
concatenated to the output produced by any preceding calls to the
concatenated to the output produced by any preceding calls to the
\method
{
compress()
}
method. Some input may be kept in internal buffers
\method
{
compress()
}
method. Some input may be kept in internal buffers
for later processing.
for later processing.
\end{
func
desc}
\end{
method
desc}
\begin{
funcdesc}
{
flush
}{}
\begin{
methoddesc}
[Compress]
{
flush
}{}
All pending input is processed, and an string containing the remaining
All pending input is processed, and an string containing the remaining
compressed output is returned. After calling
\method
{
flush()
}
, the
compressed output is returned. After calling
\method
{
flush()
}
, the
\method
{
compress()
}
method cannot be called again; the only realistic
\method
{
compress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{
func
desc}
\end{
method
desc}
Decompression objects support the following methods:
Decompression objects support the following methods:
\begin{
funcdesc}
{
decompress
}{
string
}
\begin{
methoddesc}
[Decompress]
{
decompress
}{
string
}
Decompress
\var
{
string
}
, returning a string containing the
Decompress
\var
{
string
}
, returning a string containing the
uncompressed data corresponding to at least part of the data in
uncompressed data corresponding to at least part of the data in
\var
{
string
}
. This data should be concatenated to the output produced
\var
{
string
}
. This data should be concatenated to the output produced
by any preceding calls to the
by any preceding calls to the
\method
{
decompress()
}
method. Some of the input data may be preserved
\method
{
decompress()
}
method. Some of the input data may be preserved
in internal buffers for later processing.
in internal buffers for later processing.
\end{
func
desc}
\end{
method
desc}
\begin{
funcdesc}
{
flush
}{}
\begin{
methoddesc}
[Decompress]
{
flush
}{}
All pending input is processed, and a string containing the remaining
All pending input is processed, and a string containing the remaining
uncompressed output is returned. After calling
\method
{
flush()
}
, the
uncompressed output is returned. After calling
\method
{
flush()
}
, the
\method
{
decompress()
}
method cannot be called again; the only realistic
\method
{
decompress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{
func
desc}
\end{
method
desc}
\begin{seealso}
\begin{seealso}
\seemodule
{
gzip
}{
reading and writing
\
file
{
gzip
}
-format files
}
\seemodule
{
gzip
}{
reading and writing
\
program
{
gzip
}
-format files
}
\end{seealso}
\end{seealso}
Doc/libzlib.tex
View file @
74810d5a
% XXX The module has been extended (by Jeremy) but this documentation hasn't been updated yet
% XXX The module has been extended (by Jeremy) but this documentation
% hasn't been updated yet
\section
{
Built-in Module
\
sectcod
e
{
zlib
}}
\section
{
Built-in Module
\
modul
e
{
zlib
}}
\label
{
module-zlib
}
\label
{
module-zlib
}
\bimodindex
{
zlib
}
\bimodindex
{
zlib
}
For applications that require data compression, the functions in this
For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library,
module allow compression and decompression, using the zlib library,
which is based on GNU zip. The zlib library has its own home page at
which is based on the GNU
\program
{
gzip
}
program. The zlib library
\url
{
http://www.cdrom.com/pub/infozip/zlib/
}
.
has its own home page at
Version 1.0.4 is the most recent version as of December, 1997; use a
\url
{
http://www.cdrom.com/pub/infozip/zlib/
}
. Version 1.0.4 is the
later version if one is available.
most recent version as of December, 1997; use a later version if one
is available.
The available exception and functions in this module are:
\begin{excdesc}
{
error
}
Exception raised on compression and decompression errors.
\end{excdesc}
The available functions in this module are:
\setindexsubitem
{
(in module zlib)
}
\begin{funcdesc}
{
adler32
}{
string
\optional
{
, value
}}
\begin{funcdesc}
{
adler32
}{
string
\optional
{
, value
}}
Computes a Adler-32 checksum of
\var
{
string
}
. (An Adler-32
Computes a Adler-32 checksum of
\var
{
string
}
. (An Adler-32
checksum is almost as reliable as a CRC32 but can be computed much
checksum is almost as reliable as a CRC32 but can be computed much
...
@@ -30,7 +36,7 @@ Compresses the data in \var{string}, returning a string contained
...
@@ -30,7 +36,7 @@ Compresses the data in \var{string}, returning a string contained
compressed data.
\var
{
level
}
is an integer from
\code
{
1
}
to
\code
{
9
}
compressed data.
\var
{
level
}
is an integer from
\code
{
1
}
to
\code
{
9
}
controlling the level of compression;
\code
{
1
}
is fastest and produces
controlling the level of compression;
\code
{
1
}
is fastest and produces
the least compression,
\code
{
9
}
is slowest and produces the most. The
the least compression,
\code
{
9
}
is slowest and produces the most. The
default value is
\code
{
6
}
. Raises the
\exception
{
zlib.
error
}
default value is
\code
{
6
}
. Raises the
\exception
{
error
}
exception if any error occurs.
exception if any error occurs.
\end{funcdesc}
\end{funcdesc}
...
@@ -43,17 +49,19 @@ exception if any error occurs.
...
@@ -43,17 +49,19 @@ exception if any error occurs.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
, value
}}
\begin{funcdesc}
{
crc32
}{
string
\optional
{
, value
}}
Computes a CRC (Cyclic Redundancy Check) sum of
\var
{
string
}
. If
Computes a CRC (Cyclic Redundancy Check)
%
\var
{
value
}
is present, it is used as the starting value of the
\index
{
Cyclic Redundancy Check
}
checksum; otherwise, a fixed default value is used. This allows
checksum of
\var
{
string
}
. If
computing a running checksum over the concatenation of several
\var
{
value
}
is present, it is used as the starting value of the
input strings. The algorithm is not cryptographically strong, and
checksum; otherwise, a fixed default value is used. This allows
should not be used for authentication or digital signatures.
computing a running checksum over the concatenation of several
input strings. The algorithm is not cryptographically strong, and
should not be used for authentication or digital signatures.
\end{funcdesc}
\end{funcdesc}
\begin{funcdesc}
{
decompress
}{
string
}
\begin{funcdesc}
{
decompress
}{
string
}
Decompresses the data in
\var
{
string
}
, returning a string containing
Decompresses the data in
\var
{
string
}
, returning a string containing
the uncompressed data. Raises the
\exception
{
zlib.
error
}
exception if any
the uncompressed data. Raises the
\exception
{
error
}
exception if any
error occurs.
error occurs.
\end{funcdesc}
\end{funcdesc}
...
@@ -66,41 +74,41 @@ alone.
...
@@ -66,41 +74,41 @@ alone.
Compression objects support the following methods:
Compression objects support the following methods:
\begin{
funcdesc}
{
compress
}{
string
}
\begin{
methoddesc}
[Compress]
{
compress
}{
string
}
Compress
\var
{
string
}
, returning a string containing compressed data
Compress
\var
{
string
}
, returning a string containing compressed data
for at least part of the data in
\var
{
string
}
. This data should be
for at least part of the data in
\var
{
string
}
. This data should be
concatenated to the output produced by any preceding calls to the
concatenated to the output produced by any preceding calls to the
\method
{
compress()
}
method. Some input may be kept in internal buffers
\method
{
compress()
}
method. Some input may be kept in internal buffers
for later processing.
for later processing.
\end{
func
desc}
\end{
method
desc}
\begin{
funcdesc}
{
flush
}{}
\begin{
methoddesc}
[Compress]
{
flush
}{}
All pending input is processed, and an string containing the remaining
All pending input is processed, and an string containing the remaining
compressed output is returned. After calling
\method
{
flush()
}
, the
compressed output is returned. After calling
\method
{
flush()
}
, the
\method
{
compress()
}
method cannot be called again; the only realistic
\method
{
compress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{
func
desc}
\end{
method
desc}
Decompression objects support the following methods:
Decompression objects support the following methods:
\begin{
funcdesc}
{
decompress
}{
string
}
\begin{
methoddesc}
[Decompress]
{
decompress
}{
string
}
Decompress
\var
{
string
}
, returning a string containing the
Decompress
\var
{
string
}
, returning a string containing the
uncompressed data corresponding to at least part of the data in
uncompressed data corresponding to at least part of the data in
\var
{
string
}
. This data should be concatenated to the output produced
\var
{
string
}
. This data should be concatenated to the output produced
by any preceding calls to the
by any preceding calls to the
\method
{
decompress()
}
method. Some of the input data may be preserved
\method
{
decompress()
}
method. Some of the input data may be preserved
in internal buffers for later processing.
in internal buffers for later processing.
\end{
func
desc}
\end{
method
desc}
\begin{
funcdesc}
{
flush
}{}
\begin{
methoddesc}
[Decompress]
{
flush
}{}
All pending input is processed, and a string containing the remaining
All pending input is processed, and a string containing the remaining
uncompressed output is returned. After calling
\method
{
flush()
}
, the
uncompressed output is returned. After calling
\method
{
flush()
}
, the
\method
{
decompress()
}
method cannot be called again; the only realistic
\method
{
decompress()
}
method cannot be called again; the only realistic
action is to delete the object.
action is to delete the object.
\end{
func
desc}
\end{
method
desc}
\begin{seealso}
\begin{seealso}
\seemodule
{
gzip
}{
reading and writing
\
file
{
gzip
}
-format files
}
\seemodule
{
gzip
}{
reading and writing
\
program
{
gzip
}
-format files
}
\end{seealso}
\end{seealso}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment