---
product: Chilkat
product_version: 11.7.0
language: python
language_label: Python
class: Compression
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/pythonCompressionRef.html
---
# Chilkat Compression — Python — v11.7.0

> Chilkat 11.7.0 · language=python · class=Compression
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Compression.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/python/guide.md`.

## Purpose

**Compress and decompress bytes, text, files, and streams with a flexible API.**

`Chilkat.Compression` provides a general-purpose API for compressing and decompressing data in memory, files, and streams. It supports multiple algorithms, text charset conversion, encoded output, chunked processing, and streaming operations for large data.

**Multiple algorithms**

Supports `deflate`, `zlib`, `bzip2`, and `lzw`.

**Flexible data types**

Work with byte arrays, strings, `BinData`, `StringBuilder`, files, and streams.

**Chunked processing**

Process data incrementally with `FirstChunk` and `LastChunk` for chunk-aware methods.

**Encoded output**

Return compressed bytes as text using encodings such as `base64`, `hex`, and others.

**Streaming support**

Compress or decompress large files and streams with stable memory usage.

**Compression + encryption**

Combine compression and encryption in file workflows with integrated methods.

**Tip:** For text compression, explicitly set `Charset = "utf-8"` unless another encoding is required. For encoded compressed data, set `EncodingMode` to the desired output format.

For an extended overview, see [Compression Class Overview](https://www.chilkatsoft.com/compression_class_overview.asp). See also [Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp) for supported encoded output formats.

## Object creation, unlocking and error handling

**Object Creation**

```python
obj = chilkat2.Compression()
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Python.

Minimal complete program:

