layrz-sdk 3.0.7__py3-none-any.whl → 3.0.9__py3-none-any.whl

layrz_sdk/entities/checkpoints/checkpoint.py

@@ -1,5 +1,6 @@
 """ Checkpoints entitites """
 from datetime import datetime
+from typing import List, Self
 
 from .waypoint import Waypoint
 
@@ -17,10 +18,10 @@ class Checkpoint:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     asset_id: int,
-    waypoints: list[Waypoint],
+    waypoints: List[Waypoint],
     start_at: datetime,
     end_at: datetime,
   ) -> None:
@@ -32,15 +33,15 @@ class Checkpoint:
     self.end_at = end_at
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Checkpoint(pk={self.pk}, asset_id={self.asset_id}, waypoints={self.waypoints}, ' +\
            f'start_at={self.start_at}, end_at={self.end_at})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/checkpoints/geofence.py

@@ -1,4 +1,5 @@
 """ Geofence entity """
+from typing import Self
 
 
 class Geofence:
@@ -11,21 +12,21 @@ class Geofence:
     - color : Geofence color in Hex format
   """
 
-  def __init__(self, pk: int, name: str, color: str) -> None:
+  def __init__(self: Self, pk: int, name: str, color: str) -> None:
     """ Constructor """
     self.pk = pk
     self.name = name
     self.color = color
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Geofence(pk={self.pk}, name={self.name}, color={self.color})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/checkpoints/waypoint.py

@@ -1,5 +1,6 @@
 """ Waypoint entity """
 from datetime import datetime
+from typing import Self
 
 from .geofence import Geofence
 
@@ -18,7 +19,7 @@ class Waypoint:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     geofence: Geofence,
     start_at: datetime,
@@ -35,15 +36,15 @@ class Waypoint:
     self.sequence_ideal = sequence_ideal
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Waypoint(pk={self.pk}, geofence={self.geofence}, start_at={self.start_at}, ' +\
            f'end_at={self.end_at}, sequence_real={self.sequence_real}, sequence_ideal={self.sequence_ideal})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/events/event.py

@@ -1,5 +1,6 @@
 """ Event entity """
 from datetime import datetime
+from typing import Self
 
 from layrz_sdk.entities.cases.trigger import Trigger
 from layrz_sdk.entities.telemetry.message import Message
@@ -19,7 +20,7 @@ class Event:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     trigger: Trigger,
     asset_id: int,
@@ -34,15 +35,15 @@ class Event:
     self.activated_at = activated_at
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Event(pk={self.pk}, trigger={self.trigger}, asset_id={self.asset_id}, ' +\
            f'message={self.message}, activated_at={self.activated_at})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/formatting/text_align.py

@@ -1,5 +1,6 @@
 """ Text alignment """
 from enum import Enum
+from typing import Self
 
 
 class TextAlignment(Enum):
@@ -10,14 +11,14 @@ class TextAlignment(Enum):
   JUSTIFY = 'justify'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'TextAlignment.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/general/asset.py

@@ -1,4 +1,6 @@
 """ Asset Entity """
+from typing import List, Self
+
 from .asset_operation_mode import AssetOperationMode
 from .custom_field import CustomField
 from .device import Device
@@ -23,18 +25,18 @@ class Asset:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     name: str,
     vin: str,
     plate: str,
     asset_type: int,
     operation_mode: AssetOperationMode,
-    sensors: list[Sensor] = None,
-    custom_fields: list[CustomField] = None,
-    devices: list[Device] = None,
-    children: list = None,
-  ):
+    sensors: List[Sensor] = None,
+    custom_fields: List[CustomField] = None,
+    devices: List[Device] = None,
+    children: List = None,
+  ) -> None:
     """ Constructor """
     self.pk = pk
     self.name = name
@@ -52,16 +54,16 @@ class Asset:
       self.children = []
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Asset(pk={self.pk}, name={self.name}, vin={self.vin}, plate={self.plate}, ' +\
            f'asset_type={self.asset_type}, operation_mode={self.operation_mode}, ' +\
            f'custom_fields={self.custom_fields}, children={self.children}, sensors={self.sensors})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/general/asset_operation_mode.py

@@ -1,5 +1,6 @@
 """ Asset Operation Mode """
 from enum import Enum
+from typing import Self
 
 
 class AssetOperationMode(Enum):
@@ -15,14 +16,14 @@ class AssetOperationMode(Enum):
   ZONE = 'ZONE'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return self.value
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/general/custom_field.py

@@ -1,4 +1,5 @@
 """ Custom Field entitiy """
+from typing import Self
 
 
 class CustomField:
@@ -10,20 +11,20 @@ class CustomField:
     - value : Value of the custom field
   """
 
