Rename to NamePlaceholder

Author: ax3l

src/pals/kinds/ElementReference.py src/pals/kinds/PlaceholderName.pysrc/pals/kinds/ElementReference.py renamed to src/pals/kinds/PlaceholderName.py

@@ -6,7 +6,7 @@
 from .mixin import BaseElement
 
 
-class ElementReference(BaseModel):
+class PlaceholderName(BaseModel):
     """A pydantic model that represents a reference to a named element.
 
     This class behaves like a string (via __str__ and __eq__) but stores
@@ -19,7 +19,7 @@ class ElementReference(BaseModel):
         element: A reference to the resolved element object (None until resolved)
 
     Example:
-        >>> ref = ElementReference(name="drift1")
+        >>> ref = PlaceholderName(name="drift1")
         >>> ref.name
         'drift1'
         >>> str(ref)
@@ -65,7 +65,7 @@ def __eq__(self, other: object) -> bool:
         """Enable string comparison."""
         if isinstance(other, str):
             return self.name == other
-        if isinstance(other, ElementReference):
+        if isinstance(other, PlaceholderName):
             return self.name == other.name and self.element is other.element
         return False
 

src/pals/kinds/__init__.py

@@ -11,7 +11,6 @@
 from .CrabCavity import CrabCavity  # noqa: F401
 from .Drift import Drift  # noqa: F401
 from .EGun import EGun  # noqa: F401
-from .ElementReference import ElementReference  # noqa: F401
 from .Feedback import Feedback  # noqa: F401
 from .Fiducial import Fiducial  # noqa: F401
 from .FloorShift import FloorShift  # noqa: F401
@@ -27,6 +26,7 @@
 from .NullEle import NullEle  # noqa: F401
 from .Octupole import Octupole  # noqa: F401
 from .Patch import Patch  # noqa: F401
+from .PlaceholderName import PlaceholderName  # noqa: F401
 from .Quadrupole import Quadrupole  # noqa: F401
 from .RBend import RBend  # noqa: F401
 from .RFCavity import RFCavity  # noqa: F401

src/pals/kinds/all_elements.py

@@ -14,7 +14,7 @@
 from .CrabCavity import CrabCavity
 from .Drift import Drift
 from .EGun import EGun
-from .ElementReference import ElementReference
+from .PlaceholderName import PlaceholderName
 from .Feedback import Feedback
 from .Fiducial import Fiducial
 from .FloorShift import FloorShift
@@ -90,6 +90,6 @@ def get_all_elements_as_annotation(extra_types: tuple = None):
     Pydantic will still properly validate the union by trying each type in order in
     our unpack_element_list_structure method.
     """
-    types = get_all_element_types(extra_types) + (ElementReference,)
+    types = get_all_element_types(extra_types) + (PlaceholderName,)
     # We can't use discriminator with ElementReference in the union since it has no 'kind' field
     return Union[types]

src/pals/kinds/mixin/all_element_mixin.py

@@ -5,7 +5,7 @@
 """
 
 from . import BaseElement
-from ..ElementReference import ElementReference
+from ..PlaceholderName import PlaceholderName
 
 
 def unpack_element_list_structure(
@@ -46,10 +46,10 @@ def unpack_element_list_structure(
         # An element can be a string that refers to another element
         if isinstance(item, str):
             # Wrap the string in an ElementReference object
-            new_list.append(ElementReference(item))
+            new_list.append(PlaceholderName(item))
             continue
         # An element can be an ElementReference instance directly
-        elif isinstance(item, ElementReference):
+        elif isinstance(item, PlaceholderName):
             # Keep the ElementReference as-is
             new_list.append(item)
             continue

tests/test_elements.py

@@ -562,14 +562,14 @@ def test_BeamLine_with_string_references():
     assert len(beamline.line) == 3
 
     # First element should be an ElementReference that behaves like the string "drift1"
-    assert isinstance(beamline.line[0], pals.ElementReference)
+    assert isinstance(beamline.line[0], pals.PlaceholderName)
     assert beamline.line[0] == "drift1"
     assert beamline.line[0].name == "drift1"
     assert beamline.line[0].element is None  # Not yet resolved
     assert not beamline.line[0].is_resolved()
 
     # Second element should be an ElementReference that behaves like the string "quad1"
-    assert isinstance(beamline.line[1], pals.ElementReference)
+    assert isinstance(beamline.line[1], pals.PlaceholderName)
     assert beamline.line[1] == "quad1"
     assert beamline.line[1].name == "quad1"
     assert beamline.line[1].element is None  # Not yet resolved
@@ -591,14 +591,14 @@ def test_BeamLine_with_string_references():
 def test_ElementReference_direct():
     """Test ElementReference creation and behavior directly"""
     # Test creation with positional argument
-    ref1 = pals.ElementReference("test_element")
+    ref1 = pals.PlaceholderName("test_element")
     assert ref1.name == "test_element"
     assert str(ref1) == "test_element"
     assert ref1 == "test_element"
     assert not ref1.is_resolved()
 
     # Test creation with keyword argument
-    ref2 = pals.ElementReference(name="another_element")
+    ref2 = pals.PlaceholderName(name="another_element")
     assert ref2.name == "another_element"
     assert str(ref2) == "another_element"
     assert ref2 == "another_element"