```python
import chilkat2

# Required once per process. Any string unlocks a 30-day trial; use your purchased code in production.
glob = chilkat2.Global()
if not glob.UnlockBundle("Anything for 30-day trial"):
    print(glob.LastErrorText)
    raise SystemExit(1)

compression = chilkat2.Compression()

success = compression.CompressFile("<srcPath>", "<destPath>")
if not success:
    print(compression.LastErrorText)   # full diagnostic of what went wrong
    raise SystemExit(1)
```

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `bool VerboseLogging` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Algorithm` | property, read/write | `string Algorithm` |
| `Charset` | property, read/write | `string Charset` |
| `DeflateLevel` | property, read/write | `int DeflateLevel` |
| `EncodingMode` | property, read/write | `string EncodingMode` |
| `FirstChunk` | property, read/write | `bool FirstChunk` |
| `LastChunk` | property, read/write | `bool LastChunk` |
| `UncommonOptions` | property, read/write | `string UncommonOptions` |
| `CompressBd` | method | `bool CompressBd(BinData bd)` |
| `CompressBd2` | method | `bool CompressBd2(BinData bdIn, BinData bdOut)` |
| `CompressBytes` | method | `memoryview CompressBytes(memoryview data)` |
| `CompressBytesENC` | method | `string CompressBytesENC(memoryview data)` |
| `CompressEncryptFile` | method | `bool CompressEncryptFile(JsonObject cryptParams, string srcPath, string destPath)` |
| `CompressFile` | method | `bool CompressFile(string srcPath, string destPath)` |
| `CompressSb` | method | `bool CompressSb(StringBuilder sb, BinData binData)` |
| `CompressStr` | method | `bool CompressStr(string str, BinData bd)` |
| `CompressStream` | method | `bool CompressStream(Stream strm)` |
| `CompressString` | method | `memoryview CompressString(string str)` |
| `CompressStringENC` | method | `string CompressStringENC(string str)` |
| `DecompressBd` | method | `bool DecompressBd(BinData bd)` |
| `DecompressBd2` | method | `bool DecompressBd2(BinData bdIn, BinData bdOut)` |
| `DecompressBytes` | method | `memoryview DecompressBytes(memoryview data)` |
| `DecompressBytesENC` | method | `memoryview DecompressBytesENC(string encodedCompressedData)` |
| `DecompressFile` | method | `bool DecompressFile(string srcPath, string destPath)` |
| `DecompressSb` | method | `bool DecompressSb(BinData binData, StringBuilder sb)` |
| `DecompressStream` | method | `bool DecompressStream(Stream strm)` |
| `DecompressString` | method | `string DecompressString(memoryview data)` |
| `DecompressStringENC` | method | `string DecompressStringENC(string encodedCompressedData)` |
| `DecryptDecompressFile` | method | `bool DecryptDecompressFile(JsonObject cryptParams, string srcPath, string destPath)` |
| `LoadTaskCaller` | method | `bool LoadTaskCaller(Task task)` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Compression.Algorithm

`Chilkat 11.7.0 · python · Compression · Algorithm · property · read/write`

```python
string Algorithm
```

Specifies the compression algorithm to use. Supported values are `deflate`, `zlib`, `gzip`, `bzip2`, and `lzw`.

The `zlib` option is the deflate algorithm with a zlib header.

The `gzip` option (starting in v11.7.0) is the deflate algorithm in the gzip format (RFC 1952): a gzip header, the deflate data, and a trailer with the CRC-32 and size of the uncompressed data. When decompressing in one call, the CRC-32 and size are checked. Before v11.7.0, `gzip` was not recognized and was treated as `deflate`.

**Note:** `ppmd` is deprecated and should not be used. It was only available on 32-bit systems and specifically used the J variant. New applications should use one of the supported algorithms listed above.

### Compression.Charset

`Chilkat 11.7.0 · python · Compression · Charset · property · read/write`

```python
string Charset
```

**Full documentation for this property (same in every language):** [How Character Encoding (Charset) Affects Compression and Decompression](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/how_charset_affects_compression.md) · [Full List of Character Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.

The current default is the computer’s ANSI charset, such as Windows-1252 on many Western Windows systems. However, most modern applications should explicitly set this property to `utf-8`.

**Recommendation:** Set `Charset = "utf-8"` unless you specifically need compatibility with another encoding.

### Compression.DeflateLevel

`Chilkat 11.7.0 · python · Compression · DeflateLevel · property · read/write · since 9.5.0.73`

```python
int DeflateLevel
```

Sets the compression level used by the `deflate` and `zlib` algorithms.

- `0` means no compression.
- `9` means maximum compression.
- The default value is `6`.

Higher values may produce smaller output but can require more processing time.

### Compression.EncodingMode

`Chilkat 11.7.0 · python · Compression · EncodingMode · property · read/write`

```python
string EncodingMode
```

**Full documentation for this property (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Specifies the text encoding used by methods whose names end in `ENC`, such as `CompressBytesENC` and `DecompressStringENC`.

Compression methods ending in `ENC` return compressed binary data as an encoded string. Decompression methods ending in `ENC` expect the input string to use this same encoding.

Valid values include:

- `base64`
- `hex`
- `url`
- `quoted-printable`

### Compression.FirstChunk

`Chilkat 11.7.0 · python · Compression · FirstChunk · property · read/write · since 11.0.0`

```python
bool FirstChunk
```

Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.

The default value is `True`.

When both `FirstChunk` and `LastChunk` are `True`, the method call is treated as a complete, single-call compression or decompression operation.

### Compression.LastChunk

`Chilkat 11.7.0 · python · Compression · LastChunk · property · read/write · since 11.0.0`

```python
bool LastChunk
```

Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.

The default value is `True`.

When both `FirstChunk` and `LastChunk` are `True`, the input is treated as the complete data set and processed in a single call.

### Compression.UncommonOptions

`Chilkat 11.7.0 · python · Compression · UncommonOptions · property · read/write · since 11.0.0`

```python
string UncommonOptions
```

Provides a way to enable specialized or uncommon behavior. This property normally remains empty.

It may be set to a comma-separated list of keywords.

Supported option:

- `Crypt2CompressHdr` — Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.

## Methods

### Compression.CompressBd

`Chilkat 11.7.0 · python · Compression · CompressBd · method · since 9.5.0.66`

```python
bool CompressBd(BinData bd)
```

Compresses the data contained in a `BinData` object.

The `BinData` object is modified to contain the compressed result.

This method is not `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `CompressBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressBd2

`Chilkat 11.7.0 · python · Compression · CompressBd2 · method · since 11.0.0`

```python
bool CompressBd2(BinData bdIn, BinData bdOut)
```

Compresses the data in one `BinData` object and appends the compressed output to another `BinData` object.

The input `BinData` is not modified.

This method is `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `CompressBd2Async` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressBytes

`Chilkat 11.7.0 · python · Compression · CompressBytes · method`

```python
memoryview CompressBytes(memoryview data)
```

Compresses a byte array and returns the compressed bytes.

This method is `FirstChunk` / `LastChunk` aware.