-  def __init__(self, name: str, value: str) -> None:
+  def __init__(self: Self, name: str, value: str) -> None:
     """ Constructor """
     self.name = name
     self.value = value
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'CustomField(name={self.name}, value={self.value})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/general/device.py

@@ -1,4 +1,5 @@
 """ Device entitiy """
+from typing import Self
 
 
 class Device:
@@ -14,7 +15,7 @@ class Device:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     name: str,
     ident: str,
@@ -29,15 +30,15 @@ class Device:
     self.is_primary = is_primary
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Device(pk={self.pk}, ident={self.ident}, name={self.name}, protocol={self.protocol}, ' +\
            f'is_primary={self.is_primary})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/general/sensor.py

@@ -1,4 +1,5 @@
 """ Sensor entity """
+from typing import Self
 
 
 class Sensor:
@@ -11,21 +12,21 @@ class Sensor:
     slug : Slug of the sensor
   """
 
-  def __init__(self, pk: int, name: str, slug: str) -> None:
+  def __init__(self: Self, pk: int, name: str, slug: str) -> None:
     """ Constructor """
     self.pk = pk
     self.name = name
     self.slug = slug
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'Sensor(pk={self.pk}, name={self.name}, slug={self.slug})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/general/user.py

@@ -1,4 +1,5 @@
 """ User entity """
+from typing import Self
 
 
 class User:
@@ -10,20 +11,20 @@ class User:
     name : User name
   """
 
-  def __init__(self, pk: int, name: str) -> None:
+  def __init__(self: Self, pk: int, name: str) -> None:
     """ Constructor """
     self.pk = pk
     self.name = name
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'User(pk={self.pk}, name={self.name})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/repcom/transaction.py

@@ -1,5 +1,6 @@
 """ Transaction entity """
 from datetime import datetime, timedelta
+from typing import Self
 
 from layrz_sdk.entities.general.asset import Asset
 
@@ -24,7 +25,7 @@ class Transaction:
   """
 
   def __init__(
-    self,
+    self: Self,
     pk: int,
     asset: Asset,
     amount: float,
@@ -37,7 +38,7 @@ class Transaction:
     geofence_name: str,
     received_at: datetime,
     is_wildcard: bool,
-  ):
+  ) -> None:
     """ Constructor """
     self.pk = pk
     self.asset = asset

layrz_sdk/entities/reports/col.py

@@ -1,7 +1,7 @@
 """ Report col """
 import warnings
 from enum import Enum
-from typing import Any
+from typing import Any, Self
 
 from ..formatting.text_align import TextAlignment
 
@@ -18,15 +18,15 @@ class ReportDataType(Enum):
   CURRENCY = 'currency'
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable """
     return f'ReportDataType.{self.value}'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
@@ -48,7 +48,7 @@ class ReportCol:
   """
 
   def __init__(
-    self,
+    self: Self,
     content: Any,
     color: str = '#ffffff',
     text_color: str = None,
@@ -62,7 +62,7 @@ class ReportCol:
     self.color = color
 
     if text_color is not None:
-      warnings.warn('text_color is deprecated, use color instead', DeprecationWarning)
+      warnings.warn('text_color is deprecated, use color instead', DeprecationWarning, stacklevel=2)
 
     self.align = align
     self.data_type = data_type
@@ -71,14 +71,14 @@ class ReportCol:
     self.bold = bold
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable property """
     return f'ReportCol(content={self.content})'
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable

