enumerific 1.0.5__py3-none-any.whl → 1.0.7__py3-none-any.whl

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
@@ -1797,6 +1814,28 @@ class Enumeration(metaclass=EnumerationMetaClass):
 
         return aliases
 
+    @property
+    def named(self) -> list[str]:
+        logger.debug(
+            "%s.names() >>> id(%s) => %s (%s)",
+            self.__class__.__name__,
+            self,
+            id(self._enumerations),
+            type(self._enumerations),
+        )
+
+        names: list[Enumeration] = [self.name]
+
+        for name, enumeration in self._enumerations.items():
+            logger.debug(" >>> checking for alias: %s => %s", name, enumeration)
+
+            if isinstance(enumeration, Enumeration):
+                if self is enumeration and enumeration.name != name:
+                    if not name in names:
+                        names.append(name)
+
+        return names
+
 
 class EnumerationType(Enumeration, typecast=False):
     """The EnumerationType class represents the type of value held by an enumeration."""

enumerific/version.txt

@@ -1 +1 @@
-1.0.5
+1.0.7

{enumerific-1.0.5.dist-info → enumerific-1.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: enumerific
-Version: 1.0.5
+Version: 1.0.7
 Summary: Simplifies working with Python enums.
 Author: Daniel Sissman
 License-Expression: MIT
@@ -468,6 +468,11 @@ assert Colors.BLUE.aliased is False
 assert Colors.RED.aliases == [Colors.ROUGE]
 assert Colors.GREEN.aliases == [Colors.VERTE]
 assert Colors.BLUE.aliases == []  # BLUE has not been aliased
+
+# The names including any aliases for an option can be obtained via the .named property
+assert Colors.RED.named == ["RED", "ROUGE"]
+assert Colors.GREEN.named == ["GREEN", "VERTE"]
+assert Colors.BLUE.named == ["BLUE"]
 ```
 
 #### Example 15: Non-Unique Options
@@ -670,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.7.dist-info/RECORD

@@ -0,0 +1,12 @@
+enumerific/__init__.py,sha256=K9iFirgxSkrHgXfhocOvgRkskGe0VfWRgxEvppnVWBM,587
+enumerific/exceptions.py,sha256=lvfcH1cz43hDjzSUpgm1-OZjKzxo--fyZ8UsBS-GiZA,359
+enumerific/extensible.py,sha256=HX-oZ91XtTLk5dmlqFOSFCO71_TEj1zGaO4KSKGwwoY,86507
+enumerific/logging.py,sha256=zz1Phnot1BFWMoxwvZ0FlZDsiYZZYhz-_S4IzgPYc40,97
+enumerific/standard.py,sha256=xQhhwlcYZ6-8DmgscbV38g2Ol5Z8_vvBwonz-Ww0I40,3254
+enumerific/version.txt,sha256=6fmB8RVMkjgdY7ZTz7_Hm-ksP2zJXgkVpeXBnzkkylg,5
+enumerific-1.0.7.dist-info/licenses/LICENSE.md,sha256=j1XidOCGUhPx7CyXA31uC0XGKDRnvUcZpMp161qHI6g,1077
+enumerific-1.0.7.dist-info/METADATA,sha256=AnTj6l-xLoVxh1rQ1dFw1t8_v3Aq2slvwgiL458SBGs,33923
+enumerific-1.0.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+enumerific-1.0.7.dist-info/top_level.txt,sha256=hyemsMgPYZgSx71XHmFRF-gvc_2Y4rDAESR8e0hbYHU,11
+enumerific-1.0.7.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+enumerific-1.0.7.dist-info/RECORD,,

enumerific-1.0.5.dist-info/RECORD

@@ -1,12 +0,0 @@
-enumerific/__init__.py,sha256=K9iFirgxSkrHgXfhocOvgRkskGe0VfWRgxEvppnVWBM,587
-enumerific/exceptions.py,sha256=lvfcH1cz43hDjzSUpgm1-OZjKzxo--fyZ8UsBS-GiZA,359
-enumerific/extensible.py,sha256=W-W1wXCW1wE7PP3Y2qbhxLpD2ETjmIQ-QTGnWIEGUyg,85084
-enumerific/logging.py,sha256=zz1Phnot1BFWMoxwvZ0FlZDsiYZZYhz-_S4IzgPYc40,97
-enumerific/standard.py,sha256=xQhhwlcYZ6-8DmgscbV38g2Ol5Z8_vvBwonz-Ww0I40,3254
-enumerific/version.txt,sha256=nXE_EpedYoeSULwKIDXj71cxWsQlHoUBnSHHXtcmlyA,5
-enumerific-1.0.5.dist-info/licenses/LICENSE.md,sha256=j1XidOCGUhPx7CyXA31uC0XGKDRnvUcZpMp161qHI6g,1077
-enumerific-1.0.5.dist-info/METADATA,sha256=WDWq40qr1A3IHSTMDVOfUcCw76YCUnlEqxcRKPI4rRU,32990
-enumerific-1.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-enumerific-1.0.5.dist-info/top_level.txt,sha256=hyemsMgPYZgSx71XHmFRF-gvc_2Y4rDAESR8e0hbYHU,11
-enumerific-1.0.5.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-enumerific-1.0.5.dist-info/RECORD,,