Returns an empty (zero-length) memoryview on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `CompressBytesAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressBytesENC

`Chilkat 11.7.0 · python · Compression · CompressBytesENC · method`

```python
string CompressBytesENC(memoryview data)
```

Compresses a byte array and returns the compressed result as an encoded string.

The output encoding is controlled by `EncodingMode`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `CompressBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressEncryptFile

`Chilkat 11.7.0 · python · Compression · CompressEncryptFile · method · since 9.5.0.99`

```python
bool CompressEncryptFile(JsonObject cryptParams, string srcPath, string destPath)
```

Compresses and encrypts a file, writing the result to a destination file.

The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.

Returns True for success, False for failure.

Async variant: `CompressEncryptFileAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressFile

`Chilkat 11.7.0 · python · Compression · CompressFile · method`

```python
bool CompressFile(string srcPath, string destPath)
```

Compresses a source file and writes the compressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.

Returns True for success, False for failure.

Async variant: `CompressFileAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressSb

`Chilkat 11.7.0 · python · Compression · CompressSb · method · since 9.5.0.73`

```python
bool CompressSb(StringBuilder sb, BinData binData)
```

Compresses the text contained in a `StringBuilder` and appends the compressed bytes to a `BinData` object.

Text is converted to bytes according to the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `CompressSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressStr

`Chilkat 11.7.0 · python · Compression · CompressStr · method · since 11.0.0`

```python
bool CompressStr(string str, BinData bd)
```

Compresses a string and appends the compressed bytes to a `BinData` object.

The string is converted to bytes using the charset specified by the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `CompressStrAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressStream

`Chilkat 11.7.0 · python · Compression · CompressStream · method · since 9.5.0.56`

```python
bool CompressStream(Stream strm)
```

Compresses data from a stream source and writes the compressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.

Returns True for success, False for failure.

Async variant: `CompressStreamAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressString

`Chilkat 11.7.0 · python · Compression · CompressString · method`

```python
memoryview CompressString(string str)
```

Compresses a string and returns the compressed bytes.

The string is converted to bytes using the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns an empty (zero-length) memoryview on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `CompressStringAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.CompressStringENC

`Chilkat 11.7.0 · python · Compression · CompressStringENC · method`

```python
string CompressStringENC(string str)
```

Compresses a string and returns the compressed result as an encoded string.

The string is first converted to bytes using `Charset`, then compressed, and finally encoded according to `EncodingMode`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `CompressStringENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressBd

`Chilkat 11.7.0 · python · Compression · DecompressBd · method · since 9.5.0.66`

```python
bool DecompressBd(BinData bd)
```

Decompresses the compressed data contained in a `BinData` object.

The `BinData` object is modified to contain the decompressed result.

This method is not `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `DecompressBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressBd2

`Chilkat 11.7.0 · python · Compression · DecompressBd2 · method · since 11.0.0`

```python
bool DecompressBd2(BinData bdIn, BinData bdOut)
```

Decompresses the data in one `BinData` object and appends the decompressed output to another `BinData` object.

The input `BinData` is not modified.

This method is `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `DecompressBd2Async` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressBytes

`Chilkat 11.7.0 · python · Compression · DecompressBytes · method`

```python
memoryview DecompressBytes(memoryview data)
```

Decompresses compressed byte data and returns the decompressed bytes.

This method is `FirstChunk` / `LastChunk` aware.

Returns an empty (zero-length) memoryview on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `DecompressBytesAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressBytesENC

`Chilkat 11.7.0 · python · Compression · DecompressBytesENC · method`

```python
memoryview DecompressBytesENC(string encodedCompressedData)
```

Decompresses compressed data supplied as an encoded string and returns the decompressed bytes.

The input string is decoded according to `EncodingMode` before being decompressed.

Returns an empty (zero-length) memoryview on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `DecompressBytesENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressFile

`Chilkat 11.7.0 · python · Compression · DecompressFile · method`

```python
bool DecompressFile(string srcPath, string destPath)
```

Decompresses a source file and writes the decompressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.

Returns True for success, False for failure.

Async variant: `DecompressFileAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressSb

`Chilkat 11.7.0 · python · Compression · DecompressSb · method · since 9.5.0.73`

```python
bool DecompressSb(BinData binData, StringBuilder sb)
```

Decompresses compressed data from a `BinData` object and appends the resulting text to a `StringBuilder`.

The decompressed bytes are converted to text using the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns True for success, False for failure.

Async variant: `DecompressSbAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressStream

