Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Chilkat2-Python Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Chilkat2-Python) Async FTP Progress Info

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

Chilkat2 Python Downloads

Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

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

ftp = chilkat2.Ftp2()

ftp.Hostname = "ftp.someFtpServer.com"
success = ftp.ConnectOnly()
if (success != True):
    print(ftp.LastErrorText)
    sys.exit()

ftp.Username = "myLogin"
ftp.Password = "myPassword"
success = ftp.LoginAfterConnectOnly()
if (success != True):
    print(ftp.LastErrorText)
    sys.exit()

# Change to the remote directory where the file is located.
# This step is only necessary if the file is not in the root directory
# for the FTP account.
success = ftp.ChangeRemoteDir("someRemoteDirectory")
if (success != True):
    print(ftp.LastErrorText)
    sys.exit()

localFilename = "/temp/romeo.xml"
remoteFilename = "romeo.xml"

# --------------------
# Download a file
# --------------------

# Call the async version of the GetFile 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 = ftp.GetFileAsync(remoteFilename,localFilename)
if (ftp.LastMethodSuccess == False):
    print(ftp.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 GetFile 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 GetFile synchronously.
success = task.GetResultBool()
if (success != True):
    # The task's ResultErrorText contains what would have been in the LastErrorText property had
    # the GetFile method been called synchronously.
    print(task.ResultErrorText)
else:
    print("File downloaded asynchronously.")

success = ftp.Disconnect()

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.