@@ -131,9 +131,6 @@ Differences with zlib and gzip modules
131
131
in ``isal_zlib `` and ``igzip `` this is the **lowest compression level **.
132
132
This is a design choice that was inherited from the ISA-L library.
133
133
+ Compression levels range from 0 to 3, not 1 to 9.
134
- + ``igzip `` contains a class ``IGzipFile `` instead of ``GzipFile ``. Since the
135
- compression levels are not compatible, a difference in naming was chosen to
136
- reflect this.
137
134
+ ``zlib.Z_DEFAULT_STRATEGY ``, ``zlib.Z_RLE `` etc. are exposed as
138
135
``isal_zlib.Z_DEFAULT_STRATEGY ``, ``isal_zlib.Z_RLE `` etc. for compatibility
139
136
reasons. However, ``isal_zlib `` only supports a default strategy and will
@@ -142,14 +139,11 @@ Differences with zlib and gzip modules
142
139
``isal_zlib `` supports memory levels smallest, small, medium, large and
143
140
largest. These have been mapped to levels 1, 2-3, 4-6, 7-8 and 9. So
144
141
``isal_zlib `` can be used with zlib compatible memory levels.
145
- + ``isal_zlib `` has a ``compressobj `` and ``decompressobj `` implementation.
146
- However, the unused_data and unconsumed_tail for the Decompress object, only
147
- work properly when using gzip compatible compression. (25 <= wbits <= 31).
148
- + The flush implementation for the Compress object behavious differently from
149
- the zlib equivalent. The flush implementation is sufficient for
150
- the ``igzip `` module to work 100% in compliance with the ``gzip `` tests from
151
- CPython. It does not however work for all the ``zlib `` compliance tests
152
- (see above). This is an area that still needs work.
142
+ + ``isal_zlib `` only supports ``NO_FLUSH ``, ``SYNC_FLUSH ``, ``FULL_FLUSH `` and
143
+ ``FINISH_FLUSH ``. Other flush modes are not supported and will raise errors.
144
+ + ``igzip.open `` returns a class ``IGzipFile `` instead of ``GzipFile ``. Since
145
+ the compression levels are not compatible, a difference in naming was chosen
146
+ to reflect this. ``igzip.GzipFile `` does exist as an alias however.
153
147
154
148
Contributing
155
149
------------
0 commit comments