From a4a4d170b5ae8c189de982adea5bdc9bf1f26e6c Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 31 Jan 2022 13:23:22 -0800 Subject: [PATCH] update docstring --- jc/parsers/rsync.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/jc/parsers/rsync.py b/jc/parsers/rsync.py index ee7fccd7..8ce76d74 100644 --- a/jc/parsers/rsync.py +++ b/jc/parsers/rsync.py @@ -1,8 +1,10 @@ """jc - JSON CLI output utility `rsync` command output parser -Supports the following options with all levels of verbosity: -- `-i` or `--itemize-changes` -- `--log-file` +Supports the `-i` or `--itemize-changes` options with all levels of +verbosity. + +Will also process the rsync log file generated with the `--log-file` +option. Usage (cli): @@ -36,7 +38,7 @@ Schema: "matches": integer, # need to convert "hash_hits": integer, # need to convert "false_alarms": integer, # need to convert - "data": integer?, # need to convert + "data": integer, # need to convert "bytes_sec": float, # need to convert "speedup": float # need to convert }, @@ -97,7 +99,10 @@ def _process(proc_data: List[Dict]) -> List[Dict]: List of Dictionaries. Structured to conform to the schema. """ - int_list = ['process', 'sent', 'received', 'total_size', 'matches', 'has_hits', 'false_alarms', 'data'] + int_list = [ + 'process', 'sent', 'received', 'total_size', 'matches', 'hash_hits', + 'false_alarms', 'data' + ] float_list = ['bytes_sec', 'speedup'] for item in proc_data: for key in item['summary']: