cuemsutils 0.0.1__py3-none-any.whl

cuemsutils/xml/XmlBuilder.py

@@ -0,0 +1,299 @@
+# DEV: Move to cuems-utils
+import xml.etree.ElementTree as ET
+from enum import Enum
+
+from .log import logger
+from .DictParser import GenericDict
+
+
+PARSER_SUFFIX = 'XmlBuilder'
+GENERIC_BUILDER = 'GenericCueXmlBuilder'
+
+SCHEMA_INSTANCE_URI = 'http://www.w3.org/2001/XMLSchema-instance'
+VALUE_TYPES = (str, bool, int, float, Enum)
+
+class XmlBuilder():
+    def __init__(self, _object, namespace, xsd_path, xml_tree = None, xml_root_tag='CuemsProject'):
+        self._object = _object
+        self.xml_tree = xml_tree
+        self.xml_root_tag = xml_root_tag
+        self.class_name = type(_object).__name__
+        self.xsd_path = xsd_path
+        self.namespace =  namespace
+        ET.register_namespace(next(iter(self.namespace)), next(iter(self.namespace.values())))
+
+    def get_builder_class(self, _object):
+        object_class_name = type(_object).__name__
+        builder_class_name = object_class_name + PARSER_SUFFIX
+        try:
+            builder_class = globals()[builder_class_name]
+        except KeyError as err:
+            #logger.debug("Could not find class {0}, reverting to generic builder class".format(err))
+            builder_class = globals()[GENERIC_BUILDER]
+        return builder_class
+    
+    def build(self):
+
+        #xml_root = ET.Element(f'{{{next(iter(self.namespace.values()))}}}CuemsProject')
+        xml_root = ET.Element(f'{{{next(iter(self.namespace.values()))}}}{self.xml_root_tag}')
+        xml_root.attrib= {f'{{{SCHEMA_INSTANCE_URI}}}schemaLocation': next(iter(self.namespace.values())) + " " + self.xsd_path}   
+        builder_class = self.get_builder_class(self._object)
+        self.xml_tree = builder_class(self._object, xml_tree = xml_root).build()
+        
+        self.xml_tree = ET.ElementTree(self.xml_tree)
+
+        return self.xml_tree
+
+class CuemsScriptXmlBuilder(XmlBuilder):
+    def __init__(self, _object, xml_tree):
+        self._object = _object
+        self.xml_tree = xml_tree
+        self.class_name = type(_object).__name__
+
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, self.class_name)
+        
+
+        for key, value in self._object.items():
+            
+            if isinstance(value, VALUE_TYPES):
+                cue_subelement = ET.SubElement(cue_element, str(key))
+                cue_subelement.text = str(value)
+            elif isinstance(value, (type(None))):
+                cue_subelement = ET.SubElement(cue_element, str(key))
+            else:
+                cue_subelement = cue_element
+                builder_class = self.get_builder_class(value)
+                sub_object_element = builder_class(value, xml_tree = cue_subelement).build()
+        return self.xml_tree
+
+class CueListXmlBuilder(CuemsScriptXmlBuilder):
+
+    
+    def build(self):
+        cuelist_element = ET.SubElement(self.xml_tree, self.class_name)
+        for key, value in self._object.items():
+            cue_subelement = ET.SubElement(cuelist_element, str(key))          
+            if isinstance(value, VALUE_TYPES):
+                cue_subelement.text = str(value)
+            elif isinstance(value, (type(None))):
+                pass
+            elif isinstance(value, list):
+                for cuelist_item in value:
+                    builder_class = self.get_builder_class(cuelist_item)
+                    sub_object_element = builder_class(cuelist_item, xml_tree = cue_subelement).build()
+            else:
+                builder_class = self.get_builder_class(value)
+                sub_object_element = builder_class(value, xml_tree = cue_subelement).build()
+                
+
+        return self.xml_tree
+    
+        
+class GenericCueXmlBuilder(CuemsScriptXmlBuilder):
+        
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, self.class_name)
+        for key, value in self._object.items():
+            if isinstance(value, VALUE_TYPES):
+                cue_subelement = ET.SubElement(cue_element, str(key))
+                cue_subelement.text = str(value)
+            elif isinstance(value, (type(None))):
+                cue_subelement = ET.SubElement(cue_element, str(key))
+            elif isinstance(value, list):
+                cue_subelement = ET.SubElement(cue_element, str(key))
+                for list_item in value:
+                    builder_class = self.get_builder_class(list_item)
+                    sub_object_element = builder_class(list_item, xml_tree = cue_subelement).build()
+            elif isinstance(value, GenericDict):
+                cue_subelement = ET.SubElement(cue_element, str(key))
+                for sub_key, sub_value in value.items():
+                    sub_dict_element = ET.SubElement(cue_subelement, str(sub_key))
+                    sub_dict_element.text = str(sub_value)
+            else:
+                cue_subelement = ET.SubElement(cue_element, str(key))
+                builder_class = self.get_builder_class(value)
+                sub_object_element = builder_class(value, xml_tree = cue_subelement).build()
+
+class DmxSceneXmlBuilder(CuemsScriptXmlBuilder):
+ 
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, self.class_name)
+        universe_list = list(self._object.items())
+        for universe in universe_list:
+            builder_class = self.get_builder_class(universe[1])
+            sub_object_element = builder_class(universe, xml_tree = cue_element).build()
+            
+
+class DmxUniverseXmlBuilder(CuemsScriptXmlBuilder):
+        
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, type(self._object[1]).__name__, id=str(self._object[0]))
+        channel_list = list(self._object[1].items())
+        for channel in channel_list:
+            builder_class = self.get_builder_class(channel[1])
+            sub_object_element = builder_class(channel, xml_tree = cue_element).build()
+    
+class DmxChannelXmlBuilder(CuemsScriptXmlBuilder):
+    
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, type(self._object[1]).__name__, id=str(self._object[0]))
+        cue_element.text = str(self._object[1])
+
+
+
+class GenericSimpleSubObjectXmlBuilder(CuemsScriptXmlBuilder):
+    
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, self.class_name)
+        cue_element.text = str(self._object)
+
+class GenericComplexSubObjectXmlBuilder(CuemsScriptXmlBuilder):
+    
+    def build(self):
+        if isinstance(self._object, dict):
+            for key, value in self._object.items():
+                if isinstance(value, VALUE_TYPES):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                    sub_dict_element.text = str(value)
+                elif isinstance(value, (type(None))):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                elif isinstance(value, dict):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                    self.recurser(value, sub_dict_element)
+                elif isinstance(value, list):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                    self.recurser(value, sub_dict_element)
+
+    def recurser(self, group, xml_tree):
+        if isinstance(group, dict):
+            for key, value in group.items():
+                if isinstance(value, VALUE_TYPES):
+                    cue_subelement = ET.SubElement(xml_tree, key)
+                    cue_subelement.text = str(value)
+                elif isinstance(value, (type(None))):
+                    cue_subelement = ET.SubElement(xml_tree, key)
+                elif isinstance(value, dict):
+                    cue_subelement = ET.SubElement(xml_tree, key)
+                    self.recurser(value, cue_subelement)
+        elif isinstance(group, list):
+            for item in group:
+                if isinstance(item, dict):
+                    self.recurser(item, xml_tree)
+
+class CTimecodeXmlBuilder(GenericSimpleSubObjectXmlBuilder):
+    pass
+
+class MediaXmlBuilder(GenericComplexSubObjectXmlBuilder):
+    def build(self):
+        
+
+        if isinstance(self._object, dict):
+            
+
+            for key, value in self._object.items():
+                if isinstance(value, VALUE_TYPES):
+                    cue_subelement = ET.SubElement(self.xml_tree, key)
+                    cue_subelement.text = str(value)
+                elif isinstance(value, (type(None))):
+                    cue_subelement = ET.SubElement(self.xml_tree, key)
+                elif isinstance(value, dict):
+                    cue_subelement = ET.SubElement(self.xml_tree, key)
+                    self.recurser(value, cue_subelement)
+                elif isinstance(value, list):
+                    cue_subelement = ET.SubElement(self.xml_tree, key)
+                    for list_item in value:
+                        builder_class = self.get_builder_class(list_item)
+                        sub_object_element = builder_class(list_item, xml_tree =cue_subelement).build()
+                    
+
+
+
+
+class UI_propertiesXmlBuilder(GenericComplexSubObjectXmlBuilder):
+    pass
+
+class OutputsXmlBuilder(GenericComplexSubObjectXmlBuilder):
+    def build(self):
+        if isinstance(self._object, dict):
+            for key, value in self._object.items():
+                if isinstance(value, VALUE_TYPES):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                    sub_dict_element.text = str(value)
+                elif isinstance(value, (type(None))):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                elif isinstance(value, dict):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                    self.recurser(value, sub_dict_element)
+                elif isinstance(value, list):
+                    sub_dict_element = ET.SubElement(self.xml_tree, str(key))
+                    for item in value:
+                        self.recurser(item, sub_dict_element)
+        
+        return self.xml_tree
+
+    def recurser(self, group, xml_tree):
+        if isinstance(group, dict):
+            for key, value in group.items():
+                if isinstance(value, VALUE_TYPES):
+                    output_subelement = ET.SubElement(xml_tree, key)
+                    output_subelement.text = str(value)
+                elif isinstance(value, (type(None))):
+                    output_subelement = ET.SubElement(xml_tree, key)
+                elif isinstance(value, dict):
+                    output_subelement = ET.SubElement(xml_tree, key)
+                    self.recurser(value, output_subelement)
+                elif isinstance(value, list):
+                    for item in value:
+                        output_subelement = ET.SubElement(xml_tree, key)
+                        self.recurser(item, output_subelement)
+        elif isinstance(group, list):
+            for item in group:
+                if isinstance(value, VALUE_TYPES):
+                    xml_tree.text = str(item)
+                if isinstance(item, dict):
+                    self.recurser(item, xml_tree)
+        elif isinstance(group, VALUE_TYPES):
+            xml_tree.text = str(group)
+
+class CueOutputsXmlBuilder(GenericComplexSubObjectXmlBuilder):
+
+    def build(self):
+        cue_element = ET.SubElement(self.xml_tree, self.class_name)
+
+        if isinstance(self._object, dict):
+            
+
+            for key, value in self._object.items():
+                if isinstance(value, VALUE_TYPES):
+                    cue_subelement = ET.SubElement(cue_element, key)
+                    cue_subelement.text = str(value)
+                elif isinstance(value, (type(None))):
+                    cue_subelement = ET.SubElement(cue_element, key)
+                elif isinstance(value, dict):
+                    cue_subelement = ET.SubElement(cue_element, key)
+                    self.recurser(value, cue_subelement)
+                elif isinstance(value, list):
+                    cue_subelement = ET.SubElement(cue_element, key)
+                    self.recurser(value, cue_subelement)
+
+        else:   
+            cue_element.text = str(self._object)
+
+
+class AudioCueOutputXmlBuilder(CueOutputsXmlBuilder):
+    pass
+
+class VideoCueOutputXmlBuilder(CueOutputsXmlBuilder):
+    pass
+
+class DmxCueOutputXmlBuilder(CueOutputsXmlBuilder):
+    pass
+
+    
+class CuemsNodeDictXmlBuilder(CuemsScriptXmlBuilder):
+    pass
+
+    
+class NoneTypeXmlBuilder(GenericSimpleSubObjectXmlBuilder): # TODO: clean, not need anymore? 
+    pass

cuemsutils/xml/XmlReaderWriter.py

@@ -0,0 +1,84 @@
+# DEV: Move to cuems-utils
+""" For the moment it works with pip3 install xmlschema==1.2.2
+ """
+
+import os
+
+from ..log import logger
+from .CMLCuemsConverter import CMLCuemsConverter
+from .DictParser import CuemsParser
+from .XmlBuilder import XmlBuilder
+
+class CuemsXml():
+    def __init__(self, schema, xmlfile=None, namespace={'cms':'http://stagelab.net/cuems'}, xml_root_tag='CuemsProject'):
+        self.converter = CMLCuemsConverter
+        self.schema_object = None
+        self._xmlfile = None
+        self._schema = None
+        self.schema = schema
+        self.xmlfile = xmlfile
+        self.xmldata = None
+        self.namespace = namespace
+        self.xml_root_tag = xml_root_tag
+        
+    
+    @property
+    def schema(self):
+        return self._schema
+        
+
+    @schema.setter
+    def schema(self, path):
+        if path is not None:
+            if os.path.isfile(path):
+                self._schema = path
+                self.schema_object = xmlschema.XMLSchema11(self._schema, converter=self.converter)
+            else:
+                raise FileNotFoundError("schema file not found")
+
+
+    @property
+    def xmlfile(self):
+        return self._xmlfile
+
+    @xmlfile.setter
+    def xmlfile(self, path):
+        self._xmlfile = path
+            
+    def validate(self):
+        return self.schema_object.validate(self.xmlfile)
+    
+class XmlWriter(CuemsXml):
+
+    def write(self, xml_data, ):
+        self.schema_object.validate(xml_data)
+        xml_data.write(self.xmlfile, encoding="utf-8", xml_declaration=True)
+
+    def write_from_dict(self, project_dict):
+        project_object = CuemsParser(project_dict).parse()
+        xml_data = XmlBuilder(project_object, namespace=self.namespace, xsd_path=self.schema, xml_root_tag=self.xml_root_tag).build()
+        self.write(xml_data)
+
+    def write_from_object(self, project_object):
+        xml_data = XmlBuilder(project_object, namespace=self.namespace, xsd_path=self.schema, xml_root_tag=self.xml_root_tag).build()
+        self.write(xml_data)
+
+
+class XmlReader(CuemsXml):
+ 
+
+    def read(self):
+        xml_dict = self.schema_object.to_dict(self.xmlfile, validation='strict',  strip_namespaces=False)
+        # remove namespace info from xml 
+        try:
+            del xml_dict['xmlns:cms']
+            del xml_dict['xmlns:xsi']
+            del xml_dict['xsi:schemaLocation']
+        except KeyError:
+            logger.warning('Error triying to remove namespace info on read')
+
+        return xml_dict
+
+    def read_to_objects(self):
+        xml_dict = self.read()
+        return CuemsParser(xml_dict).parse()

cuemsutils-0.0.1.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.4
+Name: cuemsutils
+Version: 0.0.1
+Summary: Reusable classes and methods for CueMS system
+Project-URL: Documentation, https://github.com/stagesoft/cuemsutils#readme
+Project-URL: Issues, https://github.com/stagesoft/cuemsutils/issues
+Project-URL: Source, https://github.com/stagesoft/cuemsutils
+Author-email: Adrià Masip <adria.back@gmail.com>, Ion Reguera <ion@stagelab.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+# cuems-utils
+Reusable classes and methods for CueMS system
+
+[![PyPI - Version](https://img.shields.io/pypi/v/cuems-utils.svg)](https://pypi.org/project/cuems-utils)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cuems-utils.svg)](https://pypi.org/project/cuems-utils)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install cuems-utils
+```
+
+## License
+
+`cuems-utils` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

cuemsutils-0.0.1.dist-info/RECORD

@@ -0,0 +1,26 @@
+cuemsutils/CTimecode.py,sha256=Ea9eePqljup5AyEgpl4MEcLMJ_54CjJQniW85ulHAQU,5835
+cuemsutils/__init__.py,sha256=ogP__hgeGiNsk04sZO9r2xALhMYJTDMJj9tJmF4UDYs,132
+cuemsutils/log.py,sha256=1iTMEPVg3A11iNSJE-M7aslRhNA2UVRN1nycMsdjo8s,2348
+cuemsutils/cues/ActionCue.py,sha256=MVYsh77_DWRk_9q5B_SUB7HICtNNi1N-JOJQC4KM3UY,3845
+cuemsutils/cues/AudioCue.py,sha256=-9iPjztzEN25ZvDG2FTYCFAOv0vFHdB0mR96a6-UMXo,10279
+cuemsutils/cues/Cue.py,sha256=-9sHQgUz2RGGSmdM-9MkGljrTv0U8vYlhV0uF1_OjKA,6629
+cuemsutils/cues/CueList.py,sha256=PoeLnOqsujMxUmmRmKZtjHkDuxgVXNEH-wLO1pioVhs,4663
+cuemsutils/cues/CueOutput.py,sha256=IrFFsYSolc5UxHDX5TEC8Kqs-e8np77iGRYoNvhb_zI,254
+cuemsutils/cues/CuemsScript.py,sha256=JKq1_wWDaqW277k4TR8F1giwn02OwiK3d6Ytqwe_Y9M,3743
+cuemsutils/cues/DmxCue.py,sha256=SSGrpLV2wVrmtUKeEYvFk5q4_Mse56098B3c3ce_ono,9758
+cuemsutils/cues/VideoCue.py,sha256=H7Qt90qCSsQyxCAYMr8bBJBoNY3loDpmPlT40yvMjgs,11057
+cuemsutils/cues/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cuemsutils/schemas/outputs.xsd,sha256=c1VYTMz3ypxdHDJq0X6SeZ1SBY4NZMC02yK3-sbE_s0,884
+cuemsutils/schemas/project_mappings.xsd,sha256=cPeudrez29lQye-XJ4r3nXSP_Al8RrTy9wjENwEXtO8,3566
+cuemsutils/schemas/project_settings.xsd,sha256=UCao5tY9YaSXfT_KEBY3owsOeAgLWZwywZMuZoqdvq4,915
+cuemsutils/schemas/script.xsd,sha256=0H1TQr_tmPmAsadR00Xq-zczo_U7K4FNoG02Zqw1wL4,15089
+cuemsutils/schemas/settings.xsd,sha256=6B9CZ8wiRbAn5Vuw4OdFTKehxJtNGy0SUJkRmuzM9Ys,4786
+cuemsutils/xml/CMLCuemsConverter.py,sha256=Pr1Zvqd_aAs7MybWNimNyNM_MFVGUJrMncs-N3FBrYM,8525
+cuemsutils/xml/DictParser.py,sha256=uk0mp_pDGy3Ug4Htct0_chMO1wH6zZZ6cQ8efX4H25U,9860
+cuemsutils/xml/XmlBuilder.py,sha256=S_6uJHJm_5lviGkB47sbP9s7ubJL_HEGh5ixX9HAyLc,12495
+cuemsutils/xml/XmlReaderWriter.py,sha256=Z2lhEKik4CpdVnZ0h09-LaiVVLNWCGk0yy7GQ28rb7g,2592
+cuemsutils/xml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cuemsutils-0.0.1.dist-info/METADATA,sha256=QLs2FV2p44xJvzUHw4GIkULoQxxvv_hBHtgkHESAqEA,1632
+cuemsutils-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cuemsutils-0.0.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+cuemsutils-0.0.1.dist-info/RECORD,,

cuemsutils-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any