Move Mixins & Utils

ax3l · ax3l · commit 3e76c0ae2c59 · 2025-10-28T13:53:20.000-07:00
diff --git a/src/pals/kinds/ACKicker.py b/src/pals/kinds/ACKicker.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .ThickElement import ThickElement
-from ._warnings import under_construction
+from .mixin import ThickElement
+from .utils import under_construction
 
 
 @under_construction("ACKicker")
diff --git a/src/pals/kinds/BeamBeam.py b/src/pals/kinds/BeamBeam.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .BaseElement import BaseElement
+from .mixin import BaseElement
 from ..parameters import BeamBeamParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("BeamBeam")
diff --git a/src/pals/kinds/BeginningEle.py b/src/pals/kinds/BeginningEle.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("BeginningEle")
diff --git a/src/pals/kinds/Converter.py b/src/pals/kinds/Converter.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .BaseElement import BaseElement
+from .mixin import BaseElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Converter")
diff --git a/src/pals/kinds/CrabCavity.py b/src/pals/kinds/CrabCavity.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("CrabCavity")
diff --git a/src/pals/kinds/Drift.py b/src/pals/kinds/Drift.py
@@ -1,6 +1,6 @@
 from typing import Literal
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 
 
 class Drift(ThickElement):
diff --git a/src/pals/kinds/EGun.py b/src/pals/kinds/EGun.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("EGun")
diff --git a/src/pals/kinds/Feedback.py b/src/pals/kinds/Feedback.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Feedback")
diff --git a/src/pals/kinds/Fiducial.py b/src/pals/kinds/Fiducial.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Fiducial")
diff --git a/src/pals/kinds/FloorShift.py b/src/pals/kinds/FloorShift.py
@@ -1,6 +1,6 @@
 from typing import Literal, Optional
 
-from .BaseElement import BaseElement
+from .mixin import BaseElement
 from ..parameters import FloorShiftParameters
 
 
diff --git a/src/pals/kinds/Foil.py b/src/pals/kinds/Foil.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Foil")
diff --git a/src/pals/kinds/Fork.py b/src/pals/kinds/Fork.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .BaseElement import BaseElement
+from .mixin import BaseElement
 from ..parameters import ForkParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Fork")
