gadget-timer 0.1.0__py3-none-any.whl

gadget.py

@@ -0,0 +1,103 @@
+import inspect
+import time
+import sys
+import os
+import shutil
+import re
+
+__version__ = "0.1.0"
+
+class Gadget:
+    def __init__(self, verbose=True):
+        self.verbose = verbose
+        self.t0 = None
+        self.group_times = {}
+    
+    def __call__(self, s='', group=None, _caller_frame=None):
+        """Make the instance callable like a function."""
+        if not self.verbose:
+            return
+            
+        current_time = time.time()
+        if self.t0 is None:
+            self.t0 = current_time
+        elapsed = current_time - self.t0
+        self.t0 = time.time()
+
+        # Use provided caller frame or get it from stack
+        if _caller_frame is None:
+            caller_frame = inspect.currentframe().f_back
+        else:
+            caller_frame = _caller_frame
+        frame_info = inspect.getframeinfo(caller_frame)
+
+        line_number = frame_info.lineno
+
+        try:
+            with open(frame_info.filename, 'r') as f:
+                lines = f.readlines()
+                line_content = lines[line_number - 2].rstrip()
+        except:
+            line_content = ""
+
+        green_color = "\033[32m"
+        reset_color = "\033[0m"
+        
+        # Shorten the file path - make it relative to cwd or just use filename
+        try:
+            short_path = os.path.relpath(frame_info.filename)
+        except:
+            short_path = os.path.basename(frame_info.filename)
+        
+        # Clickable file path for VS Code
+        file_link = f"{short_path}:{line_number}"
+        
+        # Handle group tracking
+        group_info = ""
+        if group:
+            if group not in self.group_times:
+                self.group_times[group] = 0.0
+            self.group_times[group] += elapsed
+            group_info = f" [{group}: {elapsed:.6f}s (total: {self.group_times[group]:.6f}s)]"
+        
+        # Build the left side of the output
+        left_output = f"{green_color}[line={line_number}] {elapsed:.6f}s {line_content}{reset_color} {s}{group_info}"
+        
+        # Get terminal width and right-align the file link
+        terminal_width = shutil.get_terminal_size().columns
+        # Strip ANSI codes for accurate length calculation
+        left_output_plain = re.sub(r'\033\[[0-9;]+m', '', left_output)
+        left_length = len(left_output_plain)
+        
+        # Calculate padding needed
+        file_link_display = f"→ {file_link}"
+        padding_needed = terminal_width - left_length - len(file_link_display) - 1
+        padding = " " * max(1, padding_needed)  # At least one space
+        
+        output = f"{left_output}{padding}{file_link_display}"
+        print(output)
+    
+    def reset(self, group=None):
+        """Reset group timer(s). If group is None, reset all groups."""
+        if group is None:
+            self.group_times = {}
+        elif group in self.group_times:
+            del self.group_times[group]
+
+# Create a default instance for convenience
+_default_gadget = Gadget()
+
+# Convenience functions that use the default instance
+def gadget(s='', group=None):
+    """Convenience function using default Gadget instance."""
+    caller_frame = inspect.currentframe().f_back
+    _default_gadget(s, group, _caller_frame=caller_frame)
+
+def gadget_reset(group=None):
+    """Convenience function using default Gadget instance."""
+    _default_gadget.reset(group)
+
+def gadget_config(verbose=True):
+    """Configure the default Gadget instance."""
+    global _default_gadget
+    _default_gadget = Gadget(verbose=verbose)

gadget_timer-0.1.0.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: gadget-timer
+Version: 0.1.0
+Summary: Tiny timing helper for printing elapsed times with call-site context
+Author: Sam Maddrell-Mander
+License: MIT
+Project-URL: Homepage, https://github.com/s-maddrellmander/gadget
+Project-URL: Repository, https://github.com/s-maddrellmander/gadget
+Project-URL: Issues, https://github.com/s-maddrellmander/gadget/issues
+Keywords: timing,debugging,profiling,logging
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Dynamic: license-file
+
+# gadget
+
+[![Tests](https://github.com/s-maddrellmander/gadget/actions/workflows/tests.yml/badge.svg)](https://github.com/s-maddrellmander/gadget/actions/workflows/tests.yml)
+
+A tiny helper for quick timing/debug prints with file and line context.
+
+## Install
+
+### From a local checkout
+
+```bash
+pip install .
+```
+
+### Directly from GitHub
+
+```bash
+pip install "git+https://github.com/s-maddrellmander/gadget.git"
+```
+
+### Editable install (for development)
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+### Functional API
+
+```python
+from gadget import gadget, gadget_reset, gadget_config
+
+gadget("start")
+# ... some code ...
+gadget("after step")
+
+gadget("phase 1", group="build")
+gadget("phase 2", group="build")
+gadget_reset("build")
+
+gadget_config(verbose=False)  # disable output globally
+```
+
+### Class-based API
+
+```python
+from gadget import Gadget
+
+timer = Gadget(verbose=True)
+timer("start")
+# ... some code ...
+timer("step", group="build")
+timer.reset("build")
+timer.reset()  # reset all groups
+```
+
+## Install from PyPI
+
+```bash
+pip install gadget-timer
+```
+
+## Notes
+
+- Package name on PyPI is `gadget-timer`.
+- Import path is still `gadget`.
+- For Git installs, the repository URL is:
+
+  ```bash
+  pip install "git+https://github.com/s-maddrellmander/gadget.git"
+  ```

gadget_timer-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+gadget.py,sha256=C-QVeFFWP8xiEJ5kwjC_v2E4GhNLJ6A7G_mjUGgC2M0,3496
+gadget_timer-0.1.0.dist-info/licenses/LICENSE,sha256=thdH96H8A1NZAoCIs6zHdo04Zwgeh8KR3NSH0EIMCc0,1076
+gadget_timer-0.1.0.dist-info/METADATA,sha256=Y386HXXZtklCpQTbCj8zkL1mDd7HtBs7l-EVNEEEO_4,2415
+gadget_timer-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+gadget_timer-0.1.0.dist-info/top_level.txt,sha256=RSJrRIfV7Bzp-NvVAfoFNnVV0rxuIpl2Xkxq0F7p-pw,7
+gadget_timer-0.1.0.dist-info/RECORD,,

gadget_timer-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gadget_timer-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sam Maddrell-Mander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gadget_timer-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gadget