(CkPython) SFTP Read Text File

Demonstrates how to open a text file on the SSH server and read text.

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 assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

sftp = chilkat.CkSFtp()

# Set some timeouts, in milliseconds:
sftp.put_ConnectTimeoutMs(5000)
sftp.put_IdleTimeoutMs(15000)

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
hostname = "sftp.example.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 file for reading.

handle = sftp.openFile("myTest.txt","readOnly","openExisting")
if (sftp.get_LastMethodSuccess() != True):
    print(sftp.lastErrorText())
    sys.exit()

# Assume the file we are reading contains the following text:
# abcdefghijklmnopqrstuvwxyz1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
# (in ANSI format -- i.e. one byte per char).

# Read 26 bytes:

sText = sftp.readFileText(handle,26,"ansi")
if (sftp.get_LastMethodSuccess() != True):
    print(sftp.lastErrorText())
    sys.exit()

# Should print "abcdefghijklmnopqrstuvwxyz"
print(sText)

# Read the next 10 bytes.
sText = sftp.readFileText(handle,10,"ansi")
if (sftp.get_LastMethodSuccess() != True):
    print(sftp.lastErrorText())
    sys.exit()

# Should print "1234567890"
print(sText)

# Read the next 26 bytes.
sText = sftp.readFileText(handle,26,"ansi")
if (sftp.get_LastMethodSuccess() != True):
    print(sftp.lastErrorText())
    sys.exit()

# Should print "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
print(sText)

# Close the file.
success = sftp.CloseHandle(handle)
if (success != True):
    print(sftp.lastErrorText())
    sys.exit()

print("Success.")