Secure Copy with Progressbar

Hello @ktbyers,

I am trying to improve my code and add the progressbar to the file_transfer function. I was wondering how can I calculate the sent argument? I found this answer on SOF and this demo on GitHub, but I can’t figure out how to use it with my provided code.

from os.path import getsize

from netmiko import ConnectHandler, file_transfer, progress_bar

router = {
    "device_type": "cisco_ios",
    "host": "sandbox-iosxe-latest-1.cisco.com",
    "username": "developer",
    "password": "C1sco12345",
    "port": 22,
    "verbose": True,
    "conn_timeout": 12,
    "fast_cli": False,
    "session_log": "sandbox-iosxe-latest-1.cisco.com.log",
}

src_file = dest_file = input("Name of file to copy: ")

with ConnectHandler(**router) as net_connect:
    scp = net_connect.send_config_set(config_commands=["ip scp server enable"])
    transfer = file_transfer(
        net_connect,
        source_file=src_file,
        dest_file=dest_file,
        file_system="flash:",
        direction="put",
        overwrite_file=True,
        socket_timeout=100.0,
        progress=progress_bar(
            filename=src_file,
            size=getsize(src_file),
            sent=sent,  # How to calculate? What should be placed here?
        ),
    )

Thanks a lot.

[ktbyers]

Okay, nice…yeah, we should update Netmiko’s default progress bar to use “rich”.

[Tes3awy]

@Tes3awy Did you work out a solution?

Finally, I had the time to find a pretty method of printing the progress in terminal.

from rich import print

def progress_bar(filename, size, sent, peername):
    print(
        f"[blue]{filename.decode('ascii')} progress[/blue] on {peername[0]}:{peername[1]}: {float(sent) / float(size) * 100:.1f}%",
        end=" \r",
        flush=True,
    )

This is actually the same as in the scp.py README but using print() from rich instead of sys.stdout.write() to have a colored output in the terminal.

The only drawback of using end=" \r" is that the print statement after the progress_bar print statement overwrites it.

UPDATE:

A simple workaround to keep the progress bar print statement in the terminal and not to be overwritten by the next print statement is to prepend a \n to the latter.

from rich import print

def progress_bar(filename, size, sent, peername):
    print(
        f"[blue]{filename.decode('ascii')} progress[/blue] on {peername[0]}: {float(sent) / float(size) * 100:.1f}%",
        end=" \r",
        flush=True,
    )

print(f"\n[green]Transferred {bin_file} to host successfully")

file.bin progress on 192.168.1.1: 100.0% 
Transferred file.bin to host successfully