layrz-sdk 2.2.2__tar.gz → 2.2.3__tar.gz

{layrz-sdk-2.2.2/layrz_sdk.egg-info → layrz-sdk-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: layrz-sdk
-Version: 2.2.2
+Version: 2.2.3
 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-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/__init__.py

@@ -20,6 +20,7 @@ from .general import (Asset, AssetOperationMode, CustomField, Device, Sensor, Us
 # REPCOM entities
 from .repcom import Transaction
 # Reports entities
-from .reports import (Report, ReportCol, ReportDataType, ReportFormat, ReportHeader, ReportPage, ReportRow)
+from .reports import (CustomReportPage, Report, ReportCol, ReportDataType, ReportFormat, ReportHeader, ReportPage,
+                      ReportRow)
 # Telemetry entities
 from .telemetry import Message, Position

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/reports/__init__.py

@@ -2,6 +2,6 @@
 from .col import ReportCol, ReportDataType
 from .format import ReportFormat
 from .header import ReportHeader
-from .page import ReportPage
+from .page import ReportPage, CustomReportPage
 from .report import Report
 from .row import ReportRow

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/reports/col.py

@@ -1,4 +1,5 @@
 """ Report col """
+import warnings
 from enum import Enum
 from typing import Any
 
@@ -38,6 +39,8 @@ class ReportCol:
     - content : Display content
     - color : Cell color
     - text_color : Text color
+                   Deprecated, The text color now will use the luminance of the background color to determine the
+                   text color
     - align : Text Alignment
     - data_type : Data type
     - datetime_format : Date time format
@@ -48,7 +51,7 @@ class ReportCol:
     self,
     content: Any,
     color: str = '#ffffff',
-    text_color: str = '#000000',
+    text_color: str = None,
     align: TextAlignment = TextAlignment.LEFT,
     data_type: ReportDataType = ReportDataType.STR,
     datetime_format: str = '%Y-%m-%d %H:%M:%S',
@@ -57,7 +60,10 @@ class ReportCol:
   ) -> None:
     self.content = content
     self.color = color
-    self.text_color = text_color
+
+    if text_color is not None:
+      warnings.warn('text_color is deprecated, use color instead', DeprecationWarning)
+
     self.align = align
     self.data_type = data_type
     self.datetime_format = datetime_format
@@ -67,9 +73,7 @@ class ReportCol:
   @property
   def _readable(self) -> str:
     """ Readable property """
-    return f'ReportCol(content={self.content}, color={self.color}, text_color={self.text_color}, '+\
-           f'align={self.align}, data_type={self.data_type}, datetime_format={self.datetime_format}, ' +\
-           f'currency_symbol={self.currency_symbol}, bold={self.bold})'
+    return f'ReportCol(content={self.content})'
 
   def __repr__(self) -> str:
     """ Readable property """

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/reports/header.py

@@ -1,4 +1,6 @@
 """ Report header """
+import warnings
+
 from ..formatting.text_align import TextAlignment
 
 
@@ -9,30 +11,41 @@ class ReportHeader:
   Attributes
     - content : Display name
     - width : Column width in points (pt)
+              Deprecated, now uses the `autofit()` method of `xlsxwriter`
     - color : Cell color
     - text_color : Text color
+                   Deprecated, The text color now will use the luminance of the background color to determine the
+                   text color
     - align : Text Alignment
+    - bold : Should the text be bold
   """
 
   def __init__(
     self,
     content: str,
-    width: int = 10,
+    width: int = None,
     color: str = '#ffffff',
-    text_color: str = '#000000',
+    text_color: str = None,
     align: TextAlignment = TextAlignment.CENTER,
+    bold: bool = False,
   ) -> None:
     self.content = content
-    self.width = width
+
+    if width is not None:
+      warnings.warn('width is deprecated, use width instead', DeprecationWarning)
+
     self.color = color
-    self.text_color = text_color
+
+    if text_color is not None:
+      warnings.warn('text_color is deprecated, use color instead', DeprecationWarning)
+
     self.align = align
+    self.bold = bold
 
   @property
   def _readable(self) -> str:
     """ Readable property """
-    return f'ReportHeader(content={self.content}, width={self.width}, color={self.color}, ' +\
-           f'text_color={self.text_color}, align={self.align})'
+    return f'ReportHeader(content={self.content})'
 
   def __str__(self) -> str:
     """ Readable property """

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/reports/page.py

@@ -37,3 +37,25 @@ class ReportPage:
   def __repr__(self) -> str:
     """ Readable property """
     return self._readable
+
+
+class CustomReportPage:
+  """
+  Custom report page
+  Basically it's a wrapper of the `xlswriter` worksheet that uses a function to construct the page
+  ---
+  Attributes:
+    - 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 
+                                 return anything.
+  """
+
+  def __init__(self, name: str, builder: callable) -> None:
+    """ Constructor """
+    self.name = name
+
+    if not callable(builder):
+      raise ValueError('builder should be a callable')
+    self.builder = builder

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/reports/report.py

@@ -1,12 +1,15 @@
 """ Report class """
 import os
 import time
+import warnings
 
 import xlsxwriter
 
+from layrz.sdk.helpers.color import use_black
+
 from .col import ReportDataType
 from .format import ReportFormat
-from .page import ReportPage
+from .page import CustomReportPage, ReportPage
 
 
 class Report:
@@ -22,11 +25,16 @@ class Report:
   def __init__(
     self,
     name: str,
-    pages: list[ReportPage],
-    export_format: ReportFormat,
+    pages: list[ReportPage | CustomReportPage],
+    export_format: ReportFormat = None,
   ) -> None:
     self.name = name
     self.pages = pages
+
+    if export_format is not None:
+      warnings.warn('export_format is deprecated, submit the export format in the `export()` method instead',
+                    DeprecationWarning)
+
     self.export_format = export_format
 
   @property
@@ -37,7 +45,7 @@ class Report:
   @property
   def _readable(self) -> str:
     """ Readable property """
-    return f'Report(name={self.name}, pages={self.pages}, export_format={self.export_format})'
+    return f'Report(name={self.name}, pages={len(self.pages)})'
 
   def __repr__(self) -> str:
     """ Readable property """
@@ -76,7 +84,7 @@ class Report:
       for header in page.headers:
         headers.append({
           'content': header.content,
-          'text_color': header.text_color,
+          'text_color': '#000000' if use_black(header.color) else '#ffffff',
           'color': header.color,
         })
       rows = []
@@ -85,7 +93,7 @@ class Report:
         for cell in row.content:
           cells.append({
             'content': cell.content,
-            'text_color': cell.text_color,
+            'text_color': '#000000' if use_black(cell.color) else '#ffffff',
             'color': cell.color,
             'data_type': cell.data_type.value,
           })
@@ -111,40 +119,51 @@ class Report:
     book = xlsxwriter.Workbook(full_path)
 
     for page in self.pages:
-      sheet = book.add_worksheet(page.name[0:31].replace('[', '').replace(']', ''))
+      sheet_name = page.name[0:31]
+
+      # Allow only numbers, letters, spaces and _ or - characters
+      # Other characters will be removed
+      sheet_name = ''.join(e for e in sheet_name if e.isalnum() or e in [' ', '_', '-'])
+      sheet = book.add_worksheet(sheet_name)
+
+      if isinstance(page, CustomReportPage):
+        page.builder(sheet)
+        sheet.autofit()
+        continue
+
       if page.freeze_header:
         sheet.freeze_panes(1, 0)
 
       for i, header in enumerate(page.headers):
         style = book.add_format({
           'align': header.align.value,
-          'font_color': header.text_color,
+          'font_color': '#000000' if use_black(header.color) else '#ffffff',
           'bg_color': header.color,
+          'bold': header.bold,
           'valign': 'vcenter',
-          'font_size': 14,
+          'font_size': 11,
           'top': 1,
           'left': 1,
           'right': 1,
           'bottom': 1,
-          'font_name': 'Microsoft YaHei Light'
+          'font_name': 'Aptos Narrow',
         })
         sheet.write(0, i, header.content, style)
-        sheet.set_column(i, i, header.width)
 
       for i, row in enumerate(page.rows):
         for j, cell in enumerate(row.content):
           style = {
             'align': cell.align.value,
-            'font_color': cell.text_color,
+            'font_color': '#000000' if use_black(cell.color) else '#ffffff',
             'bg_color': cell.color,
             'bold': cell.bold,
             'valign': 'vcenter',
-            'font_size': 10,
+            'font_size': 11,
             'top': 1,
             'left': 1,
             'right': 1,
             'bottom': 1,
-            'font_name': 'Microsoft YaHei Light'
+            'font_name': 'Aptos Narrow',
           }
 
           if cell.data_type == ReportDataType.BOOL:
@@ -169,6 +188,8 @@ class Report:
             sheet.set_row(i + 1, None, None, {'level': 1, 'hidden': True})
           else:
             sheet.set_row(i + 1, None, None, {'collapsed': True})
+
+      sheet.autofit()
     book.close()
 
     return full_path

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3}/layrz/sdk/entities/reports/row.py

@@ -17,18 +17,21 @@ class ReportRow:
   def __init__(
     self,
     content: list[ReportCol],
-    height: float = 14,
+    height: float = None,
     compact: bool = False,
   ) -> None:
     """ Constructor """
     self.content = content
-    self.height = height
+
+    if height is not None:
+      raise DeprecationWarning('height is deprecated, use height instead')
+
     self.compact = compact
 
   @property
   def _readable(self) -> str:
     """ Readable property """
-    return f'ReportRow(content={self.content}, height={self.height}, compact={self.compact})'
+    return f'ReportRow(content={self.content})'
 
   def __str__(self) -> str:
     """ Readable property """

{layrz-sdk-2.2.2 → layrz-sdk-2.2.3/layrz_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: layrz-sdk
-Version: 2.2.2
+Version: 2.2.3
 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-2.2.2 → layrz-sdk-2.2.3}/pyproject.toml

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