Merge remote-tracking branch 'origin/main' into 2-handle-serialized-magnets

Author: gupichon-soleil

examples/ESRF_tune_example/esrf_tune_example.py

@@ -1,6 +1,4 @@
-from pyaml.pyaml import pyaml,PyAML
-from pyaml.instrument import Instrument
-from pyaml.configuration.factory import Factory
+from pyaml.accelerator import Accelerator
 import numpy as np
 import os
 
@@ -14,8 +12,7 @@
 # Normalize the path (resolves '..')
 absolute_path = os.path.abspath(relative_path)
 
-ml:PyAML = pyaml(absolute_path)
-sr:Instrument = ml.get('sr')
+sr:Accelerator = Accelerator.load(absolute_path)
 sr.design.get_lattice().disable_6d()
 
 quadForTuneDesign = sr.design.get_magnets("QForTune")
@@ -52,6 +49,3 @@
     strs = quadForTuneLive.strengths.get()
     strs += np.matmul(correctionmat,[0.1,0.05]) # Ask for correction [dqx,dqy]
     quadForTuneLive.strengths.set(strs)
-
-
-Factory.clear()

pyaml/instrument.py pyaml/accelerator.pypyaml/instrument.py renamed to pyaml/accelerator.py

@@ -7,9 +7,10 @@
 from .lattice.simulator import Simulator
 from .arrays.array import ArrayConfig
 from pydantic import BaseModel,ConfigDict
+from .configuration import load_accelerator
 
 # Define the main class name for this module
-PYAMLCLASS = "Instrument"
+PYAMLCLASS = "Accelerator"
 
 class ConfigModel(BaseModel):
 
@@ -31,7 +32,7 @@ class ConfigModel(BaseModel):
     """Element list"""
 
 
-class Instrument(object):    
+class Accelerator(object):
     """PyAML top level class"""
 
     def __init__(self, cfg: ConfigModel):
@@ -85,3 +86,18 @@ def live(self) -> ControlSystem:
     @property
     def design(self) -> Simulator:
         return self.__design
+
+    @staticmethod
+    def load(filename:str, use_fast_loader:bool = False) -> "Accelerator":
+        """
+        Load an accelerator from a config file.
+
+        Parameters
+        ----------
+        filename : str
+            Configuration file name, yaml or json.
+        use_fast_loader : bool
+            Use fast yaml loader. When specified, no line number are reported in case of error, 
+            only the element name that triggered the error will be reported in the exception)
+        """
+        return load_accelerator(filename,use_fast_loader)

pyaml/configuration/__init__.py

