pygazpar 1.2.8__py313-none-any.whl

pygazpar/enum.py

@@ -0,0 +1,35 @@
+from enum import Enum
+
+
+# ------------------------------------------------------------------------------------------------------------
+class PropertyName(Enum):
+    TIME_PERIOD = "time_period"
+    START_INDEX = "start_index_m3"
+    END_INDEX = "end_index_m3"
+    VOLUME = "volume_m3"
+    ENERGY = "energy_kwh"
+    CONVERTER_FACTOR = "converter_factor_kwh/m3"
+    TEMPERATURE = "temperature_degC"
+    TYPE = "type"
+    TIMESTAMP = "timestamp"
+
+    def __str__(self):
+        return self.value
+
+    def __repr__(self):
+        return self.__str__()
+
+
+# ------------------------------------------------------------------------------------------------------------
+class Frequency(Enum):
+    HOURLY = "hourly"
+    DAILY = "daily"
+    WEEKLY = "weekly"
+    MONTHLY = "monthly"
+    YEARLY = "yearly"
+
+    def __str__(self):
+        return self.value
+
+    def __repr__(self):
+        return self.__str__()

pygazpar/excelparser.py

@@ -0,0 +1,138 @@
+import logging
+from datetime import datetime
+from pygazpar.enum import Frequency
+from pygazpar.enum import PropertyName
+from openpyxl.worksheet.worksheet import Worksheet
+from openpyxl.cell.cell import Cell
+from openpyxl import load_workbook
+from typing import Any, List, Dict
+
+
+FIRST_DATA_LINE_NUMBER = 10
+
+Logger = logging.getLogger(__name__)
+
+
+# ------------------------------------------------------------------------------------------------------------
+class ExcelParser:
+
+    # ------------------------------------------------------
+    @staticmethod
+    def parse(dataFilename: str, dataReadingFrequency: Frequency) -> List[Dict[str, Any]]:
+
+        parseByFrequency = {
+            Frequency.HOURLY: ExcelParser.__parseHourly,
+            Frequency.DAILY: ExcelParser.__parseDaily,
+            Frequency.WEEKLY: ExcelParser.__parseWeekly,
+            Frequency.MONTHLY: ExcelParser.__parseMonthly
+        }
+
+        Logger.debug(f"Loading Excel data file '{dataFilename}'...")
+
+        workbook = load_workbook(filename=dataFilename)
+
+        worksheet = workbook.active
+
+        res = parseByFrequency[dataReadingFrequency](worksheet)  # type: ignore
+
+        workbook.close()
+
+        Logger.debug("Processed Excel %s data: %s", dataReadingFrequency, res)
+
+        return res
+
+    # ------------------------------------------------------
+    @staticmethod
+    def __fillRow(row: Dict, propertyName: str, cell: Cell, isNumber: bool):
+
+        if cell.value is not None:
+            if isNumber:
+                if type(cell.value) is str:
+                    if len(cell.value.strip()) > 0:
+                        row[propertyName] = float(cell.value.replace(',', '.'))
+                else:
+                    row[propertyName] = cell.value
+            else:
+                row[propertyName] = cell.value.strip() if type(cell.value) is str else cell.value
+
+    # ------------------------------------------------------
+    @staticmethod
+    def __parseHourly(worksheet: Worksheet) -> List[Dict[str, Any]]:
+        return []
+
+    # ------------------------------------------------------
+    @staticmethod
+    def __parseDaily(worksheet: Worksheet) -> List[Dict[str, Any]]:
+
+        res = []
+
+        # Timestamp of the data.
+        data_timestamp = datetime.now().isoformat()
+
+        minRowNum = FIRST_DATA_LINE_NUMBER
+        maxRowNum = len(worksheet['B'])
+        for rownum in range(minRowNum, maxRowNum + 1):
+            row = {}
+            if worksheet.cell(column=2, row=rownum).value is not None:
+                ExcelParser.__fillRow(row, PropertyName.TIME_PERIOD.value, worksheet.cell(column=2, row=rownum), False)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.START_INDEX.value, worksheet.cell(column=3, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.END_INDEX.value, worksheet.cell(column=4, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.VOLUME.value, worksheet.cell(column=5, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.ENERGY.value, worksheet.cell(column=6, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.CONVERTER_FACTOR.value, worksheet.cell(column=7, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.TEMPERATURE.value, worksheet.cell(column=8, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.TYPE.value, worksheet.cell(column=9, row=rownum), False)  # type: ignore
+                row[PropertyName.TIMESTAMP.value] = data_timestamp
+                res.append(row)
+
+        Logger.debug(f"Daily data read successfully between row #{minRowNum} and row #{maxRowNum}")
+
+        return res
+
+    # ------------------------------------------------------
+    @staticmethod
+    def __parseWeekly(worksheet: Worksheet) -> List[Dict[str, Any]]:
+
+        res = []
+
+        # Timestamp of the data.
+        data_timestamp = datetime.now().isoformat()
+
+        minRowNum = FIRST_DATA_LINE_NUMBER
+        maxRowNum = len(worksheet['B'])
+        for rownum in range(minRowNum, maxRowNum + 1):
+            row = {}
+            if worksheet.cell(column=2, row=rownum).value is not None:
+                ExcelParser.__fillRow(row, PropertyName.TIME_PERIOD.value, worksheet.cell(column=2, row=rownum), False)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.VOLUME.value, worksheet.cell(column=3, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.ENERGY.value, worksheet.cell(column=4, row=rownum), True)  # type: ignore
+                row[PropertyName.TIMESTAMP.value] = data_timestamp
+                res.append(row)
+
+        Logger.debug(f"Weekly data read successfully between row #{minRowNum} and row #{maxRowNum}")
+
+        return res
+
+    # ------------------------------------------------------
+    @staticmethod
+    def __parseMonthly(worksheet: Worksheet) -> List[Dict[str, Any]]:
+
+        res = []
+
+        # Timestamp of the data.
+        data_timestamp = datetime.now().isoformat()
+
+        minRowNum = FIRST_DATA_LINE_NUMBER
+        maxRowNum = len(worksheet['B'])
+        for rownum in range(minRowNum, maxRowNum + 1):
+            row = {}
+            if worksheet.cell(column=2, row=rownum).value is not None:
+                ExcelParser.__fillRow(row, PropertyName.TIME_PERIOD.value, worksheet.cell(column=2, row=rownum), False)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.VOLUME.value, worksheet.cell(column=3, row=rownum), True)  # type: ignore
+                ExcelParser.__fillRow(row, PropertyName.ENERGY.value, worksheet.cell(column=4, row=rownum), True)  # type: ignore
+                row[PropertyName.TIMESTAMP.value] = data_timestamp
+                res.append(row)
+
+        Logger.debug(f"Monthly data read successfully between row #{minRowNum} and row #{maxRowNum}")
+
+        return res

pygazpar/jsonparser.py

@@ -0,0 +1,50 @@
+import json
+import logging
+from datetime import datetime
+from pygazpar.enum import PropertyName
+from typing import Any, List, Dict
+
+INPUT_DATE_FORMAT = "%Y-%m-%d"
+
+OUTPUT_DATE_FORMAT = "%d/%m/%Y"
+
+Logger = logging.getLogger(__name__)
+
+
+# ------------------------------------------------------------------------------------------------------------
+class JsonParser:
+
+    # ------------------------------------------------------
+    @staticmethod
+    def parse(jsonStr: str, temperaturesStr: str, pceIdentifier: str) -> List[Dict[str, Any]]:
+
+        res = []
+
+        data = json.loads(jsonStr)
+
+        temperatures = json.loads(temperaturesStr)
+
+        # Timestamp of the data.
+        data_timestamp = datetime.now().isoformat()
+
+        for releve in data[pceIdentifier]['releves']:
+            temperature = releve['temperature']
+            if temperature is None and temperatures is not None and len(temperatures) > 0:
+                temperature = temperatures.get(releve['journeeGaziere'])
+
+            item = {}
+            item[PropertyName.TIME_PERIOD.value] = datetime.strftime(datetime.strptime(releve['journeeGaziere'], INPUT_DATE_FORMAT), OUTPUT_DATE_FORMAT)
+            item[PropertyName.START_INDEX.value] = releve['indexDebut']
+            item[PropertyName.END_INDEX.value] = releve['indexFin']
+            item[PropertyName.VOLUME.value] = releve['volumeBrutConsomme']
+            item[PropertyName.ENERGY.value] = releve['energieConsomme']
+            item[PropertyName.CONVERTER_FACTOR.value] = releve['coeffConversion']
+            item[PropertyName.TEMPERATURE.value] = temperature
+            item[PropertyName.TYPE.value] = releve['qualificationReleve']
+            item[PropertyName.TIMESTAMP.value] = data_timestamp
+
+            res.append(item)
+
+        Logger.debug("Daily data read successfully from Json")
+
+        return res