(CkPython) Unzip One File to a Stream

Demonstrates how to unzip a particular file contained within a .zip archive to a Chilkat stream.

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

zip = chilkat.CkZip()

# First open a .zip.
success = zip.OpenZip("qa_data/hamlet.zip")
if (success != True):
    print(zip.lastErrorText())
    sys.exit()

# Find the entry to be unzipped to a stream..
# entry is a CkZipEntry
entry = zip.FirstMatchingEntry("*hamlet.xml")
if (zip.get_LastMethodSuccess() != True):
    print(zip.lastErrorText())
    sys.exit()

# There are three ways we can unzip (inflate) to a stream.
# 
# 1) Set a sink file on the stream object and call UnzipToStream synchronously.
#    This unzips to the stream's sink (which is to simply unzip to a file in the filesystem).
# 
# 2) Create a stream object and call UnzipToStreamAsync.  This starts the unzip in a background
#    thread (after Task.Run is called).  Your application can then read the unzipped (inflated) file
#    directly from the stream.
# 
# 3) (not shown in this example) Unzip to a stream object that is the source of something else.
#    

# ----------------------------------------------------------------
# Case 1: Unzip to a file by setting the sink of streamA to a file.
streamA = chilkat.CkStream()
streamA.put_SinkFile("qa_output/hamletA.xml")

success = entry.UnzipToStream(streamA)
if (success != True):
    print(entry.lastErrorText())

    sys.exit()

# Close the stream to close the output file.
success = streamA.WriteClose()

# ----------------------------------------------------------------
# Case 2a: Uzip to a stream asynchronously. 
streamB = chilkat.CkStream()

# unzipTask is a CkTask
unzipTask = entry.UnzipToStreamAsync(streamB)
if (entry.get_LastMethodSuccess() != True):
    print(entry.lastErrorText())

    sys.exit()

# Start the background unzip thread.
unzipTask.Run()

# Read the stream.  (this is reading the unzipped file data)
sb = chilkat.CkStringBuilder()
while streamB.get_EndOfStream() != True :
    # Each call to ReadSb appends to the contents of sb.
    streamB.ReadSb(sb)

sb.WriteFile("qa_output/hamletB.xml","utf-8",False)

print("Success.")

# ----------------------------------------------------------------
# Case 2b: Uzip to a stream asynchronously and emit output while reading. 
streamC = chilkat.CkStream()

# unzipTask is a CkTask
unzipTask = entry.UnzipToStreamAsync(streamC)
if (entry.get_LastMethodSuccess() != True):
    print(entry.lastErrorText())

    sys.exit()

unzipTask.Run()

while streamC.get_EndOfStream() != True :
    s = streamC.readString()
    print(s)

print("Success.")