layrz-sdk 4.0.13__py3-none-any.whl → 4.0.14__py3-none-any.whl

layrz_sdk/decorators/__init__.py

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

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.dist-info → layrz_sdk-4.0.14.dist-info}/METADATA

@@ -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.dist-info → layrz_sdk-4.0.14.dist-info}/RECORD

@@ -1,6 +1,8 @@
 layrz_sdk/__init__.py,sha256=OutylN0QazaeDVIA5NRDVyzwfYnZkAwVQzT-2F6iX2M,28
 layrz_sdk/constants.py,sha256=guXfIsVAcex76OEMv6DAJy1km1A_WUfWJuUO2Lo3kXE,344
 layrz_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+layrz_sdk/decorators/__init__.py,sha256=btoa1egRuYFWggsnfXprvCnxBN9Oq8pbRGcRUR2lm10,82
+layrz_sdk/decorators/func_timing.py,sha256=xRZrWv13ppS8wDy8DeMSNwH21soXGg-i1lOkSzsJ0c8,2196
 layrz_sdk/entities/__init__.py,sha256=7v3V9s_k2vf2WmHtgf9bMrEqm5EOPRR8xgZmg2B0eJ8,6079
 layrz_sdk/entities/action.py,sha256=cbyrfeBsUpdv5ipMtIDvFNJj-FE6whPt7I22BnEZ2sU,2020
 layrz_sdk/entities/action_geofence_ownership.py,sha256=xP_JG2qY7ogJtbCv-jE1xWAdc2oA0icoRIOAI6acicA,590
@@ -109,8 +111,8 @@ layrz_sdk/helpers/__init__.py,sha256=5iW3z2m3jrYhvTfxX-p-QTkR9X9oTKfEsbtVOg9jFFY
 layrz_sdk/helpers/color.py,sha256=dlpMafbM-4Wd9D9hMbbnZJf4ALkpie_ZmBR2Vz_YCmM,1203
 layrz_sdk/lcl/__init__.py,sha256=U967AWANkL3u_YVxMNAYlh8jkZ6hqHfStacz7yz6sOA,89
 layrz_sdk/lcl/core.py,sha256=_3uK05I0iwJl63cVWKxt-qFkq0DWggCj5M680GHH5uQ,25161
-layrz_sdk-4.0.13.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
-layrz_sdk-4.0.13.dist-info/METADATA,sha256=PxiG_OYeHxjx597LSQXHSVoWddh2shySIvfbHMK8gdg,2045
-layrz_sdk-4.0.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-layrz_sdk-4.0.13.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
-layrz_sdk-4.0.13.dist-info/RECORD,,
+layrz_sdk-4.0.14.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
+layrz_sdk-4.0.14.dist-info/METADATA,sha256=9pfKdzeUqrLsbNTAmRPo7U_YZ-3ghxpyAu_K4yCWCck,2045
+layrz_sdk-4.0.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+layrz_sdk-4.0.14.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
+layrz_sdk-4.0.14.dist-info/RECORD,,