layrz-sdk 4.0.8__tar.gz → 4.0.10__tar.gz

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 4.0.10
+
+- Added support for lock cells in `ReportCol` entity and their export to Microsoft Excel.
+- Added support for `list[Geofence]` on `Message` entity for presence in geofences.
+
+## 4.0.9
+
+- Added validation for `destination_phones` field in `Operation` entity to ensure it is a list of `DestinationPhone` objects.
+- Updated `OperationPayload` entity to use `DestinationPhone` instead of a list of strings for `destinations`.
+
+
 ## 4.0.8
 
 - Allowed `int | str | None` for `account_id` in `Operation` and `OperationPayload` entities.

{layrz_sdk-4.0.8/layrz_sdk.egg-info → layrz_sdk-4.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 4.0.8
+Version: 4.0.10
 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>
@@ -12,17 +12,18 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests
-Requires-Dist: xlsxwriter
-Requires-Dist: tzdata
+Requires-Dist: xlsxwriter<4.0.0,>=3.2.5
 Requires-Dist: pydantic>=2.10.6
-Requires-Dist: typing-extensions>=4.10.0
 Requires-Dist: geopy>=2.4.1
 Requires-Dist: shapely>=2.1.1
 Requires-Dist: strenum>=0.4.15
+Requires-Dist: requests>=2.32.4
+Requires-Dist: tzdata>=2025.2
 Dynamic: license-file
 
 # Layrz SDK

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/ats_possible_exit.py

@@ -19,7 +19,6 @@ class AtsPossibleExit(BaseModel):
   identifier: int | None = Field(
     default=None,
     description='Nullable positive big integer identifier for the exit',
-    ge=0,
   )
 
   # Volume / gauge snapshots

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/message.py

@@ -1,15 +1,13 @@
 """Message entity"""
 
 from datetime import datetime
-from typing import Any, TypeAlias
+from typing import Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 
 from layrz_sdk.constants import UTC
-
-from .position import Position
-
-PayloadType: TypeAlias = dict[str, Any]
+from layrz_sdk.entities.geofence import Geofence
+from layrz_sdk.entities.position import Position
 
 
 class Message(BaseModel):
@@ -27,11 +25,11 @@ class Message(BaseModel):
     default_factory=lambda: Position(),
     description='Current position of the device',
   )
-  payload: PayloadType = Field(
+  payload: dict[str, Any] = Field(
     default_factory=dict,
     description='Payload data of the device message',
   )
-  sensors: PayloadType = Field(
+  sensors: dict[str, Any] = Field(
     default_factory=dict,
     description='Sensor data of the device message',
   )
@@ -39,3 +37,19 @@ class Message(BaseModel):
     default_factory=lambda: datetime.now(UTC),
     description='Timestamp when the message was received',
   )
+
+  geofences: list[Geofence] = Field(
+    default_factory=list,
+    description='List of geofences associated with the message',
+  )
+
+  @field_validator('geofences', mode='before')
+  def _validate_geofences(cls, value: Any) -> list[Geofence]:
+    """Validate geofences"""
+    if value is None:
+      return []
+
+    if not isinstance(value, list):
+      return []
+
+    return value

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/operation.py

@@ -150,6 +150,17 @@ class Operation(BaseModel):
     description='Defines the destination phone numbers for Twilio notifications',
   )
 
+  @field_validator('destination_phones', mode='before')
+  def serialize_destination_phones(cls, value: Any) -> list[DestinationPhone]:
+    """Serialize destination phones to a list of DestinationPhone"""
+    if isinstance(value, list):
+      return value
+
+    if isinstance(value, DestinationPhone):
+      return [value]
+
+    return []
+
   attach_image: bool = Field(
     default=False,
     description='Defines if the operation should attach an image',

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/operation_payload.py

@@ -204,6 +204,17 @@ class OperationPayload(BaseModel):
     description='Defines the destination phone numbers for Twilio notifications',
   )
 
