enumerific 0.0.0__py3-none-any.whl

enumerific/__init__.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+from enum import *
+
+import logging
+
+
+class EnumValueError(ValueError):
+    pass
+
+
+logger = logging.getLogger(__name__)
+
+
+class Enum(Enum):
+    """An extended Enum class that provides support for validating an Enum value and
+    accepting either enumeration class properties as enumeration values or their string
+    names or values, and providing straightforward access to the enumeration values an
+    Enum class holds."""
+
+    @classmethod
+    def validate(cls, value: Enum | str | int | object) -> bool:
+        """Determine if an enum value name or enum value is valid or not"""
+
+        try:
+            return cls.reconcile(value=value, default=None) is not None
+        except EnumValueError as exception:
+            return False
+
+    @classmethod
+    def reconcile(
+        cls,
+        value: Enum | str | int | object,
+        default: Enum = None,
+        raises: bool = False,
+    ) -> Enum | None:
+        """Reconcile enum values and enum names to their corresponding enum option, as
+        well as allowing valid enum options to be returned unmodified; if the provided
+        enum option, enum value or enum name cannot be reconciled and if a default value
+        has been provided, the default value will be returned instead and a warning
+        message will be logged, otherwise an EnumValueError exception will be raised."""
+
+        if isinstance(value, str):
+            for prop, enumeration in cls.__members__.items():
+                if enumeration.name.casefold() == value.casefold():
+                    return enumeration
+                elif (
+                    isinstance(enumeration.value, str)
+                    and enumeration.value.casefold() == value.casefold()
+                ):
+                    return enumeration
+        elif isinstance(value, int) and not isinstance(value, bool):
+            for prop, enumeration in cls.__members__.items():
+                if isinstance(enumeration.value, int) and enumeration.value == value:
+                    return enumeration
+        elif isinstance(value, bool):
+            for prop, enumeration in cls.__members__.items():
+                if enumeration.value is value:
+                    return enumeration
+        elif isinstance(value, cls):
+            if value in cls:
+                return value
+        elif not value is None:
+            for prop, enumeration in cls.__members__.items():
+                if enumeration.value == value:
+                    return enumeration
+
+        if value is not None:
+            if raises is True:
+                raise EnumValueError(
+                    "The provided value, %r, is invalid and does not correspond with this enumeration's options!"
+                    % (value)
+                )
+            else:
+                logger.warning(
+                    "The provided value, %r, is invalid, but a default, %r, has been provided, and will be returned instead!",
+                    value,
+                    default,
+                )
+
+        return default
+
+    @classmethod
+    def options(cls) -> list[Enum]:
+        """Provide straightforward access to the list of enumeration options"""
+
+        return cls.__members__.values()

enumerific-0.0.0.dist-info/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2024–2025 Daniel Sissman.
+
+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.

enumerific-0.0.0.dist-info/METADATA

@@ -0,0 +1,4 @@
+Metadata-Version: 2.2
+Name: enumerific
+Version: 0.0.0
+License-File: LICENSE.md

enumerific-0.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+enumerific/__init__.py,sha256=GWEZBAT_ml4VXTQLjUKLnkQtf3AUljF0vokd8-cINk8,3227
+enumerific-0.0.0.dist-info/LICENSE.md,sha256=j1XidOCGUhPx7CyXA31uC0XGKDRnvUcZpMp161qHI6g,1077
+enumerific-0.0.0.dist-info/METADATA,sha256=xTLu0rdVXG3rz6ct3SytxKUsA4ZJaRbgyyDOSguvEKs,79
+enumerific-0.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+enumerific-0.0.0.dist-info/top_level.txt,sha256=hyemsMgPYZgSx71XHmFRF-gvc_2Y4rDAESR8e0hbYHU,11
+enumerific-0.0.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+enumerific-0.0.0.dist-info/RECORD,,

enumerific-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

enumerific-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+enumerific

enumerific-0.0.0.dist-info/zip-safe

@@ -0,0 +1 @@
+