Modernize: Python 3.11+ (#65)

Author: ax3l

.github/workflows/tests.yml

@@ -10,17 +10,20 @@ concurrency:
   group: ${{ github.ref }}-${{ github.head_ref }}-pals-python
   cancel-in-progress: true
 
+permissions:
+  contents: read  # access to check out code and install dependencies
+
 jobs:
   tests:
     name: tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install

pyproject.toml

@@ -10,7 +10,7 @@ dependencies = [
   "pyyaml",
   "toml",
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 authors = [
   { name="Axel Huebl", email="axelhuebl@lbl.gov" },
   { name="Edoardo Zoni", email="ezoni@lbl.gov" },

src/pals/PALS.py

@@ -1,20 +1,20 @@
 from pydantic import BaseModel
 
 from pydantic import model_validator
-from typing import List, Optional
+from typing import Self
 
 from .kinds import Lattice
 from .kinds.all_elements import get_all_elements_as_annotation
 from .functions import load_file_to_dict, store_dict_to_file
 
 
-Facility = List[get_all_elements_as_annotation()]
+Facility = list[get_all_elements_as_annotation()]
 
 
 class PALSroot(BaseModel):
     """Represent the roo PALS structure"""
 
-    version: Optional[str] = None
+    version: str | None = None
 
     facility: Facility
 
@@ -37,7 +37,7 @@ def model_dump(self, *args, **kwargs):
         return data
 
     @staticmethod
-    def from_file(filename: str) -> "PALSroot":
+    def from_file(filename: str) -> Self:
         """Load a facility from a text file"""
         pals_dict = load_file_to_dict(filename)
         return PALSroot(**pals_dict)

src/pals/kinds/BeamBeam.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from .mixin import BaseElement
 from ..parameters import BeamBeamParameters
@@ -13,4 +13,4 @@ class BeamBeam(BaseElement):
     kind: Literal["BeamBeam"] = "BeamBeam"
 
     # Beam-beam-specific parameters
-    BeamBeamP: Optional[BeamBeamParameters] = None
+    BeamBeamP: BeamBeamParameters | None = None

src/pals/kinds/BeamLine.py

@@ -1,5 +1,5 @@
 from pydantic import model_validator
-from typing import List, Literal
+from typing import Literal, Self
 
 from .all_elements import get_all_elements_as_annotation
 from .mixin import BaseElement
@@ -11,7 +11,7 @@ class BeamLine(BaseElement):
 
     kind: Literal["BeamLine"] = "BeamLine"
 
-    line: List[get_all_elements_as_annotation()]
+    line: list[get_all_elements_as_annotation()]
 
     @model_validator(mode="before")
     @classmethod
@@ -28,7 +28,7 @@ def model_dump(self, *args, **kwargs):
         return dump_element_list(self, "line", *args, **kwargs)
 
     @staticmethod
-    def from_file(filename: str) -> "BeamLine":
+    def from_file(filename: str) -> Self:
         """Load a BeamLine from a text file"""
         pals_dict = load_file_to_dict(filename)
         return BeamLine(**pals_dict)

src/pals/kinds/Converter.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from .mixin import BaseElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
@@ -13,5 +13,5 @@ class Converter(BaseElement):
     kind: Literal["Converter"] = "Converter"
 
     # Converter-specific parameters
-    ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
-    MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None
+    ElectricMultipoleP: ElectricMultipoleParameters | None = None
+    MagneticMultipoleP: MagneticMultipoleParameters | None = None

src/pals/kinds/CrabCavity.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
@@ -13,5 +13,5 @@ class CrabCavity(ThickElement):
     kind: Literal["CrabCavity"] = "CrabCavity"
 
     # CrabCavity-specific parameters
-    ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
-    MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None
+    ElectricMultipoleP: ElectricMultipoleParameters | None = None
+    MagneticMultipoleP: MagneticMultipoleParameters | None = None

src/pals/kinds/EGun.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from .mixin import ThickElement
 from ..parameters import ElectricMultipoleParameters, MagneticMultipoleParameters
@@ -13,5 +13,5 @@ class EGun(ThickElement):
     kind: Literal["EGun"] = "EGun"
 
     # EGun-specific parameters
-    ElectricMultipoleP: Optional[ElectricMultipoleParameters] = None
-    MagneticMultipoleP: Optional[MagneticMultipoleParameters] = None
+    ElectricMultipoleP: ElectricMultipoleParameters | None = None
+    MagneticMultipoleP: MagneticMultipoleParameters | None = None

src/pals/kinds/FloorShift.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from .mixin import BaseElement
 from ..parameters import FloorShiftParameters
@@ -11,4 +11,4 @@ class FloorShift(BaseElement):
     kind: Literal["FloorShift"] = "FloorShift"
 
     # Floor shift-specific parameters
-    FloorShiftP: Optional[FloorShiftParameters] = None
+    FloorShiftP: FloorShiftParameters | None = None

src/pals/kinds/Fork.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional
+from typing import Literal
 
 from .mixin import BaseElement
 from ..parameters import ForkParameters
@@ -13,4 +13,4 @@ class Fork(BaseElement):
     kind: Literal["Fork"] = "Fork"
 
     # Fork-specific parameters
-    ForkP: Optional[ForkParameters] = None
+    ForkP: ForkParameters | None = None