layrz-sdk 3.1.9__tar.gz → 3.1.10__tar.gz

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.10
+
+- Updated docstrings to provide more information about types and usage
+
 ## 3.1.9
 
 - Changed `json` to `parsed` on `BroadcastResponse` and `BroadcastRequest` to avoid confusion with the `json` property from `pydantic.BaseModel`

{layrz_sdk-3.1.9/layrz_sdk.egg-info → layrz_sdk-3.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.9
+Version: 3.1.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>

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/bar_chart.py

@@ -39,8 +39,12 @@ class BarChart(BaseModel):
   ) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.GRAPHIC:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/column_chart.py

@@ -40,8 +40,12 @@ class ColumnChart(BaseModel):
   ) -> Any:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.GRAPHIC:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/html_chart.py

@@ -20,8 +20,12 @@ class HTMLChart(BaseModel):
   def render(self: Self) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     return {'library': 'HTML', 'configuration': self._render_html()}
 

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/line_chart.py

@@ -40,8 +40,12 @@ class LineChart(BaseModel):
   def render(self: Self, technology: ChartRenderTechnology) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
 
     if technology == ChartRenderTechnology.GRAPHIC:

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/map_chart.py

@@ -26,8 +26,12 @@ class MapChart(BaseModel):
   def render(self: Self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER_MAP) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.FLUTTER_MAP:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/number_chart.py

@@ -23,8 +23,12 @@ class NumberChart(BaseModel):
   def render(self: Self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.FLUTTER:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/pie_chart.py

@@ -28,8 +28,12 @@ class PieChart(BaseModel):
   ) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.GRAPHIC:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/radar_chart.py

@@ -26,8 +26,12 @@ class RadarChart(BaseModel):
   def render(self: Self) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     return {'library': 'APEXCHARTS', 'configuration': self._render_apexcharts()}
 

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/radial_bar_chart.py

@@ -28,8 +28,12 @@ class RadialBarChart(BaseModel):
   ) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.GRAPHIC:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/scatter_chart.py

@@ -38,8 +38,12 @@ class ScatterChart(BaseModel):
   ) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.GRAPHIC:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/table_chart.py