@@ -2,24 +2,5 @@
 PyAML configuration module
 """
 
-from pathlib import Path
-from typing import Union
-
-ROOT = {"path": Path.cwd().resolve()}
-
-
-def set_root_folder(path: Union[str, Path]):
-    """
-    Set the root path for configuration files.
-    """
-    ROOT["path"] = Path(path)
-
-
-def get_root_folder() -> Path:
-    """
-    Get the root path for configuration files.
-    """
-    return ROOT["path"]
-
-from .fileloader import load
+from .fileloader import load_accelerator, set_root_folder, get_root_folder
 from .factory import Factory

pyaml/configuration/factory.py

@@ -53,7 +53,7 @@ def handle_validation_error(self, e, type_str:str, location_str:str, field_locat
                 else:
                     field = err['loc'][0]
                     message = f"'{field}': {msg}"
-                if field in field_locations:
+                if field_locations and field in field_locations:
                     file, line, col = field_locations[field]
                     loc = f"{file} at line {line}, colum {col}"
                     message += f" {loc}"

pyaml/configuration/fileloader.py

@@ -1,22 +1,45 @@
 # PyAML config file loader
 import logging
 import json
-from typing import Union
+from typing import Union, TYPE_CHECKING
 from pathlib import Path
 import io
+import os
 
 import yaml
 from yaml.loader import SafeLoader
+from yaml import CLoader
 from yaml.constructor import ConstructorError
 import collections.abc
 
-from . import get_root_folder
 from .. import PyAMLException
+from pyaml.configuration.factory import Factory
+
+if TYPE_CHECKING:
+    from pyaml.accelerator import Accelerator
+
 
 logger = logging.getLogger(__name__)
 
 accepted_suffixes = [".yaml", ".yml", ".json"]
 
+
+ROOT = {"path": Path.cwd().resolve()}
+
+
+def set_root_folder(path: Union[str, Path]):
+    """
+    Set the root path for configuration files.
+    """
+    ROOT["path"] = Path(path)
+
+
+def get_root_folder() -> Path:
+    """
+    Get the root path for configuration files.
+    """
+    return ROOT["path"]
+
 class PyAMLConfigCyclingException(PyAMLException):
 
     def __init__(self, error_filename:str, path_stack:list[Path]):
@@ -25,12 +48,26 @@ def __init__(self, error_filename:str, path_stack:list[Path]):
         super().__init__(f"Circular file inclusion of {error_filename}. File list before reaching it: {parent_file_stack}")
     pass
 
-def load(filename:str, paths_stack:list=None) -> Union[dict,list]:
+def load_accelerator(filename:str, use_fast_loader:bool = False) -> "Accelerator":
+    """ Load an accelerator from file."""
+
+    # Asume that all files are referenced from folder where main AML file is stored
+    if not os.path.exists(filename):
+       raise PyAMLException(f"{filename} file not found")
+    rootfolder = os.path.abspath(os.path.dirname(filename))
+    set_root_folder(rootfolder)
+    config_dict = load(os.path.basename(filename),None,use_fast_loader)
+    aml = Factory.depth_first_build(config_dict)
+
+    Factory.clear()
+    return aml
+
+def load(filename:str, paths_stack:list=None, use_fast_loader:bool = False) -> Union[dict,list]:
     """Load recursively a configuration setup"""
     if filename.endswith(".yaml") or filename.endswith(".yml"):
-        l = YAMLLoader(filename, paths_stack)
+        l = YAMLLoader(filename, paths_stack, use_fast_loader)
     elif filename.endswith(".json"):
-        l = JSONLoader(filename, paths_stack)
+        l = JSONLoader(filename, paths_stack, use_fast_loader)
     else:
         raise PyAMLException(f"{filename} File format not supported (only .yaml .yml or .json)")
     return l.load()
@@ -58,7 +95,7 @@ def expand_dict(self,d:dict):
         for key, value in d.items():
             try:
                 if hasToExpand(value):
-                    d[key] = load(value, self.files_stack)
+                    d[key] = load(value, self.files_stack, self.use_fast_loader)
                 else:
                     self.expand(value)
             except PyAMLConfigCyclingException as pyaml_ex:
@@ -119,21 +156,24 @@ def construct_mapping(self, node, deep=False):
 
 # YAML loader
 class YAMLLoader(Loader):
-    def __init__(self, filename: str, parent_paths_stack:list):
+    def __init__(self, filename: str, parent_paths_stack:list,use_fast_loader:bool):
         super().__init__(filename, parent_paths_stack)
+        self._loader = SafeLineLoader if not use_fast_loader else CLoader
+        self.use_fast_loader = use_fast_loader
 
     def load(self) -> Union[dict,list]:
         logger.log(logging.DEBUG, f"Loading YAML file '{self.path}'")
         with open(self.path) as file:
             try:
-                return self.expand(yaml.load(file,Loader=SafeLineLoader))
+                return self.expand(yaml.load(file,Loader=self._loader))
             except yaml.YAMLError as e:
                 raise PyAMLException(str(self.path) + ": " + str(e)) from e
 
 # JSON loader
 class JSONLoader(Loader):
-    def __init__(self, filename: str, parent_paths_stack:list):
+    def __init__(self, filename: str, parent_paths_stack:list,use_fast_loader:bool):
         super().__init__(filename, parent_paths_stack)
+        self.use_fast_loader = False
 
     def  load(self) -> Union[dict,list]:
         logger.log(logging.DEBUG, f"Loading JSON file '{self.path}'")