py-eb-model 1.0.0__py3-none-any.whl

py_eb_model/parser/eb_parser.py

@@ -0,0 +1,147 @@
+#from xml.etree import cElementTree as ET
+import xml.etree.ElementTree as ET
+import re
+
+from abc import ABCMeta
+from typing import List
+
+class EBModelParser(metaclass = ABCMeta):
+
+    def __init__(self) -> None:
+        self.ns = {}
+
+        if type(self) == "EBModelParser":
+            raise ValueError("Abstract EBModelParser cannot be initialized.")
+
+    def validate_root(self, element: ET.Element):
+        if (element.tag != "{%s}%s" % (self.ns[''], "datamodel")):
+            raise ValueError("This document <%s> is not EB xdm format" % element.tag)
+
+    def read_ref_raw_value(self, value):
+        '''
+            Internal function and please call _read_ref_value instead of it
+        '''
+        #match = re.match(r'ASPath.*\/(.*)', value)
+        match = re.match(r'ASPath:(.*)', value)
+        if (match):
+            return match.group(1)
+        return value
+
+    def read_value(self, parent: ET.Element, name: str) -> str:
+        tag = parent.find(".//d:var[@name='%s']" % name, self.ns)
+        if tag == None:
+            raise KeyError("XPath d:var[@name='%s'] is invalid" % name)
+        if (tag.attrib['type'] == 'INTEGER'):
+            return int(tag.attrib['value'])
+        elif (tag.attrib['type'] == "FLOAT"):
+            return float(tag.attrib['value'])
+        elif (tag.attrib['type'] == 'BOOLEAN'):
+            if (tag.attrib['value'] == 'true'):
+                return True
+            else:
+                return False
+        else:
+            return tag.attrib['value']
+
+    def read_optional_value(self, parent: ET.Element, name: str, default_value = None) -> str:
+        tag = parent.find(".//d:var[@name='%s']" % name, self.ns)
+        if tag is None:
+            return default_value
+        if ('value' not in tag.attrib):
+            return default_value
+        return tag.attrib['value']
+
+    def find_choice_tag(self, parent: ET.Element, name: str) -> ET.Element:
+        return parent.find(".//d:chc[@name='%s']" % name, self.ns)
+
+    def read_choice_value(self, parent: ET.Element, name: str) -> str:
+        tag = self.find_choice_tag(parent, name)
+        return tag.attrib['value']
+
+    def read_ref_value(self, parent: ET.Element, name: str) -> str:
+        tag = parent.find(".//d:ref[@name='%s']" % name, self.ns)
+        return self.read_ref_raw_value(tag.attrib['value'])
+
+    def read_optional_ref_value(self, parent: ET.Element, name: str) -> str:
+        tag = parent.find(".//d:ref[@name='%s']" % name, self.ns)
+        enable = self.read_attrib(tag, 'ENABLE')
+        if (enable == 'false'):
+            return ""
+        return self.read_ref_raw_value(tag.attrib['value'])
+
+    def read_ref_value_list(self, parent: ET.Element, name: str) -> List[str]:
+        ref_value_list = []
+        for tag in parent.findall(".//d:lst[@name='%s']/d:ref" % name, self.ns):
+            ref_value_list.append(
+                self.read_ref_raw_value(tag.attrib['value']))
+        return ref_value_list
+
+    def find_ctr_tag_list(self, parent: ET.Element, name: str) -> List[ET.Element]:
+        return parent.findall(".//d:lst[@name='%s']/d:ctr" % name, self.ns)
+    
+    def find_chc_tag_list(self, parent: ET.Element, name: str) -> List[ET.Element]:
+        return parent.findall(".//d:lst[@name='%s']/d:chc" % name, self.ns)
+
+    def find_ctr_tag(self, parent: ET.Element, name: str) -> ET.Element:
+        '''
+        Read the child ctr tag. 
+        '''
+        tag = parent.find(".//d:ctr[@name='%s']" % name, self.ns)
+        if tag is None:
+            return None
+        enable = self.read_attrib(tag, 'ENABLE')
+        # ctr has the value if 
+        #   1. enable attribute do not exist
+        #   2. enable attribute is not false
+        if enable is not None and enable == "false":    
+            return None
+        return tag
+
+    def create_ctr_tag(self, name: str, type: str)-> ET.Element:
+        ctr_tag = ET.Element("d:ctr")
+        ctr_tag.attrib['name'] = name
+        ctr_tag.attrib['type'] = type
+        return ctr_tag
+
+    def create_ref_tag(self, name:str, type: str, value = "")-> ET.Element:
+        ref_tag = ET.Element("d:ref")
+        ref_tag.attrib['name'] = name
+        ref_tag.attrib['type'] = type
+        if (value != ""):
+            ref_tag.attrib['value'] = "ASPath:%s" % value
+        return ref_tag
+
+    def create_choice_tag(self, name:str, type:str, value: str)-> ET.Element:
+        choice_tag = ET.Element("d:chc")
+        choice_tag.attrib['name'] = name
+        choice_tag.attrib['type'] = type
+        choice_tag.attrib['value'] = value
+        return choice_tag
+
+    def create_attrib_tag(self, name:str, value: str) -> ET.Element:
+        attrib_tag = ET.Element("a:a")
+        attrib_tag.attrib['name'] = name
+        attrib_tag.attrib['value'] = value
+        return attrib_tag
+
+    def create_ref_lst_tag(self, name:str, type:str = "", ref_list: List[str] = []) -> ET.Element:
+        lst_tag = ET.Element("d:lst")
+        lst_tag.attrib['name'] = name
+        for ref in ref_list:
+            ref_tag = ET.Element("d:ref")
+            ref_tag.attrib['type'] = type
+            ref_tag.attrib['value'] = "ASPath:%s" % ref
+            lst_tag.append(ref_tag)
+        return lst_tag
+
+    def find_lst_tag(self, parent: ET.Element, name: str) -> ET.Element:
+        return parent.find(".//d:lst[@name='%s']" % name, self.ns)
+
+    def read_attrib(self, parent: ET.Element, name: str) -> str:
+        attrib_tag = parent.find(".//a:a[@name='%s']" % name, self.ns)
+        if attrib_tag is None:
+            return None
+        return attrib_tag.attrib['value']
+
+    def _read_namespaces(self, xdm: str):
+        self.ns = dict([node for _, node in ET.iterparse(xdm, events=['start-ns'])])

