Final Review & Cleanup

Author: ax3l

src/pals/kinds/BeamLine.py

@@ -53,40 +53,39 @@ class BeamLine(BaseElement):
                 # Base classes (for testing compatibility)
                 BaseElement,
                 ThickElement,
-                # Original elements
-                Drift,
-                Quadrupole,
+                # User-Facing element kinds
                 "BeamLine",
-                # New schema elements
-                Marker,
-                Sextupole,
-                Octupole,
-                Multipole,
-                RBend,
-                SBend,
-                Solenoid,
-                RFCavity,
-                Patch,
-                FloorShift,
-                Fork,
+                ACKicker,
                 BeamBeam,
                 BeginningEle,
-                Fiducial,
-                NullEle,
-                Kicker,
-                ACKicker,
+                Converter,
                 CrabCavity,
+                Drift,
                 EGun,
                 Feedback,
+                Fiducial,
+                FloorShift,
+                Foil,
+                Fork,
                 Girder,
                 Instrument,
+                Kicker,
+                Marker,
                 Mask,
                 Match,
+                Multipole,
+                NullEle,
+                Octupole,
+                Patch,
+                Quadrupole,
+                RBend,
+                RFCavity,
+                SBend,
+                Sextupole,
+                Solenoid,
                 Taylor,
-                Wiggler,
-                Converter,
-                Foil,
                 UnionEle,
+                Wiggler,
             ],
             Field(discriminator="kind"),
         ]

src/pals/kinds/Converter.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .BaseElement import BaseElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class Converter(BaseElement):
     # Discriminator field
     kind: Literal["Converter"] = "Converter"
 
-    # Converter-specific parameters (in addition to inherited ones)
+    # Converter-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/CrabCavity.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class CrabCavity(ThickElement):
     # Discriminator field
     kind: Literal["CrabCavity"] = "CrabCavity"
 
-    # CrabCavity-specific parameters (in addition to inherited ones)
+    # CrabCavity-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/Drift.py

@@ -1,10 +1,8 @@
 from typing import Literal
 
 from .ThickElement import ThickElement
-from ._warnings import under_construction
 
 
-@under_construction("Drift")
 class Drift(ThickElement):
     """Field free region"""
 

src/pals/kinds/EGun.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class EGun(ThickElement):
     # Discriminator field
     kind: Literal["EGun"] = "EGun"
 
-    # EGun-specific parameters (in addition to inherited ones)
+    # EGun-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/Instrument.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class Instrument(ThickElement):
     # Discriminator field
     kind: Literal["Instrument"] = "Instrument"
 
-    # Instrument-specific parameters (in addition to inherited ones)
+    # Instrument-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/Kicker.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class Kicker(ThickElement):
     # Discriminator field
     kind: Literal["Kicker"] = "Kicker"
 
-    # Kicker-specific parameters (in addition to inherited ones)
+    # Kicker-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/Mask.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class Mask(ThickElement):
     # Discriminator field
     kind: Literal["Mask"] = "Mask"
 
-    # Mask-specific parameters (in addition to inherited ones)
+    # Mask-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/Multipole.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class Multipole(ThickElement):
     # Discriminator field
     kind: Literal["Multipole"] = "Multipole"
 
-    # Multipole-specific parameters (in addition to inherited ones)
+    # Multipole-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None

src/pals/kinds/Octupole.py

@@ -1,8 +1,7 @@
 from typing import Literal, Optional
 
 from .ThickElement import ThickElement
-from ..parameters import ElectricMultipoleParameters
-from ..parameters import MagneticMultipoleParameters
+from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
 from ._warnings import under_construction
 
 
@@ -13,6 +12,6 @@ class Octupole(ThickElement):
     # Discriminator field
     kind: Literal["Octupole"] = "Octupole"
 
-    # Octupole-specific parameters (in addition to inherited ones)
+    # Octupole-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None