Adding a progress callback to fabric.operations.put()

Description

Utilizes the existing callback functionallity of paramiko. Considered adding a with_progress flag, but decided to leave it abstract so users can implement their own progress indicator

The arguments for the callback (positional only) are: file name, bytes transferred so far, total bytes to transfer. Including file name in there allows this to be used with sftp.put_dir as well as just sftp.put

Example Usage (with progressbar.ProgressBar):

fname = "my-big-file.tar.gz"
pbar = progressbar.ProgressBar(maxval=os.path.getsize(fname))
def progress_cb(name, done, total):
if pbar.start_time is None:
pbar.start()
pbar.update(done)
put(fname, remote_path, callback=progress_cb)
pbar.finish()

Example Output:

$ fab -H my-host my_task:some,args
[my-host] Executing task 'my_task'
[my-host] put:
/home/mumrah/my-big-file.tar.gz
-> /tmp/my-big-file.tar.gz
9% |#########

Can be useful for large transfers

---

Originally submitted by David Arthur (mumrah) on 2011-07-23 at 04:44pm EDT

Attachments

• 0001-Adding-a-progress-callback-for-put.patch
• 0002-Fixed-a-bug-with-callback-None-oops.patch

Relations

• Related to #236: Add download/upload information for operations get/put

[sxalexander]

+1

[embassem]

+1