layrz-sdk 3.0.14__py3-none-any.whl → 3.1.0__py3-none-any.whl

layrz_sdk/entities/charts/{bar.py → bar_chart.py}

@@ -1,208 +1,171 @@
-"""Bar chart"""
-
-from typing import Any, List
-
-from .alignment import ChartAlignment
-from .configuration import AxisConfig
-from .exceptions import ChartException
-from .render_technology import ChartRenderTechnology
-from .serie import ChartDataSerie
-from .serie_type import ChartDataSerieType
-
-
-class BarChart:
-  """
-  Bar chart configuration
-  """
-
-  def __init__(
-    self,
-    x_axis: ChartDataSerie,
-    y_axis: List[ChartDataSerie],
-    title: str = 'Chart',
-    align: ChartAlignment = ChartAlignment.CENTER,
-    x_axis_config: AxisConfig = None,
-    y_axis_config: AxisConfig = None,
-  ) -> None:
-    """
-    Constructor
-    ----
-    Arguments
-      - x_axis : Defines the X Axis of the chart, uses the ChartDataSerie class.
-                 Please read the documentation to more information.
-      - y_axis : Defines the Y Axis of the chart, uses the ChartDataSerie class.
-                 Please read the documentation to more information.
-      - title : Title of the chart
-      - align : Alignment of the title
-      - x_axis_config : Configuration of the X Axis
-      - y_axis_config : Configuration of the Y Axis
-    """
-    for i, serie in enumerate(y_axis):
-      if not isinstance(serie, ChartDataSerie):
-        raise ChartException(f'Y Axis serie {i} must be an instance of ChartDataSerie')
-    self.y_axis = y_axis
-
-    if not isinstance(x_axis, ChartDataSerie):
-      raise ChartException('X Axis must be an instance of ChartDataSerie')
-    self.x_axis = x_axis
-
-    if not isinstance(title, str):
-      raise ChartException('title must be an instance of str')
-    self.title = title
-
-    if not isinstance(align, ChartAlignment):
-      raise ChartException('align must be an instance of ChartAlignment')
-    self.align = align
-
-    if x_axis_config is None:
-      x_axis_config = AxisConfig()
-
-    if not isinstance(x_axis_config, AxisConfig):
-      raise ChartException('x_axis_config must be an instance of AxisConfig')
-    self.x_axis_config = x_axis_config
-
-    if y_axis_config is None:
-      y_axis_config = AxisConfig()
-
-    if not isinstance(y_axis_config, AxisConfig):
-      raise ChartException('y_axis_config must be an instance of AxisConfig')
-    self.y_axis_config = y_axis_config
-
-  def render(
-    self,
-    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
-  ) -> Any:
-    """
-    Render chart to a graphic Library.
-    We have two graphic libraries: GRAPHIC and APEXCHARTS.
-
-    GRAPHIC is a Flutter chart library. To return this option, use the parameter use_new_definition=True.
-    APEXCHARTS is a Javascript chart library. This is the default option.
-    """
-    if technology == ChartRenderTechnology.GRAPHIC:
-      return {
-        'library': 'GRAPHIC',
-        'chart': 'BAR',
-        'configuration': self._render_graphic(),
-      }
-
-    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
-      return {
-        'library': 'SYNCFUSION_FLUTTER_CHARTS',
-        'chart': 'BAR',
-        'configuration': self._render_syncfusion_flutter_charts(),
-      }
-
-    if technology == ChartRenderTechnology.APEX_CHARTS:
-      return {
-        'library': 'APEXCHARTS',
-        'chart': 'BAR',
-        'configuration': self._render_apexcharts(),
-      }
-
-    return {
-      'library': 'FLUTTER',
-      'chart': 'TEXT',
-      'configuration': [f'Unsupported rendering technology {technology.name}'],
-    }
-
-  def _render_syncfusion_flutter_charts(self) -> Any:
-    """
-    Converts the configuration of the chart to Syncfusion Flutter Charts.
-    """
-    series = []
-
-    for serie in self.y_axis:
-      values = []
-      for i, value in enumerate(serie.data):
-        x_axis = self.x_axis.data[i]
-        values.append({'xAxis': x_axis, 'yAxis': value})
-
-      series.append(
-        {
-          'label': serie.label,
-          'color': serie.color,
-          'values': values,
-        }
-      )
-
-    return {
-      'series': series,
-      'xAxis': {
-        'label': self.x_axis_config.label,
-        'measureUnit': self.x_axis_config.measure_unit,
-        'dataType': self.x_axis_config.data_type.value,
-        'minValue': self.x_axis_config.min_value,
-        'maxValue': self.x_axis_config.max_value,
-      },
-      'yAxis': {
-        'label': self.y_axis_config.label,
-        'measureUnit': self.y_axis_config.measure_unit,
-        'dataType': self.y_axis_config.data_type.value,
-        'minValue': self.y_axis_config.min_value,
-        'maxValue': self.y_axis_config.max_value,
-      },
-    }
-
-  def _render_graphic(self) -> Any:
-    """
-    Converts the configuration of the chart to Flutter library graphic.
-    """
-
-    series = []
-
-    for serie in self.y_axis:
-      for i, value in enumerate(serie.data):
-        x_axis = self.x_axis.data[i]
-        series.append(
-          {
-            'label': serie.label,
-            'color': serie.color,
-            'category': x_axis,
-            'value': value,
-          }
-        )
-
-    return series
-
-  def _render_apexcharts(self) -> Any:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-    colors = []
-
-    for serie in self.y_axis:
-      modified_serie = {'name': serie.label, 'data': serie.data}
-
-      if serie.serie_type is not ChartDataSerieType.NONE:
-        modified_serie['type'] = serie.serie_type.value
-
-      series.append(modified_serie)
-      colors.append(serie.color)
-
-    config = {
-      'series': series,
-      'colors': colors,
-      'xaxis': {
-        'categories': self.x_axis.data,
-        'type': self.x_axis.data_type.value,
-        'title': {'text': self.x_axis.label},
-      },
-      'title': {
-        'text': self.title,
-        'align': self.align.value,
-        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-      },
-      'plotOptions': {'bar': {'horizontal': True, 'borderRadius': 4}},
-      'dataLabels': {'enabled': False},
-      'chart': {
-        'type': 'bar',
-        'animations': {'enabled': False},
-        'toolbar': {'show': False},
-        'zoom': {'enabled': False},
-      },
-    }
-
-    return config
+"""Bar chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .axis_config import AxisConfig
+from .chart_alignment import ChartAlignment
+from .chart_data_serie import ChartDataSerie
+from .chart_data_serie_type import ChartDataSerieType
+from .chart_render_technology import ChartRenderTechnology
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class BarChart(BaseModel):
+  """Bar chart configuration"""
+
+  x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
+  y_axis: List[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
+  title: str = Field(default='Chart', description='Title of the chart')
+  align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
+  x_axis_config: AxisConfig = Field(
+    default_factory=lambda: AxisConfig(),
+    description='Configuration of the X Axis',
+  )
+  y_axis_config: AxisConfig = Field(
+    default_factory=lambda: AxisConfig(),
+    description='Configuration of the Y Axis',
+  )
+
+  def render(
+    self: Self,
+    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
+  ) -> Dict[str, Any]:
+    """
+    Render chart to a graphic Library.
+    :param technology: The technology to use to render the chart.
+    :return: The configuration of the chart.
+    """
+    if technology == ChartRenderTechnology.GRAPHIC:
+      return {
+        'library': 'GRAPHIC',
+        'chart': 'BAR',
+        'configuration': self._render_graphic(),
+      }
+
+    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
+      return {
+        'library': 'SYNCFUSION_FLUTTER_CHARTS',
+        'chart': 'BAR',
+        'configuration': self._render_syncfusion_flutter_charts(),
+      }
+
+    if technology == ChartRenderTechnology.APEX_CHARTS:
+      return {
+        'library': 'APEXCHARTS',
+        'chart': 'BAR',
+        'configuration': self._render_apexcharts(),
+      }
+
+    return {
+      'library': 'FLUTTER',
+      'chart': 'TEXT',
+      'configuration': [f'Unsupported rendering technology {technology.name}'],
+    }
+
+  def _render_syncfusion_flutter_charts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Syncfusion Flutter Charts.
+    """
+    series = []
+
+    for serie in self.y_axis:
+      values = []
+      for i, value in enumerate(serie.data):
+        x_axis = self.x_axis.data[i]
+        values.append({'xAxis': x_axis, 'yAxis': value})
+
+      series.append(
+        {
+          'label': serie.label,
+          'color': serie.color,
+          'values': values,
+        }
+      )
+
+    return {
+      'series': series,
+      'xAxis': {
+        'label': self.x_axis_config.label,
+        'measureUnit': self.x_axis_config.measure_unit,
+        'dataType': self.x_axis_config.data_type.value,
+        'minValue': self.x_axis_config.min_value,
+        'maxValue': self.x_axis_config.max_value,
+      },
+      'yAxis': {
+        'label': self.y_axis_config.label,
+        'measureUnit': self.y_axis_config.measure_unit,
+        'dataType': self.y_axis_config.data_type.value,
+        'minValue': self.y_axis_config.min_value,
+        'maxValue': self.y_axis_config.max_value,
+      },
+    }
+
+  def _render_graphic(self: Self) -> List[Dict[str, Any]]:
+    """
+    Converts the configuration of the chart to Flutter library graphic.
+    """
+
+    series = []
+
+    for serie in self.y_axis:
+      for i, value in enumerate(serie.data):
+        x_axis = self.x_axis.data[i]
+        series.append(
+          {
+            'label': serie.label,
+            'color': serie.color,
+            'category': x_axis,
+            'value': value,
+          }
+        )
+
+    return series
+
+  def _render_apexcharts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+    colors = []
+
+    for serie in self.y_axis:
+      modified_serie = {'name': serie.label, 'data': serie.data}
+
+      if serie.serie_type is not ChartDataSerieType.NONE:
+        modified_serie['type'] = serie.serie_type.value
+
+      series.append(modified_serie)
+      colors.append(serie.color)
+
+    config = {
+      'series': series,
+      'colors': colors,
+      'xaxis': {
+        'categories': self.x_axis.data,
+        'type': self.x_axis.data_type.value,
+        'title': {'text': self.x_axis.label},
+      },
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'plotOptions': {'bar': {'horizontal': True, 'borderRadius': 4}},
+      'dataLabels': {'enabled': False},
+      'chart': {
+        'type': 'bar',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+    }
+
+    return config

layrz_sdk/entities/charts/chart_alignment.py

@@ -0,0 +1,27 @@
+"""Chart alignment"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ChartAlignment(Enum):
+  """
+  Chart Alignment
+  """
+
+  CENTER = 'center'
+  LEFT = 'left'
+  RIGHT = 'right'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ChartAlignment.{self.name}'

layrz_sdk/entities/charts/chart_color.py

@@ -0,0 +1,44 @@
+"""Chart alignment"""
+
+import sys
+from enum import Enum
+from typing import Any, List
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ChartColor(Enum):
+  """Chart color list, ideal to use to colorize the series"""
+
+  RED = '#F44336'
+  BLUE = '#2196F3'
+  GREEN = '#4CAF50'
+  PURPLE = '#9C27B0'
+  ORANGE = '#FF9800'
+  PINK = '#E91E63'
+  TEAL = '#009688'
+  AMBER = '#FFC107'
+  CYAN = '#00BCD4'
+  INDIGO = '#3F51B5'
+  LIME = '#CDDC39'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ChartColor.{self.name}'
+
+  @staticmethod
+  def get_colors() -> List[str]:
+    """Get a color from the list"""
+    return [color.value for color in ChartColor]
+
+
+def get_color_list() -> List[str]:
+  """Get all colors"""
+  return ChartColor.get_colors()

layrz_sdk/entities/charts/chart_configuration.py

@@ -0,0 +1,10 @@
+"""Charts entities"""
+
+from pydantic import BaseModel, Field
+
+
+class ChartConfiguration(BaseModel):
+  """Chart configuration"""
+
+  name: str = Field(description='Name of the chart')
+  description: str = Field(description='Description of the chart')

layrz_sdk/entities/charts/chart_data_serie.py

@@ -0,0 +1,19 @@
+"""Chart Data Serie"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .chart_data_serie_type import ChartDataSerieType
+from .chart_data_type import ChartDataType
+
+
+class ChartDataSerie(BaseModel):
+  """Chart Serie"""
+
+  data: Any = Field(description='Data of the serie')
+  color: str = Field(description='Color of the serie', default='#000000')
+  label: str = Field(description='Label of the serie', default='')
+  serie_type: ChartDataSerieType = Field(description='Type of the serie', default=ChartDataSerieType.LINE)
+  data_type: ChartDataType = Field(description='Type of the data', default=ChartDataType.NUMBER)
+  dashed: bool = Field(description='If the serie should be dashed', default=False)

layrz_sdk/entities/charts/chart_data_serie_type.py

@@ -0,0 +1,28 @@
+"""Chart Serie type"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ChartDataSerieType(Enum):
+  """
+  Chart data serie type
+  """
+
+  NONE = None
+  LINE = 'line'
+  AREA = 'area'
+  SCATTER = 'scatter'
+
+  def __str__(self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self) -> str:
+    """Readable property"""
+    return f'ChartDataSerieType.{self.name}'

layrz_sdk/entities/charts/chart_data_type.py

@@ -0,0 +1,27 @@
+"""Chart Data type"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ChartDataType(Enum):
+  """
+  Chart Data Type
+  """
+
+  STRING = 'STRING'
+  DATETIME = 'DATETIME'
+  NUMBER = 'NUMBER'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ChartDataType.{self.name}'

layrz_sdk/entities/charts/{render_technology.py → chart_render_technology.py}

@@ -1,29 +1,30 @@
-"""Chart rendering technology / library"""
-
-from enum import Enum
-
-
-class ChartRenderTechnology(Enum):
-  """
-  Chart Alignment
-  """
-
-  CANVAS_JS = 'CANVAS_JS'
-  GRAPHIC = 'GRAPHIC'
-  SYNCFUSION_FLUTTER_CHARTS = 'SYNCFUSION_FLUTTER_CHARTS'
-  FLUTTER_MAP = 'FLUTTER_MAP'
-  APEX_CHARTS = 'APEX_CHARTS'
-  FLUTTER = 'FLUTTER'
-
-  @property
-  def _readable(self) -> str | None | bool:
-    """Readable"""
-    return f'ChartRenderTechnology.{self.value}'
-
-  def __str__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
-
-  def __repr__(self) -> str | None | bool:
-    """Readable property"""
-    return self._readable
+"""Chart rendering technology / library"""
+
+import sys
+from enum import Enum
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ChartRenderTechnology(Enum):
+  """
+  Chart Alignment
+  """
+
+  CANVAS_JS = 'CANVAS_JS'
+  GRAPHIC = 'GRAPHIC'
+  SYNCFUSION_FLUTTER_CHARTS = 'SYNCFUSION_FLUTTER_CHARTS'
+  FLUTTER_MAP = 'FLUTTER_MAP'
+  APEX_CHARTS = 'APEX_CHARTS'
+  FLUTTER = 'FLUTTER'
+
+  def __str__(self: Self) -> str:
+    """Readable property"""
+    return self.name
+
+  def __repr__(self: Self) -> str:
+    """Readable property"""
+    return f'ChartRenderTechnology.{self.value}'