py_eb_model/parser/os_xdm_parser.py

@@ -0,0 +1,43 @@
+from typing import List, Dict
+import xml.etree.ElementTree as ET
+import re
+
+from ..models.abstract import EcucContainer, EcucObject
+from ..models.eb_doc import EBModel
+from ..models.os_xdm import Os, OsApplication, OsCounter, OsResource, OsTask, OsIsr
+from .eb_parser import EBModelParser
+
+class OsXdmParser(EBModelParser):
+    def __init__(self, ) -> None:
+        super().__init__()
+
+    def parse(self, filename: str, doc: EBModel):
+        self._read_namespaces(filename)
+        tree = ET.parse(filename)
+        self.root_tag = tree.getroot()
+        self.validate_root(self.root_tag)
+
+        self.read_os_tasks(doc.getOs())
+        self.read_os_isrs(doc.getOs())
+
+    def read_os_tasks(self, os: Os):
+        for ctr_tag in self.find_ctr_tag_list(self.root_tag, 'OsTask'):
+            os_task = OsTask()
+            os_task.setName(ctr_tag.attrib['name']) \
+                .setOsTaskPriority(self.read_value(ctr_tag, "OsTaskPriority")) \
+                .setOsTaskActivation(self.read_value(ctr_tag, "OsTaskActivation")) \
+                .setOsTaskSchedule(self.read_value(ctr_tag, "OsTaskSchedule")) \
+                .setOsStacksize(self.read_optional_value(ctr_tag, "OsStacksize", 0))
+            os.addOsTask(os_task)
+    
+    def read_os_isrs(self, os: Os):
+        for ctr_tag in self.find_ctr_tag_list(self.root_tag, 'OsIsr'):
+            os_isr = OsIsr()
+            os_isr.setName(ctr_tag.attrib['name']) \
+                .setOsIsrCategory(self.read_value(ctr_tag, "OsIsrCategory")) \
+                .setOsIsrPeriod(self.read_optional_value(ctr_tag, "OsIsrPeriod", 0.0)) \
+                .setOsStacksize(self.read_value(ctr_tag, "OsStacksize")) \
+                .setOsIsrPriority(self.read_optional_value(ctr_tag, "OsIsrPriority"))
+
+            os.addOsIsr(os_isr)
+    

