layrz-sdk 4.0.13__tar.gz → 4.0.14__tar.gz

{layrz_sdk-4.0.13 → layrz_sdk-4.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.13
+Version: 4.0.14
 Summary: Layrz SDK for Python
 Author-email: "Golden M, Inc." <software@goldenm.com>
 Maintainer-email: Kenny Mochizuki <kenny@goldenm.com>, Luis Reyes <lreyes@goldenm.com>, Kasen Li <kli@goldenm.com>, Miguel Zauzich <miguel@goldenm.com>, Angel Prieto <aprieto@goldenm.com>

layrz_sdk-4.0.14/layrz_sdk/decorators/__init__.py

@@ -0,0 +1,5 @@
+"""decorators"""
+
+from .func_timing import func_timing
+
+__all__ = ['func_timing']

layrz_sdk-4.0.14/layrz_sdk/decorators/func_timing.py

@@ -0,0 +1,96 @@
+"""Timing decorator"""
+
+import asyncio
+import logging
+import os
+from collections.abc import Callable
+from functools import wraps
+from typing import Any, ParamSpec, TypeVar, overload
+
+T = TypeVar('T')
+P = ParamSpec('P')
+
+log = logging.getLogger(__name__)
+
+SHOULD_DISPLAY = os.environ.get('LAYRZ_SDK_DISPLAY_TIMING', '1') == '1'
+
+
+@overload
+def func_timing(func: Callable[P, T]) -> Callable[P, T]: ...
+
+
+@overload
+def func_timing(*, depth: int) -> Callable[[Callable[P, T]], Callable[P, T]]: ...
+
+
+def func_timing(
+  func: Callable[P, T] | None = None,
+  *,
+  depth: int = 0,
+) -> Any:
+  """
+  Decorator to time a function execution.
+
+  :param depth: The depth of the function call for logging indentation.
+  :return: The wrapped function with timing functionality.
+  """
+
+  def decorator(func: Callable[P, T]) -> Callable[P, T]:
+    """Decorator to time a function"""
+    import time
+
+    prefix = '\t' * depth
+
+    @wraps(func)
+    async def async_wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
+      start_time = time.perf_counter_ns()
+      result: T = await func(*args, **kwargs)  # type: ignore
+      diff = time.perf_counter_ns() - start_time
+
+      if SHOULD_DISPLAY:
+        log.info(f'{prefix}{func.__name__}() took {_readable_time(diff)}')
+
+      return result
+
+    @wraps(func)
+    def sync_wrapper(*args: P.args, **kwargs: P.kwargs) -> T:
+      start_time = time.perf_counter_ns()
+      result = func(*args, **kwargs)
+      diff = time.perf_counter_ns() - start_time
+
+      if SHOULD_DISPLAY:
+        log.info(f'{prefix}{func.__name__}() took {_readable_time(diff)}')
+
+      return result
+
+    if asyncio.iscoroutinefunction(func):
+      return async_wrapper  # type: ignore
+    return sync_wrapper
+
+  if func is None:
+    return decorator
+  return decorator(func)
+
+
+def _readable_time(diff: int) -> str:
+  """Convert nanoseconds to a readable format"""
+  if diff < 1_000:
+    return f'{diff} ns'
+
+  diff = diff // 1_000
+  if diff < 1_000:
+    return f'{diff} μs'
+
+  diff = diff // 1_000
+  if diff < 1_000:
+    return f'{diff} ms'
+
+  diff = diff // 1_000
+  if diff < 60:
+    return f'{diff} s'
+
+  diff = diff // 60
+  if diff < 60:
+    return f'{diff} m'
+
+  return f'{diff // 60} h'

{layrz_sdk-4.0.13 → layrz_sdk-4.0.14}/layrz_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.13
+Version: 4.0.14
 Summary: Layrz SDK for Python
 Author-email: "Golden M, Inc." <software@goldenm.com>
 Maintainer-email: Kenny Mochizuki <kenny@goldenm.com>, Luis Reyes <lreyes@goldenm.com>, Kasen Li <kli@goldenm.com>, Miguel Zauzich <miguel@goldenm.com>, Angel Prieto <aprieto@goldenm.com>

{layrz_sdk-4.0.13 → layrz_sdk-4.0.14}/layrz_sdk.egg-info/SOURCES.txt

@@ -9,6 +9,8 @@ layrz_sdk.egg-info/SOURCES.txt
 layrz_sdk.egg-info/dependency_links.txt
 layrz_sdk.egg-info/requires.txt
 layrz_sdk.egg-info/top_level.txt
+layrz_sdk/decorators/__init__.py
+layrz_sdk/decorators/func_timing.py
 layrz_sdk/entities/__init__.py
 layrz_sdk/entities/action.py
 layrz_sdk/entities/action_geofence_ownership.py

{layrz_sdk-4.0.13 → layrz_sdk-4.0.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "4.0.13"
+version = "4.0.14"
 description = "Layrz SDK for Python"
 authors = [{ name = "Golden M, Inc.", email = "software@goldenm.com" }]
 requires-python = ">=3.13"