Merge pull request #4143 from silx-kit/enum-doc

silx.utils.enum: Deprecated `Enum.from_value` method

doc/source/modules/utils/enum.rst

@@ -0,0 +1,7 @@
+.. currentmodule:: silx.utils
+
+:mod:`enum`
+---------------
+
+.. automodule:: silx.utils.enum
+   :members:

doc/source/modules/utils/index.rst

@@ -6,6 +6,7 @@
 
     array_like.rst
     decorators.rst
+    enum.rst
     testutils.rst
     weakref.rst
     retry.rst

doc/source/modules/utils/retry.rst

@@ -1,6 +1,6 @@
 .. currentmodule:: silx.utils
 
-:mod:`weakref`
+:mod:`retry`
 ---------------
 
 .. automodule:: silx.utils.retry

src/silx/gui/dialog/ColormapDialog.py

@@ -763,7 +763,7 @@ def _plotGammaMarkerConstraint(self, x, y):
         return x, y
 
     def setDisplayMode(self, mode: str | DisplayMode):
-        mode = DisplayMode.from_value(mode)
+        mode = DisplayMode(mode)
         if mode is DisplayMode.HISTOGRAM:
             action = self._dataHistogramAction
         elif mode is DisplayMode.RANGE:

src/silx/gui/plot/ImageView.py

@@ -747,7 +747,7 @@ def setProfileWindowBehavior(self, behavior: Union[str, ProfileWindowBehavior]):
         - 'embedded': Horizontal, vertical and cross profiles are displayed in
           sides widgets, others are displayed in pop-up windows.
         """
-        behavior = self.ProfileWindowBehavior.from_value(behavior)
+        behavior = self.ProfileWindowBehavior(behavior)
         if behavior is not self.getProfileWindowBehavior():
             manager = self.__profile.getProfileManager()
             manager.clearProfile()

src/silx/gui/plot/StatsWidget.py

@@ -533,7 +533,7 @@ def setUpdateMode(self, mode):
         :param mode: mode requested for update
         :type mode: Union[str,UpdateMode]
         """
-        mode = UpdateMode.from_value(mode)
+        mode = UpdateMode(mode)
         if mode != self._updateMode:
             self._updateMode = mode
             self._updateModeHasChanged()
@@ -1011,7 +1011,7 @@ def setUpdateMode(self, mode):
         :param mode: mode requested for update
         :type mode: Union[str,UpdateMode]
         """
-        mode = UpdateMode.from_value(mode)
+        mode = UpdateMode(mode)
 
         if mode is UpdateMode.AUTO:
             if not self._autoRB.isChecked():

src/silx/gui/plot/items/complex.py

@@ -226,7 +226,7 @@ def setColormap(self, colormap, mode=None):
         if mode is None:
             mode = self.getComplexMode()
         else:
-            mode = self.ComplexMode.from_value(mode)
+            mode = self.ComplexMode(mode)
 
         self._colormaps[mode] = colormap
         if mode is self.getComplexMode():
@@ -245,7 +245,7 @@ def getColormap(self, mode=None):
         if mode is None:
             mode = self.getComplexMode()
         else:
-            mode = self.ComplexMode.from_value(mode)
+            mode = self.ComplexMode(mode)
 
         return self._colormaps[mode]
 
@@ -343,7 +343,7 @@ def getData(self, copy=True, mode=None):
         if mode is None:
             mode = self.getComplexMode()
         else:
-            mode = self.ComplexMode.from_value(mode)
+            mode = self.ComplexMode(mode)
 
         if mode not in self._dataByModesCache:
             self._dataByModesCache[mode] = self.__convertComplexData(
@@ -364,7 +364,7 @@ def getRgbaImageData(self, copy=True, mode=None):
         if mode is None:
             mode = self.getComplexMode()
         else:
-            mode = self.ComplexMode.from_value(mode)
+            mode = self.ComplexMode(mode)
 
         colormap = self.getColormap(mode=mode)
         if mode is self.ComplexMode.AMPLITUDE_PHASE:

src/silx/gui/plot/items/core.py

@@ -1155,7 +1155,7 @@ def setComplexMode(self, mode):
         :return: True if value was set, False if is was already set
         :rtype: bool
         """