py_eb_model/reporter/__init__.py

@@ -0,0 +1 @@
+from .excel_reporter.os_xdm import *

py_eb_model/reporter/excel_reporter/abstract.py

@@ -0,0 +1,43 @@
+import logging
+from openpyxl import Workbook
+from openpyxl.worksheet.worksheet import Worksheet
+
+class ExcelReporter:
+    def __init__(self) -> None:
+        self.wb = Workbook()
+        self._logger = logging.getLogger()
+    
+    def write_revision(self):
+        sheet = self.wb['Sheet']
+        sheet.title = "History"
+
+        title_rows = ["When", "Who", "Version", "History"]
+        self.write_title_row(sheet, title_rows)
+
+    def auto_width(self, worksheet: Worksheet):
+        dims = {}
+        for row in worksheet.rows:
+            for cell in row:
+                if cell.value:
+                    dims[cell.column_letter] = max((dims.get(cell.column_letter, 0), len(str(cell.value))))
+
+        for col, value in dims.items():
+            worksheet.column_dimensions[col].width = (value + 2) + 2
+
+    def write_title_row(self, sheet: Worksheet, title_row):
+        for idx in range(0, len(title_row)):
+            cell = sheet.cell(row=1, column=idx + 1)
+            cell.value = title_row[idx]
+
+    def write_cell(self, sheet, row, column, value, format = None):
+        cell = sheet.cell(row = row, column=column) 
+        cell.value = value
+        if (format != None):
+            if ('alignment' in format):
+                cell.alignment = format['alignment']
+            if ('number_format' in format):
+                cell.number_format = format['number_format']
+
+    def save(self, name: str):
+        self.wb.save(name)
+

py_eb_model/reporter/excel_reporter/os_xdm.py

@@ -0,0 +1,44 @@
+from ...models.eb_doc import EBModel
+from .abstract import ExcelReporter
+
+class OsXdmXlsWriter(ExcelReporter):
+    def __init__(self) -> None:
+        super().__init__()
+
+    def write_os_tasks(self, doc: EBModel):
+        sheet = self.wb.create_sheet("OsTask", 0)
+
+        title_row = ["Name", "OsTaskActivation", "OsTaskPriority", "OsTaskSchedule", "OsStacksize"]
+        self.write_title_row(sheet, title_row)
+
+        row = 2
+        for os_task in doc.getOs().getOsTaskList():
+            self.write_cell(sheet, row, 1, os_task.getName())
+            self.write_cell(sheet, row, 2, os_task.getOsTaskActivation())
+            self.write_cell(sheet, row, 3, os_task.getOsTaskPriority())
+            self.write_cell(sheet, row, 4, os_task.getOsTaskSchedule())
+            self.write_cell(sheet, row, 5, os_task.getOsStacksize())
+            row += 1
+
+        self.auto_width(sheet)
+
+    def write_os_isrs(self, doc: EBModel):
+        sheet = self.wb.create_sheet("OsIsr", 0)
+
+        title_row = ["Name", "OsIsrCategory", "OsStacksize"]
+        self.write_title_row(sheet, title_row)
+
+        row = 2
+        for os_isr in doc.getOs().getOsIsrList():
+            self.write_cell(sheet, row, 1, os_isr.getName())
+            self.write_cell(sheet, row, 2, os_isr.getOsIsrCategory())
+            self.write_cell(sheet, row, 3, os_isr.getOsStacksize())
+            row += 1
+
+        self.auto_width(sheet)
+
+    def write(self, filename, doc: EBModel):
+        self.write_os_tasks(doc)
+        self.write_os_isrs(doc)
+
+        self.save(filename)

