dcicutils 8.8.3.1b4__tar.gz → 8.8.3.1b5__tar.gz

{dcicutils-8.8.3.1b4 → dcicutils-8.8.3.1b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.8.3.1b4
+Version: 8.8.3.1b5
 Summary: Utility package for interacting with the 4DN Data Portal and other 4DN resources
 Home-page: https://github.com/4dn-dcic/utils
 License: MIT

{dcicutils-8.8.3.1b4 → dcicutils-8.8.3.1b5}/dcicutils/misc_utils.py

@@ -2548,6 +2548,29 @@ def normalize_spaces(value: str) -> str:
     return re.sub(r"\s+", " ", value).strip()
 
 
+def find_nth_from_end(string: str, substring: str, nth: int) -> int:
+    """
+    Returns the index of the nth occurrence of the given substring within
+    the given string from the END of the given string; or -1 if not found.
+    """
+    index = -1
+    string = string[::-1]
+    for i in range(0, nth):
+        index = string.find(substring, index + 1)
+    return len(string) - index - 1 if index >= 0 else -1
+
+
+def set_nth(string: str, nth: int, replacement: str) -> str:
+    """
+    Sets the nth character of the given string to the given replacement string.
+    """
+    if not isinstance(string, str) or not isinstance(nth, int) or not isinstance(replacement, str):
+        return string
+    if nth < 0:
+        nth += len(string)
+    return string[:nth] + replacement + string[nth + 1:] if 0 <= nth < len(string) else string
+
+
 class JsonLinesReader:
 
     def __init__(self, fp, padded=False, padding=None):

{dcicutils-8.8.3.1b4 → dcicutils-8.8.3.1b5}/dcicutils/progress_bar.py

@@ -1,4 +1,5 @@
 from collections import namedtuple
+import re
 from signal import signal, SIGINT
 import sys
 import threading
@@ -8,6 +9,7 @@ from types import FrameType as frame
 from typing import Callable, List, Optional, Union
 from contextlib import contextmanager
 from dcicutils.command_utils import yes_or_no
+from dcicutils.misc_utils import find_nth_from_end, set_nth
 
 
 class TQDM(tqdm):
@@ -281,7 +283,7 @@ class ProgressBar:
                 # looks like it is from tqdm and we are disabled/done then do no output.
                 return
             if sentinel_internal in text:
-                spinc = spina[spini % spinn] if not ("100%|" in text) else "| ✓" ; spini += 1  # noqa
+                spinc = spina[spini % spinn] if not ("100%|" in text) else "✓" ; spini += 1  # noqa
                 text = replace_first(text, sentinel_internal, f" {spinc}")
                 text = replace_first(text, "%|", "% ◀|")
                 text = remove_extra_trailing_spaces(text)
@@ -290,9 +292,26 @@ class ProgressBar:
                 # the unit we gave, which is empty; idunno; just replace it here.
                 text = replace_first(text, "s/ ", "/s ")
             sys_stdout_write(text)
-            if self._captured_output_for_testing is not None:
-                self._captured_output_for_testing.append(text)
             sys.stdout.flush()
+            if self._captured_output_for_testing is not None:
+                # For testing only we replace vacilliting values in the out like rate,
+                # time elapsed, and ETA with static values; so that something like this:
+                # > Working /  20% ◀|█████████▌  | 1/5 | 536.00/s | 00:01 | ETA: 00:02
+                # becomes something more static like this after calling this function:
+                # > Working |  20% ◀|### | 1/5 | 0.0/s | 00:00 | ETA: 00:00
+                # This function obviously has intimate knowledge of the output; better here than in tests.
+                def replace_vacillating_values_with_static(text: str) -> str:
+                    blocks = "\u2587|\u2588|\u2589|\u258a|\u258b|\u258c|\u258d|\u258e|\u258f"
+                    if (n := find_nth_from_end(text, "|", 5)) >= 8:
+                        pattern = re.compile(
+                            rf"(\s*)(\d*%? ◀\|)(?:\s*{blocks}|#)*\s*(\|\s*\d+/\d+)?(\s*\|\s*)"
+                            rf"(?:\d+\.?\d*|\?)(\/s\s*\|\s*)(?:\d+:\d+)?(\s*\|\s*ETA:\s*)(?:\d+:\d+|\?)?")
+                        if match := pattern.match(text[n - 6:]):
+                            if text[n - 8:n - 7] != "✓": text = set_nth(text, n - 8, "|")  # noqa
+                            return (text[0:n - 6].replace("\r", "") +
+                                    match.expand(rf"\g<1>\g<2>### \g<3>\g<4>0.0\g<5>00:00\g<6>00:00"))
+                    return text
+                self._captured_output_for_testing.append(replace_vacillating_values_with_static(text))
         def restore_stdout_write() -> None:  # noqa
             nonlocal sys_stdout_write
             if sys_stdout_write is not None:

{dcicutils-8.8.3.1b4 → dcicutils-8.8.3.1b5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicutils"
-version = "8.8.3.1b4"  # TODO: To become 8.8.4
+version = "8.8.3.1b5"  # TODO: To become 8.8.4
 description = "Utility package for interacting with the 4DN Data Portal and other 4DN resources"
 authors = ["4DN-DCIC Team <support@4dnucleome.org>"]
 license = "MIT"