layrz_sdk/entities/reports/format.py

@@ -1,23 +1,27 @@
-""" Report formats """
+"""Report formats"""
+
 from enum import Enum
+from typing import Self
 
 
 class ReportFormat(Enum):
   """
   Report format definition.
   """
+
   MICROSOFT_EXCEL = 'MICROSOFT_EXCEL'
   JSON = 'JSON'
+  PDF = 'PDF'
 
   @property
-  def _readable(self) -> str:
-    """ Readable """
+  def _readable(self: Self) -> str:
+    """Readable"""
     return f'ReportFormat.{self.value}'
 
-  def __str__(self) -> str:
-    """ Readable property """
+  def __str__(self: Self) -> str:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self) -> str:
-    """ Readable property """
+  def __repr__(self: Self) -> str:
+    """Readable property"""
     return self._readable

layrz_sdk/entities/reports/header.py

@@ -1,5 +1,7 @@
-""" Report header """
+"""Report header"""
+
 import warnings
+from typing import Self
 
 from ..formatting.text_align import TextAlignment
 
@@ -21,7 +23,7 @@ class ReportHeader:
   """
 
   def __init__(
-    self,
+    self: Self,
     content: str,
     width: int = None,
     color: str = '#ffffff',
@@ -32,25 +34,25 @@ class ReportHeader:
     self.content = content
 
     if width is not None:
-      warnings.warn('width is deprecated, use width instead', DeprecationWarning)
+      warnings.warn('width is deprecated, use width instead', DeprecationWarning, stacklevel=2)
 
     self.color = color
 
     if text_color is not None:
-      warnings.warn('text_color is deprecated, use color instead', DeprecationWarning)
+      warnings.warn('text_color is deprecated, use color instead', DeprecationWarning, stacklevel=2)
 
     self.align = align
     self.bold = bold
 
   @property
-  def _readable(self) -> str:
-    """ Readable property """
+  def _readable(self: Self) -> str | None | bool:
+    """Readable property"""
     return f'ReportHeader(content={self.content})'
 
-  def __str__(self) -> str:
-    """ Readable property """
+  def __str__(self: Self) -> str | None | bool:
+    """Readable property"""
     return self._readable
 
-  def __repr__(self) -> str:
-    """ Readable property """
+  def __repr__(self: Self) -> str | None | bool:
+    """Readable property"""
     return self._readable

layrz_sdk/entities/reports/page.py

@@ -1,4 +1,6 @@
 """ Report page """
+from typing import List, Self
+
 from .header import ReportHeader
 from .row import ReportRow
 
@@ -14,10 +16,10 @@ class ReportPage:
   """
 
   def __init__(
-    self,
+    self: Self,
     name: str,
-    headers: list[ReportHeader],
-    rows: list[ReportRow],
+    headers: List[ReportHeader],
+    rows: List[ReportRow],
     freeze_header: bool = False,
   ) -> None:
     self.name = name
@@ -26,15 +28,15 @@ class ReportPage:
     self.freeze_header = freeze_header
 
   @property
-  def _readable(self) -> str:
+  def _readable(self: Self) -> str | None | bool:
     """ Readable property """
     return f'ReportPage(name={self.name}, headers={self.headers}, rows={self.rows})'
 
-  def __str__(self) -> str:
+  def __str__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
-  def __repr__(self) -> str:
+  def __repr__(self: Self) -> str | None | bool:
     """ Readable property """
     return self._readable
 
@@ -48,11 +50,11 @@ class CustomReportPage:
     - name : Name of the page. Length should be less than 60 characters
   Methods:
   - builder(Worksheet) -> None : Function to build the page
-                                 The builder receives a `Worksheet` object as an argument and shouldn't 
+                                 The builder receives a `Worksheet` object as an argument and shouldn't
                                  return anything.
   """
 
-  def __init__(self, name: str, builder: callable) -> None:
+  def __init__(self: Self, name: str, builder: callable) -> None:
     """ Constructor """
     self.name = name