(Chilkat2-Python) SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files.

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

import sys
import chilkat2

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

# Important: It is helpful to send the contents of the
# sftp.LastErrorText property when requesting support.

sftp = chilkat2.SFtp()

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

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
hostname = "www.my-sftp-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()

# Open a directory on the server...
# Paths starting with a slash are "absolute", and are relative 
# to the root of the file system. Names starting with any other 
# character are relative to the user's default directory (home directory).
# A path component of ".." refers to the parent directory, 
# and "." refers to the current directory. 
handle = sftp.OpenDir(".")
if (sftp.LastMethodSuccess != True):
    print(sftp.LastErrorText)
    sys.exit()

# Download the directory listing:
# dirListing is a CkSFtpDir
dirListing = sftp.ReadDir(handle)
if (sftp.LastMethodSuccess != True):
    print(sftp.LastErrorText)
    sys.exit()

# Close the handle for the directory listing.
success = sftp.CloseHandle(handle)
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# Iterate over the files.
i = 0
n = dirListing.NumFilesAndDirs
while i < n :
    # fileObj is a CkSFtpFile
    fileObj = dirListing.GetFileObject(i)

    print(fileObj.Filename)
    print(fileObj.FileType)
    print("Size in bytes: " + str(fileObj.Size32))
    print("----")

    i = i + 1

print("Success.")