Final Review & Cleanup

ax3l · ax3l · commit 14d22bea7ebb · 2025-10-23T12:46:00.000-07:00
diff --git a/src/pals/kinds/BeamLine.py b/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"),
         ]
diff --git a/src/pals/kinds/Converter.py b/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
diff --git a/src/pals/kinds/CrabCavity.py b/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
diff --git a/src/pals/kinds/Drift.py b/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"""
 
diff --git a/src/pals/kinds/EGun.py b/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
diff --git a/src/pals/kinds/Instrument.py b/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
diff --git a/src/pals/kinds/Kicker.py b/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
diff --git a/src/pals/kinds/Mask.py b/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
diff --git a/src/pals/kinds/Multipole.py b/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
diff --git a/src/pals/kinds/Octupole.py b/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
diff --git a/src/pals/kinds/Quadrupole.py b/src/pals/kinds/Quadrupole.py
@@ -2,15 +2,14 @@
 
 from .ThickElement import ThickElement
 from ..parameters import MagneticMultipoleParameters, ElectricMultipoleParameters
-from ._warnings import under_construction
 
 
-@under_construction("Quadrupole")
 class Quadrupole(ThickElement):
     """Quadrupole element"""
 
     # Discriminator field
     kind: Literal["Quadrupole"] = "Quadrupole"
 
+    # Octupole-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: MagneticMultipoleParameters
diff --git a/src/pals/kinds/Sextupole.py b/src/pals/kinds/Sextupole.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 Sextupole(ThickElement):
     # Discriminator field
     kind: Literal["Sextupole"] = "Sextupole"
 
-    # Sextupole-specific parameters (in addition to inherited ones)
+    # Sextupole-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None
diff --git a/src/pals/kinds/UnionEle.py b/src/pals/kinds/UnionEle.py
@@ -10,4 +10,5 @@ class UnionEle(BaseElement):
     kind: Literal["UnionEle"] = "UnionEle"
 
     # Elements in the union
+    #   Note: https://github.com/campa-consortium/pals/issues/89
     elements: List[BaseElement] = []
diff --git a/src/pals/kinds/Wiggler.py b/src/pals/kinds/Wiggler.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 Wiggler(ThickElement):
     # Discriminator field
     kind: Literal["Wiggler"] = "Wiggler"
 
-    # Wiggler-specific parameters (in addition to inherited ones)
+    # Wiggler-specific parameters
     ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
     MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None
diff --git a/src/pals/parameters/ApertureParameters.py b/src/pals/parameters/ApertureParameters.py
@@ -1,13 +1,10 @@
 from typing import List
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class ApertureParameters(BaseModel):
     """Aperture parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     x_limits: List[float] = [float("nan"), float("nan")]
     y_limits: List[float] = [float("nan"), float("nan")]
     shape: str = "RECTANGULAR"
diff --git a/src/pals/parameters/BeamBeamParameters.py b/src/pals/parameters/BeamBeamParameters.py
@@ -1,10 +1,7 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class BeamBeamParameters(BaseModel):
     """Beam-beam parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     # Parameters will be added when construction is complete
diff --git a/src/pals/parameters/BendParameters.py b/src/pals/parameters/BendParameters.py
@@ -1,12 +1,9 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class BendParameters(BaseModel):
     """Bend parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     rho_ref: float = 0.0  # [radian] Reference bend angle
     bend_field_ref: float = 0.0  # [T] Reference bend field
     e1: float = 0.0  # [radian] Entrance end pole face rotation with respect to a sector geometry
diff --git a/src/pals/parameters/BodyShiftParameters.py b/src/pals/parameters/BodyShiftParameters.py
@@ -1,12 +1,9 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class BodyShiftParameters(BaseModel):
     """Body shift parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     x_offset: float = 0.0
     y_offset: float = 0.0
     z_offset: float = 0.0
diff --git a/src/pals/parameters/ElectricMultipoleParameters.py b/src/pals/parameters/ElectricMultipoleParameters.py
@@ -7,4 +7,5 @@ class ElectricMultipoleParameters(BaseModel):
     # Allow arbitrary fields
     model_config = ConfigDict(extra="allow")
 
-    # Parameters will be added when construction is complete
+    # TODO: add ElectricMultipoleParameters in a follow-up RP
+    # https://pals-project.readthedocs.io/en/latest/element-parameters.html#electricmultipolep-electric-multipole-parameters
diff --git a/src/pals/parameters/FloorParameters.py b/src/pals/parameters/FloorParameters.py
@@ -1,15 +1,7 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class FloorParameters(BaseModel):
     """Floor position and orientation parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
-    x_position: float = 0.0  # [m] Floor position in x
-    y_position: float = 0.0  # [m] Floor position in y
-    z_position: float = 0.0  # [m] Floor position in z
-    x_rotation: float = 0.0  # [radian] Floor rotation around x
-    y_rotation: float = 0.0  # [radian] Floor rotation around y
-    z_rotation: float = 0.0  # [radian] Floor rotation around z
+    # Under construction
diff --git a/src/pals/parameters/FloorShiftParameters.py b/src/pals/parameters/FloorShiftParameters.py
@@ -1,12 +1,9 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class FloorShiftParameters(BaseModel):
     """Floor shift parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     x_offset: float = 0.0
     y_offset: float = 0.0
     z_offset: float = 0.0
diff --git a/src/pals/parameters/ForkParameters.py b/src/pals/parameters/ForkParameters.py
@@ -1,12 +1,9 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class ForkParameters(BaseModel):
     """Fork parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     to_line: str = ""
     to_ele: str = ""
     direction: str = "FORWARDS"  # "FORWARDS" or "BACKWARDS"
diff --git a/src/pals/parameters/MetaParameters.py b/src/pals/parameters/MetaParameters.py
@@ -1,12 +1,9 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 
 
 class MetaParameters(BaseModel):
     """Meta parameters"""
 
-    # Allow arbitrary fields
-    model_config = ConfigDict(extra="allow")
-
     alias: str = ""
     ID: str = ""
     label: str = ""
diff --git a/src/pals/parameters/PatchParameters.py b/src/pals/parameters/PatchParameters.py
diff --git a/src/pals/parameters/RFParameters.py b/src/pals/parameters/RFParameters.py
diff --git a/src/pals/parameters/ReferenceChangeParameters.py b/src/pals/parameters/ReferenceChangeParameters.py
diff --git a/src/pals/parameters/ReferenceParameters.py b/src/pals/parameters/ReferenceParameters.py
diff --git a/src/pals/parameters/SolenoidParameters.py b/src/pals/parameters/SolenoidParameters.py
diff --git a/src/pals/parameters/TrackingParameters.py b/src/pals/parameters/TrackingParameters.py
diff --git a/tests/test_elements.py b/tests/test_elements.py
diff --git a/tests/test_parameters.py b/tests/test_parameters.py
diff --git a/tests/test_serialization.py b/tests/test_serialization.py
