Merge pull request #2685 from kif/2679_case-insensitive_dataclass

case-insensitive dataclass to prevent some warnings

Author: kif

doc/source/changelog.rst

@@ -1,11 +1,11 @@
 :Author: Jérôme Kieffer
-:Date: 06/10/2025
+:Date: 15/11/2025
 :Keywords: changelog
 
 Change-log of versions
 ======================
 
-2025.11? YY/11/2025 --> 3.14 comes out in October
+2025.11? YY/11/2025 --> 3.14 came out in October, drop 3.9
 -------------------
 - [Parallax] This effect shifts the pixel position when the inclinaison of the beam is large (>30°) making calibration challenging
   * Provide absorption coefficients of most common sensor materials
@@ -35,9 +35,8 @@ Change-log of versions
 - [integrate1|2d] enforce arguments to be kwargs to limit user errors
 - [Doc] Improve the notebook about "flatfield" calculation.
 - [Integrate1/2dResult] can now be added or subtracted to perform some basic maths, uncertainties are propagated accordingly.
-- [Deprecation]
-    * `splineFile` --> `splinefile` in most arguments and also as properties
-    * SPD and FIT2D dataclasses are becoming case insensitive (PEP8 enforcement)
+- [Fit2dGeometry] becomes a case-insensitive dataclass (thus mutable, was NamedTuple) which behaves like a dict.
+- [Deprecation] `splineFile` --> `splinefile` in most arguments and also as properties
 - Prefer the `numexpr` (fallback on `numpy`) function evaluation in favor of the Cython path for geometry initialization, less prone to numerical noise.
   Cython is still prefered for geometry optimization where performance is critical.
 - Start to support type annotation in the code.

src/pyFAI/geometry/core.py

@@ -40,7 +40,7 @@
 __contact__ = "Jerome.Kieffer@ESRF.eu"
 __license__ = "MIT"
 __copyright__ = "European Synchrotron Radiation Facility, Grenoble, France"
-__date__ = "11/11/2025"
+__date__ = "15/11/2025"
 __status__ = "production"
 __docformat__ = "restructuredtext"
 
@@ -1772,9 +1772,7 @@ def getFit2D(self):
         """
         with self._sem:
             f2d = convert_to_Fit2d(self)
-            dico = f2d._asdict()
-            dico["splinefile"] = dico.get("splineFile")
-        return dico
+        return f2d
 
     @deprecated_args({"splinefile":"splineFile"}, since_version="2025.10")
     def setFit2D(

src/pyFAI/geometry/fit2d.py

@@ -4,7 +4,7 @@
 #    Project: Azimuthal integration
 #             https://github.com/silx-kit/pyFAI
 #
-#    Copyright (C) 2021-2022 European Synchrotron Radiation Facility, Grenoble, France
+#    Copyright (C) 2021-2025 European Synchrotron Radiation Facility, Grenoble, France
 #
 #    Principal author:       Jérôme Kieffer (Jerome.Kieffer@ESRF.eu)
 #
@@ -33,14 +33,14 @@
 __contact__ = "Jerome.Kieffer@ESRF.eu"
 __license__ = "MIT"
 __copyright__ = "European Synchrotron Radiation Facility, Grenoble, France"
-__date__ = "11/11/2025"
+__date__ = "15/11/2025"
 __status__ = "production"
 __docformat__ = 'restructuredtext'
 
 import os
 import logging
-from typing import NamedTuple
 from math import pi, cos, sin, sqrt, acos, asin
+from ..utils.dataclasses import case_insensitive_dataclass
 from ..detectors import Detector
 from ..io.ponifile import PoniFile
 logger = logging.getLogger(__name__)
@@ -52,8 +52,11 @@ def radians(deg:float) -> float:
     return deg * pi / 180
 
 
-class Fit2dGeometry(NamedTuple):
-    """ This object represents the geometry as configured in Fit2D
+@case_insensitive_dataclass(slots=True)
+class Fit2dGeometry:
+    """ This object represents the geometry as configured in Fit2D.
+
+    It behaves like a dataclass, is case insensitive and can behave like a dict as well but cannnot be extended.
 
     :param directDist: Distance from sample to the detector along the incident beam in mm. The detector may be extrapolated when tilted.
     :param centerX: Position of the beam-center on the detector in pixels, along the fastest axis of the image.
@@ -70,23 +73,47 @@ class Fit2dGeometry(NamedTuple):
     tiltPlanRotation: float = 0.0
     pixelX: float = None
     pixelY: float = None
-    splineFile: str = None
+    splinefile: str = None
     detector: Detector = None
     wavelength: float = None
 
     @classmethod
     def _fromdict(cls, dico):
         "Mirror of _asdict: take the dict and populate the tuple to be returned"
-        # adaptation of keys, in lower-case
-        dico_lower = {k.lower():v for k,v in dico.items()}
-        obj = cls(**{key: dico_lower[key.lower()] for key in [i for i in cls._fields if i.lower() in dico_lower]})
+        obj = cls(**dico)
         return obj
 
+    def _asdict(self):
+        "Mirror of _asdict method from NamedTuple"
+        return {k: self.__getattr__(k) for k in self.__annotations__}
+
     def __repr__(self):
         return f"DirectBeamDist= {self.directDist:.3f} mm\tCenter: x={self.centerX:.3f}, y={self.centerY:.3f} pix\t"\
                f"Tilt= {self.tilt:.3f}° tiltPlanRotation= {self.tiltPlanRotation:.3f}°" + \
                (f" \N{GREEK SMALL LETTER LAMDA}= {self.wavelength:.3f}\N{LATIN CAPITAL LETTER A WITH RING ABOVE}" if self.wavelength else "")
 
+    # dict-like interface:
+    def __getitem__(self, key:str):
+        return self.__getattr__(key)
+    def __setitem__(self, key:str, value):
+        self.__setattr__(key, value)
+    def get(self, key:str, default=None):
+        if key.lower() in self._ci_map:
+            return self.__getattr__(key)
+        return default
+    def __contains__(self, key:str):
+        return key.lower() in self._ci_map
+    def __iter__(self):
+        yield from self._ci_map.values()
+    def keys(self):
+        return self._ci_map.values()
+    def values(self):
+        return [self.__getattr__(i) for i in self._ci_map.values()]
+    def items(self):
+        return [(i, self.__getattr__(i)) for i in self._ci_map.values()]
+    def __len__(self):
+        return self._ci_map.__len__()
+
 
 def convert_to_Fit2d(poni):
     """Convert a Geometry|PONI object to the geometry of Fit2D