`Chilkat 11.7.0 · python · Compression · DecompressStream · method · since 9.5.0.56`

```python
bool DecompressStream(Stream strm)
```

Decompresses data from a stream source and writes the decompressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.

Returns True for success, False for failure.

Async variant: `DecompressStreamAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecompressString

`Chilkat 11.7.0 · python · Compression · DecompressString · method`

```python
string DecompressString(memoryview data)
```

Decompresses compressed byte data and returns the resulting string.

The decompressed bytes are converted to text using the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

### Compression.DecompressStringENC

`Chilkat 11.7.0 · python · Compression · DecompressStringENC · method`

```python
string DecompressStringENC(string encodedCompressedData)
```

Decompresses compressed data supplied as an encoded string and returns the resulting text.

The input string is decoded according to `EncodingMode`, then decompressed. The resulting bytes are converted to text using `Charset`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

Async variant: `DecompressStringENCAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.DecryptDecompressFile

`Chilkat 11.7.0 · python · Compression · DecryptDecompressFile · method · since 9.5.0.99`

```python
bool DecryptDecompressFile(JsonObject cryptParams, string srcPath, string destPath)
```

Decrypts and decompresses a file, writing the restored data to a destination file.

This is the reverse operation of `CompressEncryptFile`.

Returns True for success, False for failure.

Async variant: `DecryptDecompressFileAsync` — same arguments, returns a `Task` (see Async variants below).

### Compression.LoadTaskCaller

`Chilkat 11.7.0 · python · Compression · LoadTaskCaller · method · since 9.5.0.80`

```python
bool LoadTaskCaller(Task task)
```

Loads the caller of the task's async method.

Returns True for success, False for failure.

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```python
Task CompressBdAsync(BinData bd)
Task CompressBd2Async(BinData bdIn, BinData bdOut)
Task CompressBytesAsync(memoryview data)
Task CompressBytesENCAsync(memoryview data)
Task CompressEncryptFileAsync(JsonObject cryptParams, string srcPath, string destPath)
Task CompressFileAsync(string srcPath, string destPath)
Task CompressSbAsync(StringBuilder sb, BinData binData)
Task CompressStrAsync(string str, BinData bd)
Task CompressStreamAsync(Stream strm)
Task CompressStringAsync(string str)
Task CompressStringENCAsync(string str)
Task DecompressBdAsync(BinData bd)
Task DecompressBd2Async(BinData bdIn, BinData bdOut)
Task DecompressBytesAsync(memoryview data)
Task DecompressBytesENCAsync(string encodedCompressedData)
Task DecompressFileAsync(string srcPath, string destPath)
Task DecompressSbAsync(BinData binData, StringBuilder sb)
Task DecompressStreamAsync(Stream strm)
Task DecompressStringENCAsync(string encodedCompressedData)
Task DecryptDecompressFileAsync(JsonObject cryptParams, string srcPath, string destPath)
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `BeginCompressBytes` | method | before 11.6.1 | `FirstChunk` |
| `BeginCompressBytesENC` | method | before 11.6.1 | — |
| `BeginCompressString` | method | before 11.6.1 | `FirstChunk` |
| `BeginCompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressBytes` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressBytesENC` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressString` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `EndCompressBytes` | method | before 11.6.1 | — |
| `EndCompressBytesENC` | method | before 11.6.1 | — |
| `EndCompressString` | method | before 11.6.1 | — |
| `EndCompressStringENC` | method | before 11.6.1 | — |
| `EndDecompressBytes` | method | before 11.6.1 | — |
| `EndDecompressBytesENC` | method | before 11.6.1 | — |
| `EndDecompressString` | method | before 11.6.1 | — |
| `EndDecompressStringENC` | method | before 11.6.1 | — |
| `MoreCompressBytes` | method | before 11.6.1 | — |
| `MoreCompressBytesENC` | method | before 11.6.1 | — |
| `MoreCompressString` | method | before 11.6.1 | — |
| `MoreCompressStringENC` | method | before 11.6.1 | — |
| `MoreDecompressBytes` | method | before 11.6.1 | — |
| `MoreDecompressBytesENC` | method | before 11.6.1 | — |
| `MoreDecompressString` | method | before 11.6.1 | — |
| `MoreDecompressStringENC` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/python/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/python/classes/JsonObject.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/python/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/python/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/python/classes/Task.md)

