Factorized __repr__

Author: JeanLucPons

pyaml/bpm/bpm.py

@@ -74,6 +74,4 @@ def attach(self, peer, positions: RBpmArray , offset: RWBpmOffsetArray,
         obj.__tilt = tilt
         obj._peer = peer
         return obj
-        
-    def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel(",self.__class__.__name__ + "(peer='" + self.get_peer() + "', ")
+        

pyaml/bpm/bpm_simple_model.py

@@ -2,6 +2,8 @@
 from pydantic import BaseModel,ConfigDict
 import numpy as np
 from ..control.deviceaccess import DeviceAccess
+from ..common.element import __pyaml_repr__
+
 from numpy.typing import NDArray
 # Define the main class name for this module
 PYAMLCLASS = "BPMSimpleModel"
@@ -115,4 +117,5 @@ def get_offset_devices(self) -> list[DeviceAccess]:
         return []
 
     def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel",self.__class__.__name__)
+        return __pyaml_repr__(self)
+

pyaml/bpm/bpm_tiltoffset_model.py

@@ -3,6 +3,8 @@
 from pydantic import BaseModel,ConfigDict
 import numpy as np
 from ..control.deviceaccess import DeviceAccess
+from ..common.element import __pyaml_repr__
+
 from numpy.typing import NDArray
 # Define the main class name for this module
 PYAMLCLASS = "BPMTiltOffsetModel"
@@ -113,3 +115,6 @@ def get_offset_devices(self) -> list[DeviceAccess]:
             Array of DeviceAcess
         """
         return [self.__x_offset,self.__y_offset]
+
+    def __repr__(self):
+        return __pyaml_repr__(self)

pyaml/common/element.py

@@ -2,6 +2,21 @@
 
 from pydantic import BaseModel,ConfigDict
 
+
+def __pyaml_repr__(obj):
+    """
+    Returns a string representation of a pyaml object
+    """
+    if hasattr(obj,"_cfg"):
+        if isinstance(obj,Element):
+            return repr(obj._cfg).replace("ConfigModel(",obj.__class__.__name__ + "(peer='" + obj.get_peer() + "', ")
+        else:
+            # no peer
+            return repr(obj._cfg).replace("ConfigModel",obj.__class__.__name__ )
+    else:
+        # Default to repr
+        return repr(obj)
+
 class ElementConfigModel(BaseModel):
 
     model_config = ConfigDict(arbitrary_types_allowed=True,extra="forbid")
@@ -47,8 +62,8 @@ def get_peer(self) -> str:
         return "None" if self._peer is None else f"{self._peer.__class__.__name__}:{self._peer.name()}"
 
     def __repr__(self):
-        return "%s(name='%s', peer='%s')" % (
-            self.__class__.__name__,
-            self.__name,
-            self.get_peer()
-        )
+        return __pyaml_repr__(self)
+
+
+
+    

pyaml/diagnostics/tune_monitor.py

@@ -47,6 +47,3 @@ def attach(self, peer, betatron_tune: ReadFloatArray) -> Self:
         obj._peer = peer
         return obj
 
-    def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel(",self.__class__.__name__ + "(peer='" + self.get_peer() + "', ")
-

pyaml/magnet/cfm_magnet.py

@@ -1,6 +1,6 @@
 
 from .model import MagnetModel
-from ..common.element import Element,ElementConfigModel
+from ..common.element import Element,ElementConfigModel,__pyaml_repr__
 from ..common import abstract
 from ..common.abstract import RWMapper
 from ..common.exception import PyAMLException
@@ -87,4 +87,5 @@ def set_energy(self,E:float):
             self.model.set_magnet_rigidity(E/speed_of_light)
 
     def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel",self.__class__.__name__)
+        return __pyaml_repr__(self)
+

pyaml/magnet/identity_cfm_model.py

@@ -4,6 +4,7 @@
 from .model import MagnetModel
 from .. import PyAMLException
 from ..control.deviceaccess import DeviceAccess
+from ..common.element import __pyaml_repr__
 
 # Define the main class name for this module
 PYAMLCLASS = "IdentityCFMagnetModel"
@@ -88,4 +89,4 @@ def has_hardware(self) -> bool:
         return self._cfg.powerconverters is not None
 
     def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel",self.__class__.__name__)
+        return __pyaml_repr__(self)

pyaml/magnet/identity_model.py

@@ -1,6 +1,7 @@
 from .model import MagnetModel
 from .. import PyAMLException
 from ..control.deviceaccess import DeviceAccess
+from ..common.element import __pyaml_repr__
 
 import numpy as np
 from pydantic import BaseModel,ConfigDict
@@ -70,4 +71,4 @@ def has_hardware(self) -> bool:
         return self._cfg.powerconverter is not None
 
     def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel",self.__class__.__name__)
+       return __pyaml_repr__(self)

pyaml/magnet/linear_cfm_model.py

@@ -3,6 +3,7 @@
 from ..control.deviceaccess import DeviceAccess
 from .model import MagnetModel
 from ..common.exception import PyAMLException
+from ..common.element import __pyaml_repr__
 
 from pydantic import BaseModel,ConfigDict
 import numpy as np
@@ -164,4 +165,5 @@ def has_hardware(self) -> bool:
         return (self.__nbPS == self.__nbFunction) and np.allclose(self.__matrix, np.eye(self.__nbFunction))
 
     def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel",self.__class__.__name__)
+        return __pyaml_repr__(self)
+

pyaml/magnet/linear_model.py

@@ -1,6 +1,7 @@
 from .model import MagnetModel
 from ..configuration.curve import Curve
 from ..control.deviceaccess import DeviceAccess
+from ..common.element import __pyaml_repr__
 
 import numpy as np
 from pydantic import BaseModel,ConfigDict
@@ -76,5 +77,6 @@ def set_magnet_rigidity(self, brho: np.double):
         self.__brho = brho
 
     def __repr__(self):
-       return repr(self._cfg).replace("ConfigModel",self.__class__.__name__)
+        return __pyaml_repr__(self)
+