@@ -147,7 +174,7 @@ def convert_from_Fit2d(f2d):
     """
     if not isinstance(f2d, Fit2dGeometry):
         if isinstance(f2d, dict):
-            f2d = Fit2dGeometry(**f2d)
+            f2d = Fit2dGeometry._fromdict(f2d)
         else:
             f2d = Fit2dGeometry(f2d)
     res = PoniFile()

src/pyFAI/test/test_geometry.py

@@ -34,7 +34,7 @@
 __contact__ = "Jerome.Kieffer@ESRF.eu"
 __license__ = "MIT"
 __copyright__ = "European Synchrotron Radiation Facility, Grenoble, France"
-__date__ = "10/11/2025"
+__date__ = "14/11/2025"
 
 import unittest
 import random
@@ -48,14 +48,16 @@
 from math import pi
 from . import utilstest
 from ..io.ponifile import PoniFile
-from .. import geometry
+from .. import geometry, load
 from ..integrator.azimuthal import AzimuthalIntegrator
 from .. import units
 from ..detectors import detector_factory
 from ..third_party import transformations
 from .utilstest import UtilsTest
 from ..utils.mathutil import allclose_mod
 from ..geometry.crystfel import build_geometry, parse_crystfel_geom
+from ..geometry.fit2d import Fit2dGeometry
+
 logger = logging.getLogger(__name__)
 
 
@@ -618,6 +620,14 @@ def test_bug2024(self):
         self.assertLess(delta_array.max(), numpy.pi, "delta_array is less than pi")
         self.assertTrue(numpy.allclose(delta_array, deltaChi, atol=7e-6), "delta_array matches deltaChi")
 
+    def test_bug2679(self):
+        ai = load({"dist":0.1, "rot1":0.1, "detector":"Pilatus100k"})
+        with utilstest.TestLogging(logger='pyFAI.DEPRECATION', warning=0):
+            f2d = ai.getFit2D()
+            f2ddc = Fit2dGeometry(**f2d)
+            f2ddc.tilt=0
+            ai.setFit2D(**f2ddc._asdict())
+
 
 class TestOrientation(unittest.TestCase):
     """Simple tests to validate the orientation of the detector"""

src/pyFAI/test/test_utils.py

@@ -32,7 +32,7 @@
 __contact__ = "Jerome.Kieffer@ESRF.eu"
 __license__ = "MIT"
 __copyright__ = "European Synchrotron Radiation Facility, Grenoble, France"
-__date__ = "10/10/2025"
+__date__ = "14/11/2025"
 
 import os
 import unittest
@@ -49,6 +49,7 @@
 from ..utils.stringutil import to_scientific_unicode
 from ..utils.multiprocessing import cpu_count
 from ..utils.mask_utils import search_gaps, build_gaps
+from ..utils.dataclasses import case_insensitive_dataclass
 logger = logging.getLogger(__name__)
 
 
@@ -118,6 +119,35 @@ def test_mask(self):
         mask[-1, :] =1
         numpy.allclose(build_gaps(mask.shape, search_gaps(mask)), mask)
 
+    def test_case_insensitive_dataclass(self):
+        @case_insensitive_dataclass
+        class Person:
+            Name: str
+            Age: int = 0
+        a = Person("Alice", 10)
+        self.assertAlmostEqual(a.Name, "Alice")
+        self.assertAlmostEqual(a.name, "Alice")
+        self.assertAlmostEqual(a.Age, 10)
+        self.assertAlmostEqual(a.age, 10)
+
+        a = Person("Alice")
+        self.assertAlmostEqual(a.Name, "Alice")
+        self.assertAlmostEqual(a.name, "Alice")
+        self.assertAlmostEqual(a.Age, 0)
+        self.assertAlmostEqual(a.age, 0)
+
+        a = Person("Alice", age=10)
+        self.assertAlmostEqual(a.Name, "Alice")
+        self.assertAlmostEqual(a.name, "Alice")
+        self.assertAlmostEqual(a.Age, 10)
+        self.assertAlmostEqual(a.age, 10)
+
+        a = Person(age=10, name="Alice")
+        self.assertAlmostEqual(a.Name, "Alice")
+        self.assertAlmostEqual(a.name, "Alice")
+        self.assertAlmostEqual(a.Age, 10)
+        self.assertAlmostEqual(a.age, 10)
+
 
 def suite():
     loader = unittest.defaultTestLoader.loadTestsFromTestCase