dcicutils 8.13.3.1b13__py3-none-any.whl → 8.13.3.1b16__py3-none-any.whl

dcicutils/misc_utils.py

@@ -3,6 +3,7 @@ This file contains functions that might be generally useful.
 """
 
 from collections import namedtuple
+from collections.abc import Iterable
 import appdirs
 from copy import deepcopy
 import concurrent.futures
@@ -997,6 +998,94 @@ def to_integer(value: str, fallback: Optional[Any] = None, strict: bool = False)
     return fallback
 
 
+_MULTIPLIER_K = 1000
+_MULTIPLIER_M = 1000 * _MULTIPLIER_K
+_MULTIPLIER_G = 1000 * _MULTIPLIER_M
+_MULTIPLIER_T = 1000 * _MULTIPLIER_G
+
+_MULTIPLIER_SUFFIXES = {
+    "K": _MULTIPLIER_K,
+    "Kb": _MULTIPLIER_K,
+    "KB": _MULTIPLIER_K,
+    "M": _MULTIPLIER_M,
+    "Mb": _MULTIPLIER_M,
+    "MB": _MULTIPLIER_M,
+    "G": _MULTIPLIER_G,
+    "Gb": _MULTIPLIER_G,
+    "GB": _MULTIPLIER_G,
+    "T": _MULTIPLIER_T,
+    "Tb": _MULTIPLIER_T,
+    "TB": _MULTIPLIER_T
+}
+
+
+def to_number(value: str,
+              allow_commas: bool = False,
+              allow_suffix: bool = False,
+              allow_float: bool = False) -> Optional[Union[int, float]]:
+
+    """
+    Converts the give string value to an int, or possibly float if allow_float is True.
+    If allow_commas is True (default: False) then allow commas (only) every three digits.
+    If allow_suffix is True (default: False) allow any of K, Kb, KB; or M, Mb, MB; or
+    G, Gb, or GB; or T, Tb, TB, to mean multiply value by one thousand; one million;
+    one billion; or one trillion; respectively. If allow_float is True (default: False)
+    allow the value to be floating point (i.e. with a decimal point and a fractional part),
+    in which case the returned value will be of type float rather than int.
+    If the string is not well formated then returns None.
+    """
+    if not (isinstance(value, str) and (value := value.strip())):
+        return value if isinstance(value, (int, float)) else None
+
+    value_multiplier = 1
+    value_negative = False
+    value_fraction = None
+
+    if value.startswith("-"):
+        if not (value := value[1:].strip()):
+            return None
+        value_negative = True
+    elif value.startswith("+"):
+        if not (value := value[1:].strip()):
+            return None
+
+    if allow_suffix is True:
+        for suffix in _MULTIPLIER_SUFFIXES:
+            if value.endswith(suffix):
+                value_multiplier *= _MULTIPLIER_SUFFIXES[suffix]
+                if not (value := value[:-len(suffix)].strip()):
+                    return None
+                break
+
+    if allow_float is True:
+        if dot_index := value.rindex("."):
+            if value_fraction := value[dot_index + 1:].strip():
+                try:
+                    value_fraction = float(f"0.{value_fraction}")
+                except Exception:
+                    return None
+            value = value[:dot_index].strip()
+        pass
+
+    if allow_commas is True:
+        if not re.fullmatch(r"(-?\d{1,3}(,\d{3})*)", value):
+            return None
+        value = value.replace(",", "")
+
+    if not value.isdigit():
+        return None
+
+    result = int(value) * value_multiplier
+
+    if value_fraction:
+        result += value_fraction
+
+    if value_negative:
+        result = -result
+
+    return result
+
+
 def to_float(value: str, fallback: Optional[Any] = None) -> Optional[Any]:
     try:
         return float(value)
@@ -2782,6 +2871,6 @@ def create_short_uuid(length: Optional[int] = None, upper: bool = False):
     return value
 
 
-def run_concurrently(functions: List[Callable], nthreads: int = 4) -> None:
+def run_concurrently(functions: Iterable[Callable], nthreads: int = 4) -> None:
     with concurrent.futures.ThreadPoolExecutor(max_workers=nthreads) as executor:
-        [_ for _ in concurrent.futures.as_completed([executor.submit(f) for f in functions])]
+        concurrent.futures.as_completed([executor.submit(f) for f in functions])

{dcicutils-8.13.3.1b13.dist-info → dcicutils-8.13.3.1b16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcicutils
-Version: 8.13.3.1b13
+Version: 8.13.3.1b16
 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.13.3.1b13.dist-info → dcicutils-8.13.3.1b16.dist-info}/RECORD

@@ -45,7 +45,7 @@ dcicutils/license_policies/park-lab-gpl-pipeline.jsonc,sha256=vLZkwm3Js-kjV44nug
 dcicutils/license_policies/park-lab-pipeline.jsonc,sha256=9qlY0ASy3iUMQlr3gorVcXrSfRHnVGbLhkS427UaRy4,283
 dcicutils/license_utils.py,sha256=2Yxnh1T1iuMe6wluwbvpFO_zYSGPxB4-STAMc-vz-YM,47202
 dcicutils/log_utils.py,sha256=7pWMc6vyrorUZQf-V-M3YC6zrPgNhuV_fzm9xqTPph0,10883
-dcicutils/misc_utils.py,sha256=p4MagJymETX_j4h-jx4IjjVb_dYHekWopfUK8ytw2Xs,109772
+dcicutils/misc_utils.py,sha256=6BM6V6ZVtVARpfvv8zEgymNlxLzW8z-qIS99D_z94no,112580
 dcicutils/obfuscation_utils.py,sha256=fo2jOmDRC6xWpYX49u80bVNisqRRoPskFNX3ymFAmjw,5963
 dcicutils/opensearch_utils.py,sha256=V2exmFYW8Xl2_pGFixF4I2Cc549Opwe4PhFi5twC0M8,1017
 dcicutils/portal_object_utils.py,sha256=Az3n1aL-PQkN5gOFE6ZqC2XkYsqiwKlq7-tZggs1QN4,11062
@@ -75,8 +75,8 @@ dcicutils/trace_utils.py,sha256=g8kwV4ebEy5kXW6oOrEAUsurBcCROvwtZqz9fczsGRE,1769
 dcicutils/validation_utils.py,sha256=cMZIU2cY98FYtzK52z5WUYck7urH6JcqOuz9jkXpqzg,14797
 dcicutils/variant_utils.py,sha256=2H9azNx3xAj-MySg-uZ2SFqbWs4kZvf61JnK6b-h4Qw,4343
 dcicutils/zip_utils.py,sha256=_Y9EmL3D2dUZhxucxHvrtmmlbZmK4FpSsHEb7rGSJLU,3265
-dcicutils-8.13.3.1b13.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
-dcicutils-8.13.3.1b13.dist-info/METADATA,sha256=on2VP4DUbgF3RJTd79fbyg7hWNtcXU-R09K8jTmg_v4,3440
-dcicutils-8.13.3.1b13.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-dcicutils-8.13.3.1b13.dist-info/entry_points.txt,sha256=W6kEWdUJk9tQ4myAgpehPdebcwvCAZ7UgB-wyPgDUMg,335
-dcicutils-8.13.3.1b13.dist-info/RECORD,,
+dcicutils-8.13.3.1b16.dist-info/LICENSE.txt,sha256=qnwSmfnEWMl5l78VPDEzAmEbLVrRqQvfUQiHT0ehrOo,1102
+dcicutils-8.13.3.1b16.dist-info/METADATA,sha256=shc6O7nqhx1QAchJHbpNdQdeCNyO5-lDqGz6c9W9UqE,3440
+dcicutils-8.13.3.1b16.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+dcicutils-8.13.3.1b16.dist-info/entry_points.txt,sha256=W6kEWdUJk9tQ4myAgpehPdebcwvCAZ7UgB-wyPgDUMg,335
+dcicutils-8.13.3.1b16.dist-info/RECORD,,