Deprecate Enum class

Author: loichuder

src/silx/gui/dialog/ColormapDialog.py

@@ -86,7 +86,7 @@
 from silx.math.histogram import Histogramnd
 from silx.gui.plot.items.roi import RectangleROI
 from silx.gui.plot.tools.roi import RegionOfInterestManager
-from silx.utils.enum import Enum as _Enum
+from silx.utils._enum import Enum as _Enum
 
 _logger = logging.getLogger(__name__)
 

src/silx/gui/plot/ImageView.py

@@ -58,7 +58,7 @@
 from .Profile import ProfileToolBar
 from ...utils.proxy import docstring
 from ...utils.deprecation import deprecated
-from ...utils.enum import Enum
+from ...utils._enum import Enum
 from .tools.RadarView import RadarView
 from .utils.axis import SyncAxes
 from ..utils import blockSignals

src/silx/gui/plot/StatsWidget.py

@@ -37,7 +37,7 @@
 import numpy
 import enum
 from silx.utils.proxy import docstring
-from silx.utils.enum import Enum as _Enum
+from silx.utils._enum import Enum as _Enum
 from silx.gui import qt
 from silx.gui import icons
 from silx.gui.plot import stats as statsmdl

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

@@ -41,7 +41,7 @@
 import numpy
 
 from ....utils.proxy import docstring
-from ....utils.enum import Enum as _Enum
+from ....utils._enum import Enum as _Enum
 from ....math.combo import min_max
 from ... import qt
 from ... import colors

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

@@ -35,7 +35,7 @@
 
 import numpy
 
-from ....utils.enum import Enum as _Enum
+from ....utils._enum import Enum as _Enum
 from ....utils.proxy import docstring
 from .axis import Axis
 from .core import ItemChangedType

src/silx/gui/plot3d/Plot3DWidget.py

@@ -35,7 +35,7 @@
 from silx.gui.colors import rgba
 from . import actions
 
-from ...utils.enum import Enum as _Enum
+from ...utils._enum import Enum as _Enum
 from ..utils.image import convertArrayToQImage
 
 from .. import _glutils as glu

src/silx/utils/_enum.py

@@ -0,0 +1,77 @@
+# /*##########################################################################
+#
+# Copyright (c) 2019 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""An :class:`.Enum` class with additional features."""
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "29/04/2019"
+
+
+import enum
+
+
+
+class Enum(enum.Enum):
+    """Enum with additional class methods."""
+
+    @classmethod
+    def from_value(cls, value):
+        """Convert a value to corresponding Enum member
+
+        :param value: The value to compare to Enum members
+           If it is already a member of Enum, it is returned directly.
+        :return: The corresponding enum member
+        :rtype: Enum
+        :raise ValueError: In case the conversion is not possible
+        """
+        if isinstance(value, cls):
+            return value
+        for member in cls:
+            if value == member.value:
+                return member
+        raise ValueError("Cannot convert: %s" % value)
+
+    @classmethod
+    def members(cls):
+        """Returns a tuple of all members.
+
+        :rtype: Tuple[Enum]
+        """
+        return tuple(member for member in cls)
+
+    @classmethod
+    def names(cls):
+        """Returns a tuple of all member names.
+
+        :rtype: Tuple[str]
+        """
+        return tuple(member.name for member in cls)
+
+    @classmethod
+    def values(cls):
+        """Returns a tuple of all member values.
+
+        :rtype: Tuple
+        """
+        return tuple(member.value for member in cls)

src/silx/utils/enum.py

@@ -1,76 +1,9 @@
-# /*##########################################################################
-#
-# Copyright (c) 2019 European Synchrotron Radiation Facility
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# ###########################################################################*/
-"""An :class:`.Enum` class with additional features."""
-
-__authors__ = ["T. Vincent"]
-__license__ = "MIT"
-__date__ = "29/04/2019"
-
-
-import enum
-
-
-class Enum(enum.Enum):
-    """Enum with additional class methods."""
-
-    @classmethod
-    def from_value(cls, value):
-        """Convert a value to corresponding Enum member
-
-        :param value: The value to compare to Enum members
-           If it is already a member of Enum, it is returned directly.
-        :return: The corresponding enum member
-        :rtype: Enum
-        :raise ValueError: In case the conversion is not possible
-        """
-        if isinstance(value, cls):
-            return value
-        for member in cls:
-            if value == member.value:
-                return member
-        raise ValueError("Cannot convert: %s" % value)
-
-    @classmethod
-    def members(cls):
-        """Returns a tuple of all members.
-
-        :rtype: Tuple[Enum]
-        """
-        return tuple(member for member in cls)
-
-    @classmethod
-    def names(cls):
-        """Returns a tuple of all member names.
-
-        :rtype: Tuple[str]
-        """
-        return tuple(member.name for member in cls)
-
-    @classmethod
-    def values(cls):
-        """Returns a tuple of all member values.
-
-        :rtype: Tuple
-        """
-        return tuple(member.value for member in cls)
+from ._enum import *
+from silx.utils.deprecation import deprecated_warning
+
+deprecated_warning(
+    "Class",
+    "silx.utils.enum.Enum",
+    since_version="2.1.1",
+    replacement="Python built-in Enum class",
+)

src/silx/utils/test/test_enum.py

@@ -29,7 +29,7 @@
 
 
 import pytest
-from silx.utils.enum import Enum
+from silx.utils._enum import Enum
 
 
 def test_enum_methods():