diff --git a/src/pals/kinds/Girder.py b/src/pals/kinds/Girder.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Girder")
diff --git a/src/pals/kinds/Instrument.py b/src/pals/kinds/Instrument.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Instrument")
diff --git a/src/pals/kinds/Kicker.py b/src/pals/kinds/Kicker.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Kicker")
diff --git a/src/pals/kinds/Marker.py b/src/pals/kinds/Marker.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Marker")
diff --git a/src/pals/kinds/Mask.py b/src/pals/kinds/Mask.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Mask")
diff --git a/src/pals/kinds/Match.py b/src/pals/kinds/Match.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Match")
diff --git a/src/pals/kinds/Multipole.py b/src/pals/kinds/Multipole.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Multipole")
diff --git a/src/pals/kinds/NullEle.py b/src/pals/kinds/NullEle.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("NullEle")
diff --git a/src/pals/kinds/Octupole.py b/src/pals/kinds/Octupole.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Octupole")
diff --git a/src/pals/kinds/Patch.py b/src/pals/kinds/Patch.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import PatchParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Patch")
diff --git a/src/pals/kinds/Quadrupole.py b/src/pals/kinds/Quadrupole.py
@@ -1,6 +1,6 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import MagneticMultipoleParameters, ElectricMultipoleParameters
 
 
diff --git a/src/pals/kinds/RBend.py b/src/pals/kinds/RBend.py
@@ -1,6 +1,6 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import (
     BendParameters,
     ElectricMultipoleParameters,
diff --git a/src/pals/kinds/RFCavity.py b/src/pals/kinds/RFCavity.py
@@ -1,13 +1,13 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import (
     RFParameters,
     SolenoidParameters,
     ElectricMultipoleParameters,
     MagneticMultipoleParameters,
 )
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("RFCavity")
diff --git a/src/pals/kinds/SBend.py b/src/pals/kinds/SBend.py
@@ -1,6 +1,6 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import (
     BendParameters,
     ElectricMultipoleParameters,
diff --git a/src/pals/kinds/Sextupole.py b/src/pals/kinds/Sextupole.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Sextupole")
diff --git a/src/pals/kinds/Solenoid.py b/src/pals/kinds/Solenoid.py
@@ -1,12 +1,12 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import (
     SolenoidParameters,
     ElectricMultipoleParameters,
     MagneticMultipoleParameters,
 )
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Solenoid")
diff --git a/src/pals/kinds/Taylor.py b/src/pals/kinds/Taylor.py
@@ -1,7 +1,7 @@
 from typing import Literal
 
-from .BaseElement import BaseElement
-from ._warnings import under_construction
+from .mixin import BaseElement
+from .utils import under_construction
 
 
 @under_construction("Taylor")
diff --git a/src/pals/kinds/UnionEle.py b/src/pals/kinds/UnionEle.py
@@ -1,6 +1,8 @@
+from pydantic import model_validator
 from typing import List, Literal
 
-from .BaseElement import BaseElement
+from .all_elements import get_all_elements_as_annotation
+from .mixin import BaseElement
 
 
 class UnionEle(BaseElement):
diff --git a/src/pals/kinds/Wiggler.py b/src/pals/kinds/Wiggler.py
@@ -1,8 +1,8 @@
 from typing import Literal, Optional
 
-from .ThickElement import ThickElement
+from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
-from ._warnings import under_construction
+from .utils import under_construction
 
 
 @under_construction("Wiggler")
diff --git a/src/pals/kinds/__init__.py b/src/pals/kinds/__init__.py
@@ -3,7 +3,6 @@
 """
 
 from .ACKicker import ACKicker  # noqa: F401
-from .BaseElement import BaseElement  # noqa: F401
 from .BeamBeam import BeamBeam  # noqa: F401
 from .BeamLine import BeamLine  # noqa: F401
 from .BeginningEle import BeginningEle  # noqa: F401
@@ -33,6 +32,5 @@
 from .Sextupole import Sextupole  # noqa: F401
 from .Solenoid import Solenoid  # noqa: F401
 from .Taylor import Taylor  # noqa: F401
-from .ThickElement import ThickElement  # noqa: F401
 from .UnionEle import UnionEle  # noqa: F401
 from .Wiggler import Wiggler  # noqa: F401
diff --git a/src/pals/kinds/mixin/BaseElement.py b/src/pals/kinds/mixin/BaseElement.py
@@ -1,7 +1,7 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 from typing import Literal, Optional
 
-from ..parameters import (
+from pals.parameters import (
     ApertureParameters,
     BodyShiftParameters,
     FloorParameters,
@@ -12,16 +12,12 @@
 )
 
 
-class BaseElement(BaseModel):
+class BaseElement(BaseModel, validate_assignment=True):
     """A custom base element defining common properties"""
 
     # Discriminator field
     kind: Literal["BaseElement"] = "BaseElement"
 
-    # Validate every time a new value is assigned to an attribute,
-    # not only when an instance of BaseElement is created
-    model_config = ConfigDict(validate_assignment=True)
-
     # element name
     name: str
 
diff --git a/src/pals/kinds/mixin/ThickElement.py b/src/pals/kinds/mixin/ThickElement.py
@@ -1,7 +1,7 @@
 from typing import Annotated, Literal
 from annotated_types import Gt
 
-from .BaseElement import BaseElement
+from . import BaseElement
 
 
 class ThickElement(BaseElement):
diff --git a/src/pals/kinds/mixin/__init__.py b/src/pals/kinds/mixin/__init__.py
@@ -0,0 +1,2 @@
+from .BaseElement import BaseElement  # noqa: F401
+from .ThickElement import ThickElement  # noqa: F401
diff --git a/src/pals/kinds/mixin/all_element_mixin.py b/src/pals/kinds/mixin/all_element_mixin.py
diff --git a/src/pals/kinds/utils/__init__.py b/src/pals/kinds/utils/__init__.py
diff --git a/src/pals/kinds/utils/warnings.py b/src/pals/kinds/utils/warnings.py
diff --git a/tests/test_elements.py b/tests/test_elements.py
