Chilkat2-Python

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Chilkat2-Python

import sys
import chilkat2

success = False

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

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 = "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()

# Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
# For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
bFollowLinks = True
bIsHandle = False
fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle)
if (fileSize < 0):
    print(sftp.LastErrorText)
    sys.exit()

print("file size = " + str(fileSize))

# If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
# You can convert the string to a 64-bit integer in your programming language.
fileSizeStr = sftp.GetFileSizeStr("someDir/someFile.dat",bFollowLinks,bIsHandle)
if (sftp.LastMethodSuccess == False):
    print(sftp.LastErrorText)
    sys.exit()

print("file size = " + fileSizeStr)

# You can alternatively get the size with an open file handle.
handle = sftp.OpenFile("someDir/someFile.dat","readOnly","openExisting")
if (sftp.LastMethodSuccess != True):
    print(sftp.LastErrorText)
    sys.exit()

# Get the size using the handle.
bIsHandle = True
fileSize = sftp.GetFileSize32("someDir/someFile.dat",bFollowLinks,bIsHandle)
if (fileSize < 0):
    print(sftp.LastErrorText)
    sys.exit()

print("file size = " + str(fileSize))

# -----------------------------------------------------------------------------
# Don't forget to close the file handle.
# Otherwise open handles will accumulate on the server until eventually a limit
# is reached and the server will fail on a call to OpenFile.
# -----------------------------------------------------------------------------

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