py_eb_model/reporter/markdown.py

@@ -0,0 +1,40 @@
+import logging
+
+from ..models import OsAutoSARDoc, OsApplication, BswModuleInstance
+
+class OsApplicationMarkdownWriter:
+    def __init__(self) -> None:
+        self._logger = logging.getLogger()
+
+    def _write_line(self, f_in, line: str):
+        f_in.write(line + "\n")
+
+    def _write_instances(self, f_in, os_application: OsApplication):
+        self._write_line(f_in, "|Instance|Instance Type|Component Type|ASIL|Runnable|Task")
+        self._write_line(f_in, "|--|--|--|--|--|--|")
+        for instance in os_application.get_instances():
+            if isinstance(instance, BswModuleInstance):
+                component_type = "BSW Module"
+            else:
+                component_type = "SW Component"
+            if len(instance.get_mappings()) > 0:
+                package = instance.get_mappings()[0].package
+            else:
+                package = ""
+            self._write_line(f_in, "|%s|%s|%s|%s|%s|%s|" % (instance.name, instance.type, component_type , "", package, ""))
+            for mapping in instance.get_mappings():
+                self._write_line(f_in, "|%s|%s|%s|%s|%s|%s|" % ("", "", "", "", mapping.event, mapping.task))
+
+
+    def _write_os_applications(self, f_in, doc: OsAutoSARDoc):
+        self._write_line(f_in, "# OS Application")
+        for os_app in doc.get_os_applications():
+            self._write_line(f_in, "## %s" % os_app.name)
+            self._write_instances(f_in, os_app)
+                
+
+    def write(self, filename: str, doc: OsAutoSARDoc):
+        with open(filename, 'w') as f_in:
+            self._write_os_applications(f_in, doc)
+            
+

py_eb_model-1.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 melodypapa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_eb_model-1.0.0.dist-info/METADATA

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: py-eb-model
+Version: 1.0.0
+Summary: The parser for EB XDM file
+Home-page: UNKNOWN
+Author: melodypapa
+Author-email: melodypapa@outlook.com
+License: proprietary
+Platform: UNKNOWN
+Requires-Dist: openpyxl
+Provides-Extra: pytest
+Requires-Dist: pytest-cov ; extra == 'pytest'
+
+UNKNOWN
+
+

