bluer-options 5.166.1__py3-none-any.whl → 5.170.1__py3-none-any.whl

bluer_options/__init__.py

@@ -6,7 +6,7 @@ ICON = "🌀"
 
 DESCRIPTION = f"{ICON} Options for Bash."
 
-VERSION = "5.166.1"
+VERSION = "5.170.1"
 
 REPO_NAME = "bluer-options"
 

bluer_options/string/functions.py

@@ -221,7 +221,7 @@ def pretty_shape_of_matrix(
 
 
 def pretty_duration(
-    duration: Union[None, int],
+    duration: Union[None, float],
     element_format: str = "{}{}",
     include_ms: bool = False,
     largest: bool = False,

bluer_options/timing/__init__.py

@@ -0,0 +1,4 @@
+from bluer_options.timing.elapsed_timer import ElapsedTimer
+from bluer_options.timing.classes import Timing
+
+timing = Timing()

bluer_options/timing/classes.py

@@ -0,0 +1,117 @@
+import time
+from typing import List
+from collections import defaultdict
+from functools import wraps
+
+from bluer_options import string
+from bluer_options.logger import logger
+from bluer_options.logger.config import log_list
+from bluer_options.timing.elapsed_timer import ElapsedTimer
+
+
+class Timing:
+    def __init__(self):
+        self._active = {}
+        self.stats = defaultdict(lambda: {"count": 0, "total": 0.0})
+        self.elapsed_timer = ElapsedTimer()
+
+    def start(self, keyword: str):
+        """Start timing a code block identified by 'keyword'."""
+        self._active[keyword] = time.perf_counter()
+
+    def stop(self, keyword: str):
+        """Stop timing for 'keyword' and record elapsed time."""
+        if keyword not in self._active:
+            raise RuntimeError(f"No active timer for {keyword}")
+
+        elapsed = time.perf_counter() - self._active.pop(keyword)
+        self.stats[keyword]["count"] += 1
+        self.stats[keyword]["total"] += elapsed
+
+        return elapsed
+
+    def as_list(self, **kwgrs) -> List[str]:
+        lines = []
+        # sort items by total time (descending)
+        for k, v in sorted(
+            self.stats.items(),
+            key=lambda item: item[1]["total"],
+            reverse=True,
+        ):
+            avg = v["total"] / v["count"]
+            lines.append(
+                "{}: called {:,} time(s), total {}, avg {}".format(
+                    k,
+                    v["count"],
+                    string.pretty_duration(v["total"], **kwgrs),
+                    string.pretty_duration(avg, **kwgrs),
+                )
+            )
+        return lines
+
+    def log(
+        self,
+        include_ms: bool = True,
+        largest: bool = True,
+        short: bool = True,
+        **kwargs,
+    ):
+        log_list(
+            logger,
+            "took {} for".format(
+                self.elapsed_timer.as_str(
+                    stop=False,
+                    include_ms=include_ms,
+                    largest=largest,
+                    short=short,
+                )
+            ),
+            self.as_list(
+                include_ms=include_ms,
+                largest=largest,
+                short=short,
+            ),
+            "function call(s):",
+            **kwargs,
+        )
+
+    def reset(self):
+        self._active = {}
+        self.stats = defaultdict(lambda: {"count": 0, "total": 0.0})
+        self.elapsed_timer.reset()
+
+    def time(self, arg=None):
+        """Use as @timing.time, @timing.time(), or @timing.time('custom')"""
+
+        # Case 1: @timing.time  (no parentheses, arg is the function)
+        if callable(arg):
+            func = arg
+            name = func.__name__
+
+            @wraps(func)
+            def inner(*args, **kwargs):
+                self.start(name)
+                try:
+                    return func(*args, **kwargs)
+                finally:
+                    self.stop(name)
+
+            return inner
+
+        # Case 2: @timing.time() or @timing.time("custom")
+        keyword = arg  # may be None or str
+
+        def decorator(func):
+            name = keyword or func.__name__
+
+            @wraps(func)
+            def inner(*args, **kwargs):
+                self.start(name)
+                try:
+                    return func(*args, **kwargs)
+                finally:
+                    self.stop(name)
+
+            return inner
+
+        return decorator

bluer_options/timing/elapsed_timer.py

@@ -0,0 +1,42 @@
+import time
+from bluer_options import string
+
+
+class ElapsedTimer:
+    def __init__(self):
+        self.start_time = time.time()
+        self.elapsed_time_ = None
+
+    def as_str(
+        self,
+        stop: bool = True,
+        **kwargs,
+    ):
+        if stop:
+            self.stop()
+
+        elapsed_time = self.elapsed_time
+
+        return (
+            "None"
+            if elapsed_time is None
+            else string.pretty_duration(elapsed_time, **kwargs)
+        )
+
+    @property
+    def elapsed_time(self) -> float:
+        if self.start_time is None:
+            return self.elapsed_time_
+
+        return time.time() - self.start_time
+
+    def reset(self):
+        self.start_time = time.time()
+        self.elapsed_time_ = None
+
+    def stop(self):
+        if self.start_time is None:
+            return
+
+        self.elapsed_time_ = self.elapsed_time
+        self.start_time = None

{bluer_options-5.166.1.dist-info → bluer_options-5.170.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_options
-Version: 5.166.1
+Version: 5.170.1
 Summary: 🌀 Options for Bash.
 Home-page: https://github.com/kamangir/bluer-options
 Author: Arash Abadpour (Kamangir)

{bluer_options-5.166.1.dist-info → bluer_options-5.170.1.dist-info}/RECORD

@@ -1,7 +1,6 @@
-bluer_options/__init__.py,sha256=A80pImOvh3kNTP9CABuw3UVXRuFJOBna-9z5RnCf5LU,288
+bluer_options/__init__.py,sha256=xmQ2FD7BLue2yqg6RBw4e6QSn6ZdB5rH-kDElX0T2qI,288
 bluer_options/__main__.py,sha256=-6ce9W1uXkle4YtEYlSUMWxSmsur3dRDA4_MvNNhEVg,236
 bluer_options/config.env,sha256=2AG3xuWiMqaNmlCNDWQOJ_AssKk7KXhn0XDIkHWNQ2Q,30
-bluer_options/elapsed_timer.py,sha256=46e-g-bjC7J4hGOGKD12R90ficXzFYn84xlLX6l34I8,545
 bluer_options/timer.py,sha256=UPmsfCjbEWpcjXgMpYemXieheMJH_UpuemhVGsKYVoE,2470
 bluer_options/urls.py,sha256=paHaYlLMQOI46-EYNch5ohu9Q09BMkF2vvJy1QufrVI,19
 bluer_options/.bash/alias.sh,sha256=8-t6sTIy3YjyMkFLArRc45U1lNBWWmG0dIhYuN3-wRo,890
@@ -59,12 +58,15 @@ bluer_options/options/classes.py,sha256=dcfGd34y6vDYvj-v-Bb5uOyy79mwV0s98czYFJ9h
 bluer_options/string/__init__.py,sha256=MsbbLbg13Pmq2qkYqwOU1bc27_VvfiZ_alcKYH7zzI8,546
 bluer_options/string/__main__.py,sha256=g8dVfG5eMRXJsyc2jv631qvRb40TsEq2OVhf6Dkluvw,1286
 bluer_options/string/constants.py,sha256=hfUx6xihcOsTayceAumyxyV2fbAr45_o4J-4ejKWrgM,216
-bluer_options/string/functions.py,sha256=cvP4_b0CUk3xXWLTpqy17NOw8ldiiUx3GLpggapxgi4,7937
+bluer_options/string/functions.py,sha256=ogHO3Yee365CE_LIM2gwdQYQKFzPJ5z-rDTdoOIOOUg,7939
 bluer_options/terminal/__init__.py,sha256=kyNhbC5NVCuqrUhbbTeAOTW1ZO7MRRbi0RtXGBFKtJc,73
 bluer_options/terminal/__main__.py,sha256=3o465bp44c2f1KHDn4j664hpbvu8wKOwQ2c1OPoa6Xc,902
 bluer_options/terminal/functions.py,sha256=A23uHLeU4JIctmecOFk_KhIfOeHu-WMjnSzBj2KiF3U,1947
-bluer_options-5.166.1.dist-info/licenses/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
-bluer_options-5.166.1.dist-info/METADATA,sha256=vJPEMJXgftFAaAE_94nIn76cUHMiT70tNyuyUomYAlE,4951
-bluer_options-5.166.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-bluer_options-5.166.1.dist-info/top_level.txt,sha256=yw9slt8n3R7IiYmf83OtHtB8Z-EgP9UwyQTk1EGiAJU,14
-bluer_options-5.166.1.dist-info/RECORD,,
+bluer_options/timing/__init__.py,sha256=CCIJKvRVdimLdk46WOc_C-t8HHTVFPdGxQTFCFrN5zc,127
+bluer_options/timing/classes.py,sha256=iIzoMtR8SXNJcDGDPCJodRqUHPAPrEMTUCsMQ-BOuZg,3398
+bluer_options/timing/elapsed_timer.py,sha256=ecM11nzXnoDL_k6p41YPH28-OLnYreg_CgPQlbv4mjI,897
+bluer_options-5.170.1.dist-info/licenses/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
+bluer_options-5.170.1.dist-info/METADATA,sha256=SHaZLZAKqmxmhIVAY0MzQAaPrXnyCr8Lbh3WOB_qePo,4951
+bluer_options-5.170.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+bluer_options-5.170.1.dist-info/top_level.txt,sha256=yw9slt8n3R7IiYmf83OtHtB8Z-EgP9UwyQTk1EGiAJU,14
+bluer_options-5.170.1.dist-info/RECORD,,

bluer_options/elapsed_timer.py

@@ -1,23 +0,0 @@
-import time
-from bluer_options import string
-
-
-class ElapsedTimer:
-    def __init__(self):
-        self.start_time = time.time()
-        self.elapsed_time = None
-
-    def stop(self):
-        if self.start_time is None:
-            return
-
-        self.elapsed_time = time.time() - self.start_time
-        self.start_time = None
-
-    def elapsed_pretty(self, **kwargs):
-        self.stop()
-        return (
-            "None"
-            if self.elapsed_time is None
-            else string.pretty_duration(self.elapsed_time, **kwargs)
-        )