utils/misc: Move load_struct_from_yaml() from WA to devlib

This is copied from ``workload-automation``/wa/utils/misc.py. [1]
removes the implementation from WA.

Replace ``yaml.load()`` with ``yaml.safe_load()``.
And fix pylint issues.

[1] TODO: paste WA PR link here.

Signed-off-by: Metin Kaya <metin.kaya@arm.com>

Author: metin-arm

devlib/utils/misc.py

@@ -37,6 +37,7 @@
 import types
 import warnings
 import wrapt
+import yaml
 
 
 try:
@@ -590,6 +591,30 @@ def __str__(self):
         return message.format(self.filepath, self.lineno, self.message)
 
 
+def load_struct_from_yaml(filepath):
+    '''
+    Parses a config structure from a YAML file.
+    The structure should be composed of basic Python types.
+
+    Args:
+        filepath (str): Input file which contains YAML data.
+
+    Raises:
+        LoadSyntaxError: if there is a syntax error in YAML data.
+
+    Returns:
+        dict: which contains parsed YAML data.
+    '''
+
+    try:
+        with open(filepath, 'r', encoding='utf-8') as file_handler:
+            return yaml.safe_load(file_handler)
+    except yaml.YAMLError as ex:
+        message = ex.message if hasattr(ex, 'message') else ''
+        lineno = ex.problem_mark.line if hasattr(ex, 'problem_mark') else None
+        raise LoadSyntaxError(message, filepath=filepath, lineno=lineno) from ex
+
+
 RAND_MOD_NAME_LEN = 30
 BAD_CHARS = string.punctuation + string.whitespace
 TRANS_TABLE = str.maketrans(BAD_CHARS, '_' * len(BAD_CHARS))

setup.py

@@ -105,6 +105,7 @@ def _load_path(filepath):
         'lxml', # More robust xml parsing
         'nest_asyncio', # Allows running nested asyncio loops
         'future', # for the "past" Python package
+        'pyYAML>=5.1b3', # YAML formatted config parsing
     ],
     extras_require={
         'daq': ['daqpower>=2'],