py_eb_model-1.0.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+eb_model/__init__.py,sha256=u3VUin2V_1eExLd9NIpw_LGHIAwaG2vEoyhssZurrvM,69
+eb_model/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eb_model/cli/os_xdm_2_xls_cli.py,sha256=BzeFhyWHbG57qieDNESaXYggszHSy17uwCeXvEfrbCQ,1629
+eb_model/models/__init__.py,sha256=_WDgFMwl8w3WnI4ZpjHXMdJVdmqPRpwJ8GLMb4_RGk0,71
+eb_model/models/abstract.py,sha256=JS_aVD3vPWbYTTpPVo7POilqnXVixVCqbdbMel8Rt7s,1901
+eb_model/models/eb_doc.py,sha256=5SbUrleAKPQaHSoOlvHwVxpKLdxVlksB4lxXTsKhvro,1296
+eb_model/models/os_xdm.py,sha256=8Zbl4zPvX4V5cemwVej3QlIe7xTw61d6shOR0jWHU58,6274
+eb_model/parser/__init__.py,sha256=5qHXKEfEMcE0WvvinJQu_21bNzWFdXTJxUudy-85DEE,40
+eb_model/parser/eb_parser.py,sha256=OQ94JBOHuX4FleQDgOpvI-VMU8IsM4S7lz0onmPFro0,5840
+eb_model/parser/os_xdm_parser.py,sha256=ZzS45j_0R6kj1Og0iXKP2IupwGLkNrbzPhPrqNFRvXs,1834
+eb_model/reporter/__init__.py,sha256=H8D_23UwJi1Ph6yjBfZhxWVbu9ci5_O4471gqXGiZCM,36
+eb_model/reporter/markdown.py,sha256=NhcJOFQ_BVbkgGe66uAT7KUPIchWU4kfVMtMLQtbK-w,1647
+eb_model/reporter/excel_reporter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eb_model/reporter/excel_reporter/abstract.py,sha256=BOuLhWwwTwqBzErtmwPrelB1iByMfZP9haFmg9ayFQw,1488
+eb_model/reporter/excel_reporter/os_xdm.py,sha256=WGMxK0PYxi9J5fUZ-EeiiM8NBpIg2WyxRsrN-gK37YE,1589
+eb_model/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eb_model/tests/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eb_model/tests/models/test_eb_model.py,sha256=9CQ503ZaMf3LhBBmw8Yvoa7HUWTBctTsgvrGxKOAKZA,798
+eb_model/tests/models/test_ecuc_container.py,sha256=lZmtXwPMz9T52WFduTgFy16fO2agjSW-Rl2cVypM86s,722
+py_eb_model/__init__.py,sha256=u3VUin2V_1eExLd9NIpw_LGHIAwaG2vEoyhssZurrvM,69
+py_eb_model/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_eb_model/cli/os_xdm_2_xls_cli.py,sha256=BzeFhyWHbG57qieDNESaXYggszHSy17uwCeXvEfrbCQ,1629
+py_eb_model/models/__init__.py,sha256=_WDgFMwl8w3WnI4ZpjHXMdJVdmqPRpwJ8GLMb4_RGk0,71
+py_eb_model/models/abstract.py,sha256=JS_aVD3vPWbYTTpPVo7POilqnXVixVCqbdbMel8Rt7s,1901
+py_eb_model/models/eb_doc.py,sha256=5SbUrleAKPQaHSoOlvHwVxpKLdxVlksB4lxXTsKhvro,1296
+py_eb_model/models/os_xdm.py,sha256=8Zbl4zPvX4V5cemwVej3QlIe7xTw61d6shOR0jWHU58,6274
+py_eb_model/parser/__init__.py,sha256=5qHXKEfEMcE0WvvinJQu_21bNzWFdXTJxUudy-85DEE,40
+py_eb_model/parser/eb_parser.py,sha256=OQ94JBOHuX4FleQDgOpvI-VMU8IsM4S7lz0onmPFro0,5840
+py_eb_model/parser/os_xdm_parser.py,sha256=ZzS45j_0R6kj1Og0iXKP2IupwGLkNrbzPhPrqNFRvXs,1834
+py_eb_model/reporter/__init__.py,sha256=H8D_23UwJi1Ph6yjBfZhxWVbu9ci5_O4471gqXGiZCM,36
+py_eb_model/reporter/markdown.py,sha256=NhcJOFQ_BVbkgGe66uAT7KUPIchWU4kfVMtMLQtbK-w,1647
+py_eb_model/reporter/excel_reporter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_eb_model/reporter/excel_reporter/abstract.py,sha256=BOuLhWwwTwqBzErtmwPrelB1iByMfZP9haFmg9ayFQw,1488
+py_eb_model/reporter/excel_reporter/os_xdm.py,sha256=WGMxK0PYxi9J5fUZ-EeiiM8NBpIg2WyxRsrN-gK37YE,1589
+py_eb_model-1.0.0.dist-info/LICENSE,sha256=I52rGS7W1IwAmYCUfqTpDaSHoFAdt7grcNiBhk-Z3eI,1088
+py_eb_model-1.0.0.dist-info/METADATA,sha256=2yXqGKu6Eae1XJd-6lq7P9V43-yU3X1pmfkGP5owNwU,325
+py_eb_model-1.0.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+py_eb_model-1.0.0.dist-info/entry_points.txt,sha256=IHGW3xgrsn_jKNj6w-8a20QV3b6BHQ3MWybML3Usums,68
+py_eb_model-1.0.0.dist-info/top_level.txt,sha256=DGBNh6YW_x4RF_UoLKW3cKqb2SLnmfuEIZlkTewR66A,9
+py_eb_model-1.0.0.dist-info/RECORD,,

py_eb_model-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

py_eb_model-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+os-xdm-xlsx = eb_model.cli.os_xdm_2_xls_cli:main
+

py_eb_model-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+eb_model