halib 0.2.13__tar.gz → 0.2.14__tar.gz

{halib-0.2.13 → halib-0.2.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.13
+Version: 0.2.14
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -53,6 +53,9 @@ Dynamic: summary
 
 # Helper package for coding and automation
 
+**Version 0.2.14**
++ update `exp.perf.profiler`: add `enabled` flag to enable/disable profiling dynamically
+
 **Version 0.2.13**
 + reorganize packages with most changes in `research` package; also rename `research` to `exp` (package for experiment management and utilities)
 + update `exp/perfcalc.py` to allow save computed performance to csv file (without explicit calling method `calc_perfs`)

{halib-0.2.13 → halib-0.2.14}/README.md

@@ -1,5 +1,8 @@
 # Helper package for coding and automation
 
+**Version 0.2.14**
++ update `exp.perf.profiler`: add `enabled` flag to enable/disable profiling dynamically
+
 **Version 0.2.13**
 + reorganize packages with most changes in `research` package; also rename `research` to `exp` (package for experiment management and utilities)
 + update `exp/perfcalc.py` to allow save computed performance to csv file (without explicit calling method `calc_perfs`)

{halib-0.2.13 → halib-0.2.14}/halib/exp/perf/profiler.py

@@ -1,19 +1,48 @@
 import os
 import time
 import json
-
 from pathlib import Path
 from pprint import pprint
 from threading import Lock
+from functools import wraps
 from loguru import logger
 
+# Plotting libraries
 from plotly.subplots import make_subplots
 import plotly.graph_objects as go
 import plotly.express as px  # for dynamic color scales
 
 from ...common.common import ConsoleLog
+from ...system.path import *
+
+
+# ==========================================
+# 1. The Decorator
+# ==========================================
+def check_enabled(func):
+    """
+    Decorator to skip method execution if the profiler is disabled.
+
+    This acts as a 'guard clause' for the entire function. If the profiler
+    instance has 'enabled=False', the decorated function is not executed at all,
+    saving processing time and avoiding side effects.
+    """
+
+    @wraps(func)
+    def wrapper(self, *args, **kwargs):
+        # Gracefully handle cases where 'enabled' might not be set yet (default to True)
+        # print('check_enabled called')
+        if not getattr(self, "enabled", True):
+            # print('Profiler disabled, skipping function execution.')
+            return  # Exit immediately, returning None
+        return func(self, *args, **kwargs)
 
+    return wrapper
 
+
+# ==========================================
+# 2. The Class
+# ==========================================
 class zProfiler:
     """A singleton profiler to measure execution time of contexts and steps.
 
@@ -41,13 +70,24 @@ class zProfiler:
                 cls._instance = super().__new__(cls)
             return cls._instance
 
-    def __init__(
-        self,
-    ):
+    def __init__(self, enabled=None):
+        """
+        Args:
+            enabled (bool, optional):
+                - If True/False: Updates the enabled state immediately.
+                - If None: Keeps the current state (defaults to True on first init).
+        """
+        # 1. First-time initialization
         if not hasattr(self, "_initialized"):
+            self.enabled = enabled if enabled is not None else True
             self.time_dict = {}
             self._initialized = True
 
+        # 2. If initialized, allow updating 'enabled' ONLY if explicitly passed
+        elif enabled is not None:
+            self.enabled = enabled
+
+    @check_enabled
     def ctx_start(self, ctx_name="ctx_default"):
         if not isinstance(ctx_name, str) or not ctx_name:
             raise ValueError("ctx_name must be a non-empty string")
@@ -59,6 +99,7 @@ class zProfiler:
             }
         self.time_dict[ctx_name]["report_count"] += 1
 
+    @check_enabled
     def ctx_end(self, ctx_name="ctx_default", report_func=None):
         if ctx_name not in self.time_dict:
             return
@@ -67,6 +108,7 @@ class zProfiler:
             self.time_dict[ctx_name]["end"] - self.time_dict[ctx_name]["start"]
         )
 
+    @check_enabled
     def step_start(self, ctx_name, step_name):
         if not isinstance(step_name, str) or not step_name:
             raise ValueError("step_name must be a non-empty string")
@@ -76,6 +118,7 @@ class zProfiler:
             self.time_dict[ctx_name]["step_dict"][step_name] = []
         self.time_dict[ctx_name]["step_dict"][step_name].append([time.perf_counter()])
 
+    @check_enabled
     def step_end(self, ctx_name, step_name):
         if (
             ctx_name not in self.time_dict
@@ -167,7 +210,6 @@ class zProfiler:
             )
         return report_dict
 
-    @classmethod
     @classmethod
     def plot_formatted_data(
         cls, profiler_data, outdir=None, file_format="png", do_show=False, tag=""
@@ -261,7 +303,8 @@ class zProfiler:
                 file_prefix = ctx if len(tag_str) == 0 else f"{tag_str}_{ctx}"
                 file_path = os.path.join(outdir, f"{file_prefix}_summary.{file_format.lower()}")
                 fig.write_image(file_path)
-                print(f"Saved figure: {file_path}")
+                pprint(f"Saved figure to: 🔽")
+                pprint_local_path(file_path)
 
             results[ctx] = fig
 

{halib-0.2.13 → halib-0.2.14}/halib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.13
+Version: 0.2.14
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -53,6 +53,9 @@ Dynamic: summary
 
 # Helper package for coding and automation
 
+**Version 0.2.14**
++ update `exp.perf.profiler`: add `enabled` flag to enable/disable profiling dynamically
+
 **Version 0.2.13**
 + reorganize packages with most changes in `research` package; also rename `research` to `exp` (package for experiment management and utilities)
 + update `exp/perfcalc.py` to allow save computed performance to csv file (without explicit calling method `calc_perfs`)

{halib-0.2.13 → halib-0.2.14}/setup.py

@@ -8,7 +8,7 @@ with open("requirements.txt") as f:
 
 setuptools.setup(
     name="halib",
-    version="0.2.13",
+    version="0.2.14",
     author="Hoang Van Ha",
     author_email="hoangvanhauit@gmail.com",
     description="Small library for common tasks",