@@ -24,8 +24,12 @@ class TableChart(BaseModel):
   def render(self: Self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     if technology == ChartRenderTechnology.FLUTTER:
       return {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/charts/timeline_chart.py

@@ -24,8 +24,12 @@ class TimelineChart(BaseModel):
   def render(self: Self) -> Dict[str, Any]:
     """
     Render chart to a graphic Library.
+
     :param technology: The technology to use to render the chart.
+    :type technology: ChartRenderTechnology
+
     :return: The configuration of the chart.
+    :rtype: Dict[str, Any]
     """
     return {'library': 'APEXCHARTS', 'configuration': self._render_apexcharts()}
 

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/entities/report.py

@@ -2,6 +2,7 @@
 
 import logging
 import os
+import sys
 import time
 import warnings
 from pathlib import Path
@@ -17,6 +18,11 @@ from .report_data_type import ReportDataType
 from .report_format import ReportFormat
 from .report_page import ReportPage
 
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
 log = logging.getLogger(__name__)
 
 
@@ -31,7 +37,7 @@ class Report(BaseModel):
   export_format: Optional[ReportFormat] = Field(description='Export format of the report', default=None)
 
   @field_validator('export_format', mode='before')
-  def _validate_export_format(cls, value: Any) -> Any:
+  def _validate_export_format(cls: 'Report', value: Any) -> Any:
     if value is not None:
       warnings.warn(
         'export_format is deprecated, use the export method instead',
@@ -42,13 +48,13 @@ class Report(BaseModel):
     return value
 
   @property
-  def filename(self) -> str:
+  def filename(self: Self) -> str:
     """Report filename"""
     return f'{self.name}_{int(time.time() * 1000)}.xlsx'
 
   def export(
-    self,
-    path: str,
+    self: Self,
+    path: str | Path,
     export_format: Optional[ReportFormat] = None,
     password: Optional[str] = None,
     msoffice_crypt_path: str = '/opt/msoffice/bin/msoffice-crypt.exe',
@@ -57,9 +63,13 @@ class Report(BaseModel):
     Export report to file
 
     :param path: Path to save the report
+    :type path: str | Path
     :param export_format: Format to export the report
+    :type export_format: ReportFormat
     :param password: Password to protect the file (Only works with Microsoft Excel format)
+    :type password: str
     :param msoffice_crypt_path: Path to the msoffice-crypt.exe executable, used to encrypt the file
+    :type msoffice_crypt_path: str
     :return: Full path of the exported file or JSON representation of the report
     :rtype: Path | dict
     :raises AttributeError: If the export format is not supported
@@ -83,11 +93,11 @@ class Report(BaseModel):
     else:
       raise AttributeError(f'Unsupported export format: {self.export_format}')
 
-  def export_as_json(self) -> Dict[str, Any]:
+  def export_as_json(self: Self) -> Dict[str, Any]:
     """Returns the report as a JSON dict"""
     return self._export_json()
 
-  def _export_json(self) -> Dict[str, Any]:
+  def _export_json(self: Self) -> Dict[str, Any]:
     """Returns a JSON dict of the report"""
     json_pages = []
     for page in self.pages:
@@ -135,17 +145,25 @@ class Report(BaseModel):
     }
 
   def _export_xlsx(
-    self,
+    self: Self,
     path: str | Path,
     password: Optional[str] = None,
     msoffice_crypt_path: Optional[str] = None,
   ) -> Path:
     """
     Export to Microsoft Excel (.xslx)
+
     :param path: Path to save the report
+    :type path: str | Path
     :param password: Password to protect the file
+    :type password: str
     :param msoffice_crypt_path: Path to the msoffice-crypt.exe executable, used to encrypt the file
+    :type msoffice_crypt_path: str
+
     :return: Full path of the exported file
+    :rtype: Path
+
+    :raises AttributeError: If the export format is not supported
     """
 
     if isinstance(path, str):

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/helpers/color.py

@@ -8,10 +8,13 @@ Color: TypeAlias = Tuple[int, int, int, int]
 def convert_to_rgba(hex_color: str) -> Color:
   """
   Convert Hex (or Hexa) color to RGB (or RGBA) color
+
   :param hex_color: Hex color
   :type hex_color: str
+
   :return: RGB or RGBA color
   :rtype: tuple
+
   :raises ValueError: If the color is invalid
   """
 

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/layrz_sdk/lcl/core.py

@@ -26,12 +26,22 @@ class LclCore:
   ) -> None:
     """
     Creates a new instance of LclCore
+
     :param script: Script to be executed
+    :type script: str
     :param sensors: Sensors dictionary
+    :type sensors: Optional[PayloadType]
     :param previous_sensors: Previous sensors dictionary
+    :type previous_sensors: Optional[PayloadType]
     :param payload: Payload dictionary
+    :type payload: Optional[PayloadType]
     :param asset_constants: Asset constants dictionary
+    :type asset_constants: Optional[Dict[str, Any]]
     :param custom_fields: Custom fields dictionary
+    :type custom_fields: Optional[Dict[str, Any]]
+
+    :return: None
+    :rtype: None
     """
     if sensors is None:
       sensors = {}
@@ -61,8 +71,14 @@ class LclCore:
   ) -> str:
     """
     Perform script using Layrz Compute Language
+
     :param additional_globals: Additional global variables
+    :type additional_globals: Optional[Dict[str, Any]]
     :param additional_locals: Additional local variables
+    :type additional_locals: Optional[Dict[str, Any]]
+
+    :return: Result of the script in JSON format
+    :rtype: str
     """
     try:
       local_variables = {

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: layrz-sdk
-Version: 3.1.9
+Version: 3.1.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>

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "layrz-sdk"
-version = "3.1.9"
+version = "3.1.10"
 description = "Layrz SDK for Python"
 authors = [
   {name = "Golden M, Inc.", email = "software@goldenm.com"}

{layrz_sdk-3.1.9 → layrz_sdk-3.1.10}/uv.lock

@@ -318,7 +318,7 @@ wheels = [
 
 [[package]]
 name = "layrz-sdk"
-version = "3.1.9"
+version = "3.1.10"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },