- allow for change of output encoding with default utf-8

- avoid code duplicates by moving print and write functions to main helpers module
- remove dedicated helpers modules for xodr and xosc
- adapt imports to main helper module

scenariogeneration/helpers.py

@@ -7,8 +7,6 @@
 import os
 
 from .scenario_generator import ScenarioGenerator
-from .xodr import OpenDrive
-from .xosc import Scenario
 
 
 def esmini(generator,esminipath='esmini',
@@ -159,22 +157,75 @@ def esmini(generator,esminipath='esmini',
     if run_with_replayer:
         os.system(replay_executable + ' --file ' + record +' --res_path ' + os.path.join(resource_path,os.pardir) +  ' --window '+ window_size)
 
-
-
-def prettyprint(element):
+def prettify(element, encoding='utf-8'):
     """ prints the element to the commandline
 
         Parameters
         ----------
             element (Element, or any generation class of scenariogeneration): element to print
+            
+            encoding (str): specifies the output encoding
+                Default: 'utf-8'
 
     """
     if not isinstance(element,ET.Element):
         element = element.get_element()
-    rough = ET.tostring(element, 'utf-8')
+    rough = ET.tostring(element, 'utf-8').replace(b'\n', b'').replace(b'\t', b'').replace(b'    ', b'')
     reparsed = mini.parseString(rough)
-    print(reparsed.toprettyxml(indent="    "))
+    return reparsed.toprettyxml(indent="    ", encoding=encoding)
 
+def prettyprint(element, encoding='utf-8'):
+    """ returns the element prettyfied for writing to file or printing to the commandline
 
+        Parameters
+        ----------
+            element (Element, or any generation class of scenariogeneration): element to print
+            
+            encoding (str): specify the output encoding
+                Default: 'utf-8'
 
+    """
+    print (prettify(element, encoding=encoding))
+
+
+def printToFile(element, filename, prettyprint=True, encoding='utf-8'):
+    """ prints the element to a xml file
+
+        Parameters
+        ----------
+            element (Element): element to print
 
+            filename (str): file to save to
+
+            prettyprint (bool): pretty or "ugly" print
+
+            encoding (str): specify the output encoding
+                Default: 'utf-8'
+    """
+    if prettyprint:    
+        try:
+            with open(filename,'wb') as file_handle:
+                file_handle.write(prettify(element, encoding=encoding))
+        except LookupError:
+            print ("%s is not a valid encoding option." % encoding)
+
+    else:
+        tree = ET.ElementTree(element)
+        try:
+            tree.write(filename, encoding=encoding)
+        except LookupError:
+            print ("%s is not a valid encoding option." % encoding)
+
+def enum2str(enum):
+    """ helper to create strings from enums that should contain space but have to have _
+
+        Parameters
+        ----------
+            enum (Enum): a enum of pyodrx
+
+        Returns
+        -------
+            enumstr (str): the enum as a string replacing _ with ' '
+
+    """
+    return enum.name.replace('_',' ')

scenariogeneration/xodr/__init__.py

@@ -1,9 +1,8 @@
 # __init__.py
-""" the xosc module contains the classes used to generate OpenDRIVE (xml) files. 
+""" the xodr module contains the classes used to generate OpenDRIVE (xml) files. 
 
 """
 from .geometry import *
-from .helpers import *
 from .opendrive import *
 from .lane import *
 from .enumerations import *

scenariogeneration/xodr/lane.py

@@ -3,7 +3,7 @@
 """
 
 import xml.etree.ElementTree as ET
-from .helpers import enum2str
+from ..helpers import enum2str
 from .enumerations import LaneType, LaneChange, RoadMarkWeight, RoadMarkColor, RoadMarkType, MarkRule 
 from .links import _Links,_Link
 

scenariogeneration/xodr/links.py

@@ -2,7 +2,7 @@
 
 """
 import xml.etree.ElementTree as ET
-from .helpers import enum2str
+from ..helpers import enum2str
 from .enumerations import ElementType, JunctionGroupType
 
 from .exceptions import NotSameAmountOfLanesError

scenariogeneration/xodr/opendrive.py

@@ -3,7 +3,7 @@
 """
 import xml.etree.ElementTree as ET
 
-from .helpers import printToFile,enum2str
+from ..helpers import printToFile,enum2str
 from .links import _Link, _Links, create_lane_links
 from .enumerations import ElementType, ContactPoint, RoadSide, TrafficRule
 from .exceptions import UndefinedRoadNetwork, RoadsAndLanesNotAdjusted
@@ -763,8 +763,8 @@ def get_element(self):
         return element
 
 
-    def write_xml(self,filename=None,prettyprint = True):
-        """ writeXml writes the open scenario xml file
+    def write_xml(self, filename = None, prettyprint = True, encoding = 'utf-8'):
+        """ write_xml writes the OpenDRIVE xml file
 
         Parameters
         ----------
@@ -773,11 +773,14 @@ def write_xml(self,filename=None,prettyprint = True):
 
             prettyprint (bool): pretty print or ugly print?
                 Default: True
+                
+            encoding (str): specifies the output encoding
+                Default: 'utf-8'
 
         """
         if filename == None:
             filename = self.name + '.xodr'
-        printToFile(self.get_element(),filename,prettyprint)
+        printToFile(self.get_element(),filename,prettyprint,encoding)
 
 class _Type():
     """ class to generate the type element of a road, (not the Enumeration it self).

scenariogeneration/xodr/signals_objects.py

@@ -2,7 +2,7 @@
 
 """
 import xml.etree.ElementTree as ET
-from .helpers import enum2str
+from ..helpers import enum2str
 from .enumerations import ObjectType, Orientation, Dynamic 
 
 class _SignalObjectBase():

scenariogeneration/xosc/__init__.py

@@ -4,7 +4,6 @@
 """
 from .utils import *
 from .actions import *
-from .helpers import *
 from .position import *
 from .triggers import *
 from .scenario import *

scenariogeneration/xosc/parameters.py

@@ -4,9 +4,9 @@
 import xml.etree.ElementTree as ET
 
 from .enumerations import VersionBase, XMLNS, XSI
-from .utils import _StochasticDistributionType,  FileHeader, VersionBase, printToFile, ParameterAssignment, Rule
+from .utils import _StochasticDistributionType,  FileHeader, VersionBase, ParameterAssignment, Rule
 from .exceptions import NotEnoughInputArguments, OpenSCENARIOVersionError
-
+from ..helpers import printToFile
 
 class _HistogramBin():
     """ the _HistogramBin is used by Histogram to define the bins

scenariogeneration/xosc/scenario.py

@@ -8,7 +8,7 @@
 import xml.dom.minidom as mini
 
 
-from .helpers import printToFile
+from ..helpers import printToFile
 from .utils import FileHeader, ParameterDeclarations, Catalog, TrafficSignalController
 from .enumerations import VersionBase, XMLNS, XSI
 from .entities import Entities
@@ -108,15 +108,18 @@ def get_element(self):
 
         return element
 
-    def write_xml(self,filename,prettyprint = True):
-        """ writeXml writes the open scenario xml file
+    def write_xml(self, filename, prettyprint = True, encoding = 'utf-8'):
+        """ write_xml writes the OpenSCENARIO xml file
 
         Parameters
         ----------
             filename (str): path and filename of the wanted xml file
 
             prettyprint (bool): pretty print or ugly print?
                 Default: True
+                
+            encoding (str): specifies the output encoding
+                Default: 'utf-8'
 
         """
         printToFile(self.get_element(),filename,prettyprint)

scenariogeneration/xosc/utils.py

@@ -8,7 +8,7 @@
 from numpy.lib.arraysetops import isin
 from .exceptions import OpenSCENARIOVersionError
 import xml.etree.ElementTree as ET
-from .helpers import printToFile
+from ..helpers import printToFile
 
 from .enumerations import ParameterType, Rule, ReferenceContext, DynamicsShapes, DynamicsDimension, RouteStrategy,XSI,XMLNS, VehicleCategory,PrecipitationType,CloudState, VersionBase, SpeedTargetValueType
 import datetime as dt