+  @field_validator('destinations', mode='before')
+  def serialize_destinations(cls, value: Any) -> list[DestinationPhone]:
+    """Serialize destinations to a list of DestinationPhone"""
+    if isinstance(value, list):
+      return value
+
+    if isinstance(value, DestinationPhone):
+      return [value]
+
+    return []
+
   twilio_host_phone: DestinationPhone | None = Field(
     default=None,
     description='Defines the host phone number for Twilio notifications',

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/position.py

@@ -1,6 +1,6 @@
 """Position entity"""
 
-from typing import Any, Self
+from typing import Any, Self, cast
 
 from pydantic import BaseModel, Field, field_validator
 
@@ -32,7 +32,7 @@ class Position(BaseModel):
       value = float(value)
 
     if -90 <= value <= 90:
-      return value
+      return cast(float, value)
 
     return None
 
@@ -49,7 +49,7 @@ class Position(BaseModel):
       value = float(value)
 
     if -180 <= value <= 180:
-      return value
+      return cast(float, value)
 
     return None
 
@@ -76,7 +76,7 @@ class Position(BaseModel):
     if isinstance(value, int):
       value = float(value)
 
-    return value
+    return cast(float, value)
 
   @field_validator('speed', mode='before')
   def _validate_speed(cls: Self, value: Any) -> None | float:
@@ -90,7 +90,7 @@ class Position(BaseModel):
     if isinstance(value, int):
       value = float(value)
 
-    return abs(value)
+    return cast(float, abs(value))
 
   @field_validator('direction', mode='before')
   def _validate_direction(cls: Self, value: Any) -> None | float:
@@ -105,6 +105,6 @@ class Position(BaseModel):
       value = float(value)
 
     if 0 <= value <= 360:
-      return value
+      return cast(float, value)
 
     return None

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/report.py

@@ -10,13 +10,12 @@ from typing import Any, Optional, Self
 import xlsxwriter
 from pydantic import BaseModel, Field, field_validator
 
+from layrz_sdk.entities.custom_report_page import CustomReportPage
+from layrz_sdk.entities.report_data_type import ReportDataType
+from layrz_sdk.entities.report_format import ReportFormat
+from layrz_sdk.entities.report_page import ReportPage
 from layrz_sdk.helpers.color import use_black
 
-from .custom_report_page import CustomReportPage
-from .report_data_type import ReportDataType
-from .report_format import ReportFormat
-from .report_page import ReportPage
-
 log = logging.getLogger(__name__)
 
 
@@ -87,6 +86,7 @@ class Report(BaseModel):
     else:
       raise AttributeError(f'Unsupported export format: {self.export_format}')
 
+  @warnings.deprecated('export_as_json is deprecated, use export with export_format=ReportFormat.JSON instead')
   def export_as_json(self: Self) -> dict[str, Any]:
     """Returns the report as a JSON dict"""
     return self._export_json()
@@ -98,7 +98,7 @@ class Report(BaseModel):
       if isinstance(page, CustomReportPage):
         continue
 
-      headers = []
+      headers: list[dict[str, Any]] = []
       for header in page.headers:
         headers.append(
           {
@@ -231,34 +231,44 @@ class Report(BaseModel):
             'font_name': 'Aptos Narrow',
           }
 
+          format_ = book.add_format(style)
+
+          if cell.lock:
+            format_.set_locked(True)
+
           value: Any = None
 
-          if cell.data_type == ReportDataType.BOOL:
-            value = 'Yes' if cell.content else 'No'
-          elif cell.data_type == ReportDataType.DATETIME:
-            value = cell.content.strftime(cell.datetime_format)
-          elif cell.data_type == ReportDataType.INT:
-            try:
-              value = int(cell.content)
-            except ValueError:
-              value = cell.content
-              log.warning(f'Invalid int value: {cell.content} in cell {i + 1}, {j}')
-          elif cell.data_type == ReportDataType.FLOAT:
-            try:
+          match cell.data_type:
+            case ReportDataType.BOOL:
+              value = 'Yes' if cell.content else 'No'
+
+            case ReportDataType.DATETIME:
+              value = cell.content.strftime(cell.datetime_format)
+
+            case ReportDataType.INT:
+              try:
+                value = int(cell.content)
+              except ValueError:
+                value = cell.content
+                log.warning(f'Invalid int value: {cell.content} in cell {i + 1}, {j}')
+
+            case ReportDataType.FLOAT:
+              try:
+                value = float(cell.content)
+                format_.set_num_format('0.00')
+
+              except ValueError:
+                value = cell.content
+                log.warning(f'Invalid float value: {cell.content} in cell {i + 1}, {j}')
+
+            case ReportDataType.CURRENCY:
               value = float(cell.content)
-              style.update({'num_format': '0.00'})
-            except ValueError:
-              value = cell.content
-              log.warning(f'Invalid float value: {cell.content} in cell {i + 1}, {j}')
-          elif cell.data_type == ReportDataType.CURRENCY:
-            value = float(cell.content)
-            style.update(
-              {'num_format': f'"{cell.currency_symbol}" * #,##0.00;[Red]"{cell.currency_symbol}" * #,##0.00'}
-            )
-          else:
-            value = cell.content
+              format_.set_num_format(f'"{cell.currency_symbol}" * #,##0.00;[Red]"{cell.currency_symbol}" * #,##0.00')
+
+            case _:
+              value = str(cell.content)
 
-          sheet.write(i + 1, j, value, book.add_format(style))
+          sheet.write(i + 1, j, value, format_)
 
           if row.compact:
             sheet.set_row(i + 1, None, None, {'level': 1, 'hidden': True})

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/report_col.py

@@ -20,6 +20,7 @@ class ReportCol(BaseModel):
   datetime_format: str = Field(description='Datetime format', default='%Y-%m-%d %H:%M:%S')
   currency_symbol: str = Field(description='Currency symbol', default='')
   bold: bool = Field(description='Bold text', default=False)
+  lock: bool = Field(description='Lock column', default=False)
 
   @field_validator('text_color', mode='before')
   def _validate_text_color(cls: Self, value: Any) -> Any:

{layrz_sdk-4.0.8 → layrz_sdk-4.0.10}/layrz_sdk/entities/telemetry/assetmessage.py

@@ -117,7 +117,7 @@ class AssetMessage(BaseModel):
       case AssetOperationMode.STATIC:
         obj.position = asset.static_position.model_dump(exclude_none=True) if asset.static_position else {}
       case AssetOperationMode.ZONE:
-        points = MultiPoint([(p.longitude, p.latitude) for p in asset.points])
+        points: MultiPoint = MultiPoint([(p.longitude, p.latitude) for p in asset.points])
         obj.position = {'latitude': points.centroid.y, 'longitude': points.centroid.x}
       case _:
         obj.position = device_message.position