rsyncwrap 0.1.1

A python wrapper of rsync that yields stats updates.

A library for using rsync from python.

from pathlib import Path

from rsyncwrap import rsyncwrap

source = Path('/the_source')
dest = Path('/the_destination')

for update in rsyncwrap(source, dest):
    print(update)

rsyncwrap yields progress updates via Stats objects that have the following properties:

• in_progress_stats: An instance of TransferStats (see below for a description).
• transferring_path: An instance of pathlib.Path that indicates the path that is currently transferring.
• last_completed_path: An instance of pathlib.Path that indicates the last path to finish transferring.
• completed_paths: A dictionary with pathlib.Path keys and TransferStats objects as values. The value for each key is the stats for that completed transfer.
• last_completed_path_stats: An instance of TransferStats for the last completed transfer.
• total_transferred: The total bytes transferred so far. Does not include bytes already at the destination when the transfer started.
• raw_output: A list of lines we got from the underlying rsync command. Useful for debugging during development.

TransferStats objects look like this:

• transferred_bytes: The total bytes transferred for the current line of rsync output.
• percent: The percent complete for the current file being transferred.
• time: Rsync's estimated time for the current file being transferred.
• transfer_rate: Rsync's value for the current transfer in bytes.
• transfer_rate_unit: Rsync's outputted transfer rate unit. e.g. "MB/s"
• is_completed_stats: Is this the stats for a completed file transfer?

Notes about how we use rsync:

• We call rsync with the -a option. This means it's recursive and preserves everything except hard links.
• This early version only supports transferring the source directory into the destination directory. In other words, in the above example we'd end up with /the_destination/the_source.
• Of course, since this is rsync, we only transfer changed bytes and this means it's a resumable process.
• In my testing rsync yields a stats update about once a second, so that's how often we yield them to the caller.