cptree package

Submodules

cptree.checksum module

cptree.checksum.checksum(target, hash, output_file, tqdm_kwargs=None, rsync_args=None, src=None, dst=None)

generate BSD-style checksum for each file in target, returning local file containing result

cptree.checksum.checksum_command(base, host, exclude_filename, hash_cmd)

cptree.checksum.compare_checksums(src_sums, dst_sums)

run diff on hash digest files, return length if identical, otherwise raise exception

cptree.checksum.delete_exclude_file(host, filename)

cptree.checksum.delete_file(filename)

cptree.checksum.generate_exclude_file(host, rsync_args)

cptree.checksum.is_local(host)

cptree.checksum.is_remote(host)

cptree.cli module

Console script for cptree.

cptree.common module

cptree.common.host_mode(host)

cptree.common.map_cmd(command)

cptree.common.parse_int(field)

cptree.common.read_file_lines(filename, strip=True)

cptree.common.runner(host)

cptree.common.split_target(target: str) -> (<class 'str'>, <class 'str'>)

return (hostname, path) for target; hostname is None for local target

cptree.common.which(command, host=None, quiet=False)

return local or remote command path if valid, otherwise raise exception or optionally return None

cptree.common.write_file_lines(dir, name, lines)

cptree.cptree module

cptree.cptree.check_for_device_transfers(counts, file_list)

cptree.cptree.count_items(items)

cptree.cptree.cptree(*args, output_dir=None, **kwargs)

call _cptree with work_dir from argument or a temp dir

cptree.cptree.mkopts(kwargs)

cptree.cptree.prescan(src, dst, cmd, opts, file_list)

cptree.cptree.summarize_item_details(counts)

cptree.exception_handler module

ehandler

well-behaved exception handler for python cli commands

class cptree.exception_handler.ExceptionHandler(debug=False, logger=False)

Bases: object

debug = None

installed = False

logger = None

cptree.exception_handler.exception_handler(exception_type, exception, traceback, debug_hook=<built-in function excepthook>)

cptree.exceptions module

exception cptree.exceptions.ChecksumCompareFailed

Bases: Fail

exception cptree.exceptions.ChecksumExcludeFileGenerationFailed

Bases: Fail

exception cptree.exceptions.ChecksumGenerationFailed

Bases: Fail

exception cptree.exceptions.CommandNotFound

Bases: Fail

exception cptree.exceptions.Fail

Bases: Exception

exception cptree.exceptions.InvalidDirectory

Bases: Fail

exception cptree.exceptions.RsyncTransferFailed

Bases: Fail

exception cptree.exceptions.UnrecognizedRsyncPrescanOutput

Bases: Fail

exception cptree.exceptions.UnsupportedRsyncArgument

Bases: Fail

cptree.exclude module

cptree.exclude.glob_to_egrep(glob_pattern)

Convert a glob pattern to a regex pattern usable by egrep.

Args: - glob_pattern (str): The glob pattern to convert.

Returns: - str: A regex pattern equivalent to the input glob pattern.

cptree.exclude.rsync_exclude_patterns(rsync_args)

parse rsync args and return list of exclude patterns as regex

cptree.progress module

class cptree.progress.ProgressReader(in_stream, **kwargs)

Bases: object

readlines()

cptree.shell module

cptree.verify module

cptree.verify.confirm_delete(target, label, host, delete)

cptree.verify.delete_countdown(msg, cmd, host)

cptree.verify.verify_dst_directory(target, create=None, delete=None)

cptree.verify.verify_output_directory(target)

cptree.verify.verify_src_directory(target)

cptree.version module

cptree.watcher module

class cptree.watcher.LineWatcher(*, file_callback=None, progress_callback=None, line_callback=None)

Bases: StreamWatcher

parse_line(line)

submit(stream: str) → Generator[str, None, None]

Act on stream data, potentially returning responses.

Parameters:

stream (str) – All data read on this stream since the beginning of the session.

Returns:

An iterable of str (which may be empty).

New in version 1.0.

Module contents

Top-level package for cptree.

cptree.cptree(*args, output_dir=None, **kwargs)

call _cptree with work_dir from argument or a temp dir