enumerific 1.0.6__tar.gz → 1.0.7__tar.gz

{enumerific-1.0.6/source/enumerific.egg-info → enumerific-1.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enumerific
-Version: 1.0.6
+Version: 1.0.7
 Summary: Simplifies working with Python enums.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -675,6 +675,32 @@ assert Colors.PURPLE.rgb == (255, 0, 255)
 assert Colors.PURPLE.primary is False
 ```
 
+#### Example 19: Reconciling Enumeration Options via Annotations
+
+```python
+from enumerific import Enumeration, auto
+
+class Colors(Enumeration):
+    """Create a test Color enumeration based on the Enumeration class"""
+
+    RED = auto(RGB=(255, 0, 0))
+    GREEN = auto(RGB=(0, 255, 0))
+    BLUE = auto(RGB=(0, 0, 255))
+
+# Ensure that the Colors enumeration subclass is of the expected types
+assert issubclass(Colors, Enumeration)
+
+# Attempt to reconcile a Color against one of its annotations
+color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
+
+assert isinstance(color, Colors)
+assert isinstance(color, Enumeration)
+
+assert color.name == "RED"
+assert color.value == 1
+assert color.RGB == (255, 0, 0)
+```
+
 # Enumerific Library Enumerations: Classes & Methods
 
 The Enumerific library's `Enumeration` class is a greenfield implementation of enumerations

{enumerific-1.0.6 → enumerific-1.0.7}/README.md

@@ -645,6 +645,32 @@ assert Colors.PURPLE.rgb == (255, 0, 255)
 assert Colors.PURPLE.primary is False
 ```
 
+#### Example 19: Reconciling Enumeration Options via Annotations
+
+```python
+from enumerific import Enumeration, auto
+
+class Colors(Enumeration):
+    """Create a test Color enumeration based on the Enumeration class"""
+
+    RED = auto(RGB=(255, 0, 0))
+    GREEN = auto(RGB=(0, 255, 0))
+    BLUE = auto(RGB=(0, 0, 255))
+
+# Ensure that the Colors enumeration subclass is of the expected types
+assert issubclass(Colors, Enumeration)
+
+# Attempt to reconcile a Color against one of its annotations
+color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
+
+assert isinstance(color, Colors)
+assert isinstance(color, Enumeration)
+
+assert color.name == "RED"
+assert color.value == 1
+assert color.RGB == (255, 0, 0)
+```
+
 # Enumerific Library Enumerations: Classes & Methods
 
 The Enumerific library's `Enumeration` class is a greenfield implementation of enumerations

{enumerific-1.0.6 → enumerific-1.0.7}/source/enumerific/extensible.py

@@ -1458,6 +1458,7 @@ class EnumerationMetaClass(type):
         value: Enumeration | object = None,
         name: str = None,
         caselessly: bool = False,
+        annotation: str = None,
     ) -> Enumeration | None:
         """The 'reconcile' method can be used to reconcile Enumeration type, enumeration
         values, or enumeration names to their matching Enumeration type instances. If a
@@ -1480,7 +1481,23 @@ class EnumerationMetaClass(type):
         reconciled: Enumeration = None
 
         for attribute, enumeration in self._enumerations.items():
-            if isinstance(value, Enumeration):
+            if isinstance(annotation, str):
+                if annotation in enumeration._annotations:
+                    if enumeration._annotations[annotation] is value:
+                        reconciled = enumeration
+                        break
+                    elif enumeration._annotations[annotation] == value:
+                        reconciled = enumeration
+                        break
+                else:
+                    raise EnumerationOptionError(
+                        "The enumeration option, %s, has no '%s' annotation!"
+                        % (
+                            enumeration,
+                            annotation,
+                        )
+                    )
+            elif isinstance(value, Enumeration):
                 if enumeration is value:
                     reconciled = enumeration
                     break

enumerific-1.0.7/source/enumerific/version.txt

@@ -0,0 +1 @@
+1.0.7

{enumerific-1.0.6 → enumerific-1.0.7/source/enumerific.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enumerific
-Version: 1.0.6
+Version: 1.0.7
 Summary: Simplifies working with Python enums.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -675,6 +675,32 @@ assert Colors.PURPLE.rgb == (255, 0, 255)
 assert Colors.PURPLE.primary is False
 ```
 
+#### Example 19: Reconciling Enumeration Options via Annotations
+
+```python
+from enumerific import Enumeration, auto
+
+class Colors(Enumeration):
+    """Create a test Color enumeration based on the Enumeration class"""
+
+    RED = auto(RGB=(255, 0, 0))
+    GREEN = auto(RGB=(0, 255, 0))
+    BLUE = auto(RGB=(0, 0, 255))
+
+# Ensure that the Colors enumeration subclass is of the expected types
+assert issubclass(Colors, Enumeration)
+
+# Attempt to reconcile a Color against one of its annotations
+color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
+
+assert isinstance(color, Colors)
+assert isinstance(color, Enumeration)
+
+assert color.name == "RED"
+assert color.value == 1
+assert color.RGB == (255, 0, 0)
+```
+
 # Enumerific Library Enumerations: Classes & Methods
 
 The Enumerific library's `Enumeration` class is a greenfield implementation of enumerations

{enumerific-1.0.6 → enumerific-1.0.7}/tests/test_extensible_enums.py

@@ -1613,8 +1613,8 @@ def test_membership_in_tuple():
     assert Colors.VIOLET not in colors
 
 
-def test_attribute_access():
-    """Test access to attributes (methods, properties, etc) on an Enumeration subclass"""
+def test_annotation_access():
+    """Test access to annotations (methods, properties, etc) on an Enumeration subclass"""
 
     class Colors(Enumeration, backfill=True):
         """Create a test Color enumeration based on the Enumeration class"""
@@ -1812,3 +1812,32 @@ def test_attribute_access():
     assert color.isMetallic() is False  # isMetallic() is defined on the Colors subclass
     assert color.HEX == "FF0000"  # HEX is a property defined on the Colors subclass
     assert color.count() == 8  # count() is a classmethod defined on the Colors subclass
+
+
+def test_annotation_reconciliation():
+    """Test reconciliation of enumeration options via their annotations."""
+
+    class Colors(Enumeration):
+        """Create a test Color enumeration based on the Enumeration class"""
+
+        RED = auto(RGB=(255, 0, 0))
+        ORANGE = auto(RGB=(255, 165, 0))
+        YELLOW = auto(RGB=(255, 255, 0))
+        GREEN = auto(RGB=(0, 255, 0))
+        BLUE = auto(RGB=(0, 0, 255))
+        VIOLET = auto(RGB=(255, 0, 255))
+
+    # Ensure that the Colors enumeration subclass is of the expected types
+    assert issubclass(Colors, Enumeration)
+    assert issubclass(Colors, EnumerationInteger)
+
+    # Attempt to reconcile a Color against one of its annotations
+    color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
+
+    assert isinstance(color, Colors)
+    assert isinstance(color, Enumeration)
+    assert isinstance(color, EnumerationInteger)
+
+    assert color.name == "RED"
+    assert color.value == 1
+    assert color.RGB == (255, 0, 0)

enumerific-1.0.6/source/enumerific/version.txt

@@ -1 +0,0 @@
-1.0.6