From 1789e0afa8cbdc650ef73bc021fca09ec1ae6056 Mon Sep 17 00:00:00 2001
From: erkin <e.altunbas@vyos.io>
Date: Wed, 9 Jun 2021 16:23:57 +0300
Subject: remote, util: Move general helper routines from `remote.py` to
 `util.py`

---
 python/vyos/util.py | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

(limited to 'python/vyos/util.py')

diff --git a/python/vyos/util.py b/python/vyos/util.py
index 16fcbf10b..7fea6cdc6 100644
--- a/python/vyos/util.py
+++ b/python/vyos/util.py
@@ -718,3 +718,52 @@ def cidr_fit(cidr_a, cidr_b, both_directions = False):
     if both_directions:
         return prefix_a.startswith(prefix_b) or prefix_b.startswith(prefix_a)
     return prefix_a.startswith(prefix_b)
+
+def print_error(str='', end='\n'):
+    """
+    Print `str` to stderr, terminated with `end`.
+    Used for warnings and out-of-band messages to avoid mangling precious
+     stdout output.
+    """
+    sys.stderr.write(str)
+    sys.stderr.write(end)
+    sys.stderr.flush()
+
+def make_progressbar():
+    """
+    Make a procedure that takes two arguments `done` and `total` and prints a
+     progressbar based on the ratio thereof, whose length is determined by the
+     width of the terminal.
+    """
+    import shutil, math
+    col, _ = shutil.get_terminal_size()
+    col = max(col - 15, 20)
+    def print_progressbar(done, total):
+        if done <= total:
+            increment = total / col
+            length = math.ceil(done / increment)
+            percentage = str(math.ceil(100 * done / total)).rjust(3)
+            print_error(f'[{length * "#"}{(col - length) * "_"}] {percentage}%', '\r')
+            # Print a newline so that the subsequent prints don't overwrite the full bar.
+        if done == total:
+            print_error()
+    return print_progressbar
+
+def make_incremental_progressbar(increment: float):
+    """
+    Make a generator that displays a progressbar that grows monotonically with
+     every iteration.
+    First call displays it at 0% and every subsequent iteration displays it
+     at `increment` increments where 0.0 < `increment` < 1.0.
+    Intended for FTP and HTTP transfers with stateless callbacks.
+    """
+    print_progressbar = make_progressbar()
+    total = 0.0
+    while total < 1.0:
+        print_progressbar(total, 1.0)
+        yield
+        total += increment
+    print_progressbar(1, 1)
+    # Ignore further calls.
+    while True:
+        yield
-- 
cgit v1.2.3