-        mode = self.ComplexMode.from_value(mode)
+        mode = self.ComplexMode(mode)
         assert mode in self.supportedComplexModes()
 
         if mode != self.__complex_mode:
@@ -1355,7 +1355,7 @@ def setVisualization(self, mode):
         :return: True if value was set, False if is was already set
         :rtype: bool
         """
-        mode = self.Visualization.from_value(mode)
+        mode = self.Visualization(mode)
         assert mode in self.supportedVisualizations()
 
         if mode != self.__visualization:
@@ -1385,7 +1385,7 @@ def setVisualizationParameter(self, parameter, value=None):
         :rtype: bool
         :raise ValueError: If value is not supported
         """
-        parameter = self.VisualizationParameter.from_value(parameter)
+        parameter = self.VisualizationParameter(parameter)
 
         if self.__parameters[parameter] != value:
             validValues = self.supportedVisualizationParameterValues(parameter)

src/silx/gui/plot/items/image_aggregated.py

@@ -74,7 +74,7 @@ def setAggregationMode(self, mode: Union[str, Aggregation]):
 
         :param Aggregation mode: The aggregation method
         """
-        aggregationMode = self.Aggregation.from_value(mode)
+        aggregationMode = self.Aggregation(mode)
         if aggregationMode != self.__aggregationMode:
             self.__aggregationMode = aggregationMode
             self.__cacheLODData = {}  # Clear cache

src/silx/gui/plot/items/scatter.py

@@ -339,7 +339,7 @@ def setVisualization(self, mode):
 
     @docstring(ScatterVisualizationMixIn)
     def setVisualizationParameter(self, parameter, value):
-        parameter = self.VisualizationParameter.from_value(parameter)
+        parameter = self.VisualizationParameter(parameter)
 
         if super(Scatter, self).setVisualizationParameter(parameter, value):
             if parameter in (

src/silx/gui/plot3d/Plot3DWidget.py

@@ -279,7 +279,7 @@ def setFogMode(self, mode):
         :param Union[str,FogMode] mode: The mode to use
         :raise ValueError: If mode is not supported
         """
-        mode = self.FogMode.from_value(mode)
+        mode = self.FogMode(mode)
         if mode != self.getFogMode():
             self.viewport.fog.isOn = mode is self.FogMode.LINEAR
             self.sigStyleChanged.emit("fogMode")

src/silx/gui/plot3d/items/volume.py

@@ -818,7 +818,7 @@ def __init__(self, parent=None):
 
     @docstring(ComplexMixIn)
     def setComplexMode(self, mode):
-        mode = ComplexMixIn.ComplexMode.from_value(mode)
+        mode = ComplexMixIn.ComplexMode(mode)
         if mode != self.getComplexMode():
             self.clearIsosurfaces()  # Reset isosurfaces
         ComplexMixIn.setComplexMode(self, mode)

src/silx/utils/enum.py

@@ -27,14 +27,15 @@
 __license__ = "MIT"
 __date__ = "29/04/2019"
 
-
+from silx.utils.deprecation import deprecated
 import enum
 
 
 class Enum(enum.Enum):
     """Enum with additional class methods."""
 
     @classmethod
+    @deprecated(since_version="2.1.1", replacement="Enum(value)")
     def from_value(cls, value):
         """Convert a value to corresponding Enum member
 

src/silx/utils/test/test_enum.py

@@ -28,7 +28,6 @@
 __date__ = "29/04/2019"
 
 
-import pytest
 from silx.utils.enum import Enum
 
 
@@ -43,7 +42,3 @@ class Success(Enum):
     assert Success.names() == ("A", "B")
     assert Success.values() == (1, "B")
 
-    assert Success.from_value(1) == Success.A
-    assert Success.from_value("B") == Success.B
-    with pytest.raises(ValueError):
-        Success.from_value(3)