String representation

[gubaidulinvadim]

Work in progress!
Modified pyaml_repr to print nested string representation. For BPM, this gives better results.

sr = Accelerator.load("tests/config/EBSOrbit.yaml")
bpm_design = sr.design.get_bpm("BPM_C04-04")
print(bpm_design)
    BPM(description=None, lattice_names='BPM_C04-04', name='BPM_C04-04', peer=Simulator(name='design', lattice='/home/gubaidulin/codes/operation/pyAML/pyaml/tests/config/sr/lattices/ebs.mat', mat_key=None, linker=None, description=None))

There are a few issues still that can be resolved in different ways.

• There's no x_pos/y_pos (control system name string) in the string representation. It was present before.
  • We could make x_pos and y_pos 'public' by removing '_'. Then they would appear automatically in the string representation.
  • Another option is to make an 'include' keyword, similar to 'exclude' and explicitly include some attributes.
• I'm worried if nested string representation will not have the same issues as we had before with very long and unreadable string representation. Maybe there should be a length limit?

When solved resolves #345

[JeanLucPons]

Thanks !

Yes for very long representation we used pydantic feature param = Field(..., repr=False).
Now we have an exclude fields that we can use.
Concerning the Element peer, there was a specific case for it, we printed only Simulator('design') using method below:

attached_to(self) -> str:
        """
        Returns a string of which peer the element is attached to.
        """
        return "None" if self._peer is None else f"{self._peer.__class__.__name__}:{self._peer.name()}"

Concerning devices x_pos,..., I think we should remove the _.

[gubaidulinvadim]

@JeanLucPons @GamelinAl including properties like x_pos "publically" would also solve #44 and give control system access easily. For example (preudocode that may contain mistakes,

from tango import DeviceProxy
from pyaml.accelerator import Accelerator

sr = Accelerator.load('sr.pyaml')
tango_device = DeviceProxy(sr.live.get_bpm('BPM').x_pos.rsplit('/', 1))

[gubaidulinvadim]

In case of `public' x_pos, y_pos, tilt_name, x_offset, y_offset we also can remove the get_X_device functions, right?

[JeanLucPons]

I also remarked issue with LinearMagnetModel:

from pyaml.accelerator import Accelerator
sr = Accelerator.load("tests/config/EBSOrbit.yaml")
print(sr.design.magnet.get("QF6B-C04"))

Quadrupole(peer='Simulator:design', name='QF6B-C04', model_name='QF6B-C04', magnet_model=LinearMagnetModel)

I works better with IdentityCFMagnetModel but powerconverters (or physics) are not printed.

from pyaml.accelerator import Accelerator
sr = Accelerator.load("tests/config/EBSOrbit.yaml")
print(sr.design.magnet.get("SJ2E-C04-H"))

HCorrector(peer='Simulator:design', name='SJ2E-C04-H', model_name='SJ2E-C04', magnet_model=IdentityCFMagnetModel(multipoles=['B0', 'A0', 'A1', 'B2'], units=['rad', 'rad', 'm-1', 'm-2']))