CkPython

Detect End-of-File on a Remote SFTP File

Demonstrates the Chilkat SFtp.Eof method, which returns whether the most recent read for a handle received the SFTP end-of-file status. The only argument is the handle. This example reads until Eof is true.

Background: The timing here is worth understanding: reading exactly through the final byte does not immediately set EOF. The next read succeeds, returns zero bytes, sets the status to SSH_FX_EOF, and only then does Eof report true. That is why the loop tests Eof after each read rather than assuming a short read means the end — a short read can also just be the server returning less than requested.

Chilkat CkPython Downloads

Download Chilkat for CkPython

CkPython

import sys
import chilkat

success = False

#  Demonstrates the SFtp.Eof method, which returns whether the most recent read for a handle
#  received the SFTP end-of-file status.  The only argument is the handle.

sftp = chilkat.CkSFtp()

#  Connect, authenticate, and initialize the SFTP subsystem.
port = 22
success = sftp.Connect("sftp.example.com",port)
if (success == False):
    print(sftp.lastErrorText())
    sys.exit()

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
if (success == False):
    print(sftp.lastErrorText())
    sys.exit()

success = sftp.InitializeSftp()
if (success == False):
    print(sftp.lastErrorText())
    sys.exit()

handle = sftp.openFile("subdir/data.txt","readOnly","openExisting")
if (sftp.get_LastMethodSuccess() == False):
    print(sftp.lastErrorText())
    sys.exit()

#  Read until Eof reports the end of the file.  Note that reading exactly through the final byte
#  does not set EOF; the next read returns zero bytes and then Eof becomes true.
sbContent = chilkat.CkStringBuilder()
chunkSize = 4096
reading = True
while reading :
    chunk = sftp.readFileText(handle,chunkSize,"utf-8")
    if (sftp.LastReadFailed(handle)):
        print(sftp.lastErrorText())
        sys.exit()

    sbContent.Append(chunk)
    reading = not sftp.Eof(handle)

success = sftp.CloseHandle(handle)
if (success == False):
    print(sftp.lastErrorText())
    sys.exit()

print(sbContent.getAsString())

sftp.Disconnect()