Chilkat2-Python

Clear the SFTP Session Log

Demonstrates the Chilkat SFtp.ClearSessionLog method, which clears the in-memory text stored in the SessionLog property. It takes no arguments.

Background: With session logging enabled, the SessionLog accumulates a running record of the session's activity that is invaluable for diagnosing a failed transfer. Over a long-lived session that log grows unbounded, so clearing it frees memory — and, more usefully, lets you capture the log for one specific operation in isolation by clearing it just before and reading it just after.

Chilkat Chilkat2-Python Downloads

Download Chilkat for Chilkat2-Python

Chilkat2-Python

import sys
import chilkat2

success = False

# Demonstrates the SFtp.ClearSessionLog method, which clears the in-memory text stored in the
# SessionLog property.  It takes no arguments.

sftp = chilkat2.SFtp()

# 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()

# When KeepSessionLog is enabled, the SessionLog property accumulates a record of the session's
# activity, which is useful for debugging.
sftp.KeepSessionLog = True

# ... perform operations ...

# Clear the accumulated log, for example before starting a new logical operation whose log you
# want to capture in isolation.
sftp.ClearSessionLog()
print("Session log cleared.")

sftp.Disconnect()