halib 0.2.13__tar.gz → 0.2.15__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.13
+Version: 0.2.15
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -41,6 +41,7 @@ Requires-Dist: tqdm
 Requires-Dist: tube_dl
 Requires-Dist: wandb
 Requires-Dist: ipynbname
+Requires-Dist: typed-argument-parser
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -53,6 +54,9 @@ Dynamic: summary
 
 # Helper package for coding and automation
 
+**Version 0.2.15**
++ update `exp.perf.profiler`: add `enabled` flag to enable/disable profiling dynamically, also add `measure` context manager to simplify measuring code blocks.
+
 **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.15}/README.md

@@ -1,5 +1,8 @@
 # Helper package for coding and automation
 
+**Version 0.2.15**
++ update `exp.perf.profiler`: add `enabled` flag to enable/disable profiling dynamically, also add `measure` context manager to simplify measuring code blocks.
+
 **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.15}/halib/exp/perf/profiler.py

@@ -1,17 +1,62 @@
 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 contextlib import contextmanager
+
 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 ContextScope:
+    """Helper to remember the current context name so you don't have to repeat it."""
+
+    def __init__(self, profiler, ctx_name):
+        self.profiler = profiler
+        self.ctx_name = ctx_name
+
+    @contextmanager
+    def step(self, step_name):
+        # Automatically passes the stored ctx_name + the new step_name
+        with self.profiler.measure(self.ctx_name, step_name):
+            yield
 
 
 class zProfiler:
@@ -23,13 +68,23 @@ class zProfiler:
         output_file (str): Path to save the profiling report.
         report_format (str): Output format for reports ("json" or "csv").
 
-    Example:
+    Example (using context manager):
+        prof = zProfiler()
+        with prof.measure("my_context") as ctx:
+            with ctx.step("step1"):
+                time.sleep(0.1)
+            with ctx.step("step2"):
+                time.sleep(0.2)
+
+    Example (using raw methods):
         prof = zProfiler()
         prof.ctx_start("my_context")
         prof.step_start("my_context", "step1")
         time.sleep(0.1)
         prof.step_end("my_context", "step1")
         prof.ctx_end("my_context")
+
+
     """
 
     _instance = None
@@ -41,13 +96,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 +125,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 +134,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 +144,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
@@ -84,6 +153,24 @@ class zProfiler:
             return
         self.time_dict[ctx_name]["step_dict"][step_name][-1].append(time.perf_counter())
 
+    @contextmanager
+    def measure(self, ctx_name, step_name=None):
+        if step_name is None:
+            # --- Context Mode ---
+            self.ctx_start(ctx_name)
+            try:
+                # Yield the helper object initialized with the current context name
+                yield ContextScope(self, ctx_name)
+            finally:
+                self.ctx_end(ctx_name)
+        else:
+            # --- Step Mode ---
+            self.step_start(ctx_name, step_name)
+            try:
+                yield
+            finally:
+                self.step_end(ctx_name, step_name)
+
     def _step_dict_to_detail(self, ctx_step_dict):
         """
                 'ctx_step_dict': {
@@ -167,7 +254,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 +347,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.15}/halib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.13
+Version: 0.2.15
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -41,6 +41,7 @@ Requires-Dist: tqdm
 Requires-Dist: tube_dl
 Requires-Dist: wandb
 Requires-Dist: ipynbname
+Requires-Dist: typed-argument-parser
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -53,6 +54,9 @@ Dynamic: summary
 
 # Helper package for coding and automation
 
+**Version 0.2.15**
++ update `exp.perf.profiler`: add `enabled` flag to enable/disable profiling dynamically, also add `measure` context manager to simplify measuring code blocks.
+
 **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.15}/halib.egg-info/requires.txt

@@ -29,3 +29,4 @@ tqdm
 tube_dl
 wandb
 ipynbname
+typed-argument-parser

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

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