(Chilkat2-Python) Async SFTP Progress Info

Demonstrates checking for progress info updates when running a task asynchronously. This example demonstrates an SFTP download.

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

import sys
import chilkat2

# All Chilkat classes can be unlocked at once at the beginning of a program
# by calling UnlockBundle.  It requires a Bundle unlock code.
chilkatGlob = chilkat2.Global()
success = chilkatGlob.UnlockBundle("Anything for 30-day trial.")
if (success != True):
    print(chilkatGlob.LastErrorText)
    sys.exit()

sftp = chilkat2.SFtp()

# Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 15000
sftp.IdleTimeoutMs = 15000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
hostname = "www.my-ssh-server.com"
port = 22
success = sftp.Connect(hostname,port)
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# --------------------
# Download a file
# --------------------
localFilePath = "c:/temp/hamlet.xml"
remoteFilePath = "subdir1/subdir2/hamlet.xml"

# Call the async version of the DownloadFileByName method to return a task object.
# The task object is loaded, but is in the Inert state -- meaning it is
# not yet scheduled to run on Chilkat's background thread pool.
# task is a CkTask
task = sftp.DownloadFileByNameAsync(remoteFilePath,localFilePath)
if (sftp.LastMethodSuccess == False):
    print(sftp.LastErrorText)
    sys.exit()

# Before starting the task, tell it to keep an in-memory log of what would've been
# ProgressInfo callbacks.
task.KeepProgressLog = True

# Schedule the task for running on the thread pool.  This changes the task's state
# from Inert to Live.
success = task.Run()
if (success != True):
    print(task.LastErrorText)

    sys.exit()

# The application is now free to do anything else
# while the file is being downloaded.

# For this example, we'll simply sleep and periodically
# check to see if the download is finished, and report the progress
# along the way.
curPctDone = 0

while task.Finished != True :

    if (task.PercentDone != curPctDone):
        curPctDone = task.PercentDone
        print(str(curPctDone) + " percent done")

    # Check the progress info log.
    # Emit any log entries..
    while (task.ProgressLogSize > 0) :
        # Get the 1st entry, emit it, and then remove it..
        name = task.ProgressInfoName(0)
        value = task.ProgressInfoValue(0)

        # Entries reporting the received byte count will have the name "RcvByteCount"
        # Entries reporting the current bytes-per-second will have the name "RcvBytesPerSec"

        print(name + ": " + value)
        task.RemoveProgressInfo(0)

    # Sleep 100 ms.
    task.SleepMs(100)

# Just in case there are any remaining entries...
while (task.ProgressLogSize > 0) :
    # Get the 1st entry, emit it, and then remove it..
    name = task.ProgressInfoName(0)
    value = task.ProgressInfoValue(0)
    print(name + ": " + value)
    task.RemoveProgressInfo(0)

# A finished task could be one that was canceled, aborted, or truly finished.  

# If the task was "canceled", it was canceled prior to actually starting.  This could
# happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
# background thread pool scheduler.  

# If the task was "aborted", it indicates that it was canceled while running in a background thread.  
# The ResultErrorText will likely indicate that the task was aborted.

# If the task "completed", then it ran to completion, but the actual success/failure of the method
# is determined by the result obtained via a GetResult* method.  (A "completed" task will
# have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
# been aborted or canceled:
if (task.StatusInt != 7):
    print("Task did not complete.")
    print("task status: " + task.Status)

    sys.exit()

# The DownloadFileByName method returns a boolean.  Therefore, after the task is finished,
# we can get the boolean result by calling GetResultBool.  This is the return value had
# we called DownloadFileByName synchronously.
success = task.GetResultBool()
if (success != True):
    # The task's ResultErrorText contains what would have been in the LastErrorText property had
    # the DownloadFileByName method been called synchronously.
    print(task.ResultErrorText)
else:
    print("File downloaded asynchronously.")