layrz-sdk 4.0.12__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/entities/asset.py

@@ -104,3 +104,8 @@ class Asset(BaseModel):
   def asset_type(self: Self) -> int | None:
     """Get asset type"""
     return self.kind_id
+
+  partition_number: int | None = Field(
+    default=None,
+    description='Partition number assigned for this Asset, if is None, will be auto-assigned by the system',
+  )

layrz_sdk/entities/broadcast/result.py

@@ -1,6 +1,7 @@
 """Broadcast result"""
 
 from datetime import datetime
+from typing import Any
 
 from pydantic import BaseModel, Field
 
@@ -12,9 +13,37 @@ from .status import BroadcastStatus
 class BroadcastResult(BaseModel):
   """Broadcast result data"""
 
+  pk: int | None = Field(default=None, description='Broadcast result ID', alias='id')
+  trigger_id: int | None = Field(default=None, description='Trigger ID')
+
   service_id: int = Field(description='Service ID')
   asset_id: int = Field(description='Asset ID')
   status: BroadcastStatus = Field(description='Broadcast status')
   request: BroadcastRequest = Field(description='Broadcast request')
   response: BroadcastResponse = Field(description='Broadcast response')
   submitted_at: datetime = Field(description='Broadcast submission date')
+
+  algorithm: str | None = Field(
+    default=None,
+    description='Algorithm used for the broadcast, if any',
+  )
+
+  error: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Error message if the broadcast failed',
+  )
+
+  service: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Service details at the time of the broadcast',
+  )
+
+  asset: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Asset details at the time of the broadcast',
+  )
+
+  trigger: dict[str, Any] = Field(
+    default_factory=dict,
+    description='Trigger details at the time of the broadcast',
+  )

layrz_sdk/entities/broadcast/status.py

@@ -8,8 +8,8 @@ class BroadcastStatus(StrEnum):
   """Broadcast result status"""
 
   OK = 'OK'
-  BADREQUEST = 'BADREQUEST'
-  INTERNALERROR = 'INTERNALERROR'
+  BAD_REQUEST = 'BADREQUEST'
+  INTERNAL_ERROR = 'INTERNALERROR'
   UNAUTHORIZED = 'UNAUTHORIZED'
   UNPROCESSABLE = 'UNPROCESSABLE'
   DISCONNECTED = 'DISCONNECTED'

{layrz_sdk-4.0.12.dist-info → layrz_sdk-4.0.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.12
+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.12.dist-info → layrz_sdk-4.0.14.dist-info}/RECORD

@@ -1,12 +1,14 @@
 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
 layrz_sdk/entities/action_kind.py,sha256=2PR4MesAyKssdWAwOGE4hYfzyhGd9pW78H9rlyXu28Q,1189
 layrz_sdk/entities/action_subkind.py,sha256=lNsX3C_YTI3aui4AIe0lD86IcjAqwfxsUSf7blRbtgA,635
-layrz_sdk/entities/asset.py,sha256=NkYk0c1BBv8Vzmanrdc7TRLGAhZ93FEZqQ3QMwG_yEY,3356
+layrz_sdk/entities/asset.py,sha256=oFfrp5p7qYLi0kRlulL_kyTGxUV2whcEgRyBIAH9RFc,3528
 layrz_sdk/entities/asset_constants.py,sha256=m2pL4FKgPVVHxGKfmF80xv4W-rTh9NL7ClksfEcFkx8,600
 layrz_sdk/entities/asset_contact.py,sha256=ptxItpob4VdQeM6qMUtSZgZxBw5DfKp3kVfBVlXpujo,422
 layrz_sdk/entities/asset_operation_mode.py,sha256=umvmRb8W3kEDUd9dqyKhJ745xe3wssNjPw8gGGcKYO8,551
@@ -65,9 +67,9 @@ layrz_sdk/entities/broadcast/__init__.py,sha256=Q1fIeDj1oAL63Q0JDddkW_FuP826-Im6
 layrz_sdk/entities/broadcast/payload.py,sha256=ugD5m3zVFZVDfBMkR2WlZTWunn9gZSQ1Ej8YXbeA8Wk,1417
 layrz_sdk/entities/broadcast/request.py,sha256=MQb9kyDSAMXtp4_sPOamBsYyCVZ02wj8NXmi8IEmM68,260
 layrz_sdk/entities/broadcast/response.py,sha256=hK3D05pecln9wbkdGr892Kzmd7bMzjsaayPxzJPVHsw,263
-layrz_sdk/entities/broadcast/result.py,sha256=07P7cE6LCBpw8jlgmyVsGxBmRpO4A7Jva5hpLh-n5U0,656
+layrz_sdk/entities/broadcast/result.py,sha256=-raIiY1QD_rPOyWnSYHdONNc7VtsRZ_r_DBpUlQuCUc,1462
 layrz_sdk/entities/broadcast/service.py,sha256=6FBuiHfiWc8J3WtUCLS7wmbhJ9qGXDhi-Fs4N2wgeAk,374
-layrz_sdk/entities/broadcast/status.py,sha256=vARwQSH-WWVEPbb_qTTyuENZehSDfvq2ZeUR6iYIJdM,509
+layrz_sdk/entities/broadcast/status.py,sha256=eZMEIL_PmyJ5DFrHOhnvjBXA_LJZtXWUQbZDLamEcao,511
 layrz_sdk/entities/charts/axis_config.py,sha256=ZvVsjB26FMbbfM9318KaQm3XyiNAkyzz2120fM2DH50,604
 layrz_sdk/entities/charts/bar_chart.py,sha256=EiQc7g3UlaOxzuoJJBbMdpfYIqew-ElLXYN_1xXpUSk,4910
 layrz_sdk/entities/charts/chart_alignment.py,sha256=NemdGai33s7mOUe35ye41bo_VvzOnaIz82TloI1BqB0,379
@@ -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.12.dist-info/licenses/LICENSE,sha256=d5ZrU--lIPER7QByXDKcrtOTOMk1JvN_9FdYDuoWi7Y,1057
-layrz_sdk-4.0.12.dist-info/METADATA,sha256=EZ4TLSVWLR-ail082uCcIbVQ5BsG8ae07H7XR6xi9CM,2045
-layrz_sdk-4.0.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-layrz_sdk-4.0.12.dist-info/top_level.txt,sha256=yUTMMzfdZ0HDWQH5TaSlFM4xtwmP1fSGxmlL1dmu4l4,10
-layrz_sdk-4.0.12.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,,