enumerific 1.0.7__tar.gz → 1.0.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. {enumerific-1.0.7/source/enumerific.egg-info → enumerific-1.0.8}/PKG-INFO +13 -3
  2. {enumerific-1.0.7 → enumerific-1.0.8}/README.md +12 -2
  3. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific/extensible.py +34 -19
  4. enumerific-1.0.8/source/enumerific/version.txt +1 -0
  5. {enumerific-1.0.7 → enumerific-1.0.8/source/enumerific.egg-info}/PKG-INFO +13 -3
  6. {enumerific-1.0.7 → enumerific-1.0.8}/tests/test_extensible_enums.py +31 -6
  7. enumerific-1.0.7/source/enumerific/version.txt +0 -1
  8. {enumerific-1.0.7 → enumerific-1.0.8}/LICENSE.md +0 -0
  9. {enumerific-1.0.7 → enumerific-1.0.8}/pyproject.toml +0 -0
  10. {enumerific-1.0.7 → enumerific-1.0.8}/requirements.development.txt +0 -0
  11. {enumerific-1.0.7 → enumerific-1.0.8}/requirements.distribution.txt +0 -0
  12. {enumerific-1.0.7 → enumerific-1.0.8}/requirements.txt +0 -0
  13. {enumerific-1.0.7 → enumerific-1.0.8}/setup.cfg +0 -0
  14. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific/__init__.py +0 -0
  15. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific/exceptions.py +0 -0
  16. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific/logging.py +0 -0
  17. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific/standard.py +0 -0
  18. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific.egg-info/SOURCES.txt +0 -0
  19. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific.egg-info/dependency_links.txt +0 -0
  20. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific.egg-info/requires.txt +0 -0
  21. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific.egg-info/top_level.txt +0 -0
  22. {enumerific-1.0.7 → enumerific-1.0.8}/source/enumerific.egg-info/zip-safe +0 -0
  23. {enumerific-1.0.7 → enumerific-1.0.8}/tests/test_enumerific_library.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: enumerific
3
- Version: 1.0.7
3
+ Version: 1.0.8
4
4
  Summary: Simplifies working with Python enums.
5
5
  Author: Daniel Sissman
6
6
  License-Expression: MIT
@@ -690,8 +690,8 @@ class Colors(Enumeration):
690
690
  # Ensure that the Colors enumeration subclass is of the expected types
691
691
  assert issubclass(Colors, Enumeration)
692
692
 
693
- # Attempt to reconcile a Color against one of its annotations
694
- color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
693
+ # Attempt to reconcile a Color against one of its annotations (via annotation keyword)
694
+ color = Colors.reconcile(RGB=(255, 0, 0))
695
695
 
696
696
  assert isinstance(color, Colors)
697
697
  assert isinstance(color, Enumeration)
@@ -699,6 +699,16 @@ assert isinstance(color, Enumeration)
699
699
  assert color.name == "RED"
700
700
  assert color.value == 1
701
701
  assert color.RGB == (255, 0, 0)
702
+
703
+ # Attempt to reconcile a Color against one of its annotations (via annotation argument)
704
+ color = Colors.reconcile(value=(0, 255, 0), annotation="RGB")
705
+
706
+ assert isinstance(color, Colors)
707
+ assert isinstance(color, Enumeration)
708
+
709
+ assert color.name == "GREEN"
710
+ assert color.value == 2
711
+ assert color.RGB == (0, 255, 0)
702
712
  ```
703
713
 
704
714
  # Enumerific Library Enumerations: Classes & Methods
@@ -660,8 +660,8 @@ class Colors(Enumeration):
660
660
  # Ensure that the Colors enumeration subclass is of the expected types
661
661
  assert issubclass(Colors, Enumeration)
662
662
 
663
- # Attempt to reconcile a Color against one of its annotations
664
- color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
663
+ # Attempt to reconcile a Color against one of its annotations (via annotation keyword)
664
+ color = Colors.reconcile(RGB=(255, 0, 0))
665
665
 
666
666
  assert isinstance(color, Colors)
667
667
  assert isinstance(color, Enumeration)
@@ -669,6 +669,16 @@ assert isinstance(color, Enumeration)
669
669
  assert color.name == "RED"
670
670
  assert color.value == 1
671
671
  assert color.RGB == (255, 0, 0)
672
+
673
+ # Attempt to reconcile a Color against one of its annotations (via annotation argument)
674
+ color = Colors.reconcile(value=(0, 255, 0), annotation="RGB")
675
+
676
+ assert isinstance(color, Colors)
677
+ assert isinstance(color, Enumeration)
678
+
679
+ assert color.name == "GREEN"
680
+ assert color.value == 2
681
+ assert color.RGB == (0, 255, 0)
672
682
  ```
673
683
 
674
684
  # Enumerific Library Enumerations: Classes & Methods
@@ -1459,44 +1459,59 @@ class EnumerationMetaClass(type):
1459
1459
  name: str = None,
1460
1460
  caselessly: bool = False,
1461
1461
  annotation: str = None,
1462
+ **annotations: dict[str, object],
1462
1463
  ) -> Enumeration | None:
1463
1464
  """The 'reconcile' method can be used to reconcile Enumeration type, enumeration
1464
1465
  values, or enumeration names to their matching Enumeration type instances. If a
1465
1466
  match is found the Enumeration type instance will be returned otherwise None will
1466
1467
  be returned, unless the class is configured to raise an error for mismatches."""
1467
1468
 
1468
- if name is None and value is None:
1469
+ if isinstance(annotation, str):
1470
+ annotations[annotation] = value
1471
+
1472
+ if name is None and value is None and len(annotations) == 0:
1469
1473
  raise ValueError(
1470
- "Either the 'value' or 'name' argument must be specified when calling the 'reconcile' function!"
1474
+ "Either a 'value', 'name' or annotation keyword argument must be specified when calling the 'reconcile' function!"
1471
1475
  )
1472
1476
 
1473
1477
  if not value is None and not isinstance(value, (Enumeration, object)):
1474
1478
  raise TypeError(
1475
- "The 'value' argument must reference an Enumeration type or have an enumeration value!"
1479
+ "The 'value' argument, if specified, must reference an Enumeration type or have an enumeration value!"
1476
1480
  )
1477
1481
 
1478
1482
  if not name is None and not isinstance(name, str):
1479
- raise TypeError("The 'name' argument must have a string value!")
1483
+ raise TypeError(
1484
+ "The 'name' argument, if specified, must have a string value!"
1485
+ )
1480
1486
 
1481
1487
  reconciled: Enumeration = None
1482
1488
 
1483
1489
  for attribute, enumeration in self._enumerations.items():
1484
- if isinstance(annotation, str):
1485
- if annotation in enumeration._annotations:
1486
- if enumeration._annotations[annotation] is value:
1487
- reconciled = enumeration
1488
- break
1489
- elif enumeration._annotations[annotation] == value:
1490
- reconciled = enumeration
1491
- break
1492
- else:
1493
- raise EnumerationOptionError(
1494
- "The enumeration option, %s, has no '%s' annotation!"
1495
- % (
1496
- enumeration,
1497
- annotation,
1490
+ if len(annotations) > 0:
1491
+ comparisons: list[bool] = []
1492
+
1493
+ for annotation, value in annotations.items():
1494
+ if annotation in enumeration._annotations:
1495
+ if enumeration._annotations[annotation] is value:
1496
+ comparisons.append(True)
1497
+ elif enumeration._annotations[annotation] == value:
1498
+ comparisons.append(True)
1499
+ else:
1500
+ comparisons.append(False)
1501
+ else:
1502
+ comparisons.append(False)
1503
+
1504
+ logger.debug(
1505
+ "The enumeration option, %s, has no '%s' annotation!"
1506
+ % (
1507
+ enumeration,
1508
+ annotation,
1509
+ )
1498
1510
  )
1499
- )
1511
+
1512
+ if len(comparisons) == len(annotations) and False not in comparisons:
1513
+ reconciled = enumeration
1514
+ break
1500
1515
  elif isinstance(value, Enumeration):
1501
1516
  if enumeration is value:
1502
1517
  reconciled = enumeration
@@ -0,0 +1 @@
1
+ 1.0.8
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: enumerific
3
- Version: 1.0.7
3
+ Version: 1.0.8
4
4
  Summary: Simplifies working with Python enums.
5
5
  Author: Daniel Sissman
6
6
  License-Expression: MIT
@@ -690,8 +690,8 @@ class Colors(Enumeration):
690
690
  # Ensure that the Colors enumeration subclass is of the expected types
691
691
  assert issubclass(Colors, Enumeration)
692
692
 
693
- # Attempt to reconcile a Color against one of its annotations
694
- color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
693
+ # Attempt to reconcile a Color against one of its annotations (via annotation keyword)
694
+ color = Colors.reconcile(RGB=(255, 0, 0))
695
695
 
696
696
  assert isinstance(color, Colors)
697
697
  assert isinstance(color, Enumeration)
@@ -699,6 +699,16 @@ assert isinstance(color, Enumeration)
699
699
  assert color.name == "RED"
700
700
  assert color.value == 1
701
701
  assert color.RGB == (255, 0, 0)
702
+
703
+ # Attempt to reconcile a Color against one of its annotations (via annotation argument)
704
+ color = Colors.reconcile(value=(0, 255, 0), annotation="RGB")
705
+
706
+ assert isinstance(color, Colors)
707
+ assert isinstance(color, Enumeration)
708
+
709
+ assert color.name == "GREEN"
710
+ assert color.value == 2
711
+ assert color.RGB == (0, 255, 0)
702
712
  ```
703
713
 
704
714
  # Enumerific Library Enumerations: Classes & Methods
@@ -1820,24 +1820,49 @@ def test_annotation_reconciliation():
1820
1820
  class Colors(Enumeration):
1821
1821
  """Create a test Color enumeration based on the Enumeration class"""
1822
1822
 
1823
- RED = auto(RGB=(255, 0, 0))
1823
+ RED = auto(RGB=(255, 0, 0), primary=True)
1824
1824
  ORANGE = auto(RGB=(255, 165, 0))
1825
- YELLOW = auto(RGB=(255, 255, 0))
1825
+ YELLOW = auto(RGB=(255, 255, 0), primary=True)
1826
1826
  GREEN = auto(RGB=(0, 255, 0))
1827
- BLUE = auto(RGB=(0, 0, 255))
1827
+ BLUE = auto(RGB=(0, 0, 255), primary=True)
1828
1828
  VIOLET = auto(RGB=(255, 0, 255))
1829
1829
 
1830
1830
  # Ensure that the Colors enumeration subclass is of the expected types
1831
1831
  assert issubclass(Colors, Enumeration)
1832
1832
  assert issubclass(Colors, EnumerationInteger)
1833
1833
 
1834
- # Attempt to reconcile a Color against one of its annotations
1835
- color = Colors.reconcile(value=(255, 0, 0), annotation="RGB")
1834
+ # Attempt to reconcile a Color against one of its annotations (via annotation keyword)
1835
+ color = Colors.reconcile(RGB=(255, 0, 0))
1836
1836
 
1837
1837
  assert isinstance(color, Colors)
1838
1838
  assert isinstance(color, Enumeration)
1839
- assert isinstance(color, EnumerationInteger)
1840
1839
 
1841
1840
  assert color.name == "RED"
1842
1841
  assert color.value == 1
1843
1842
  assert color.RGB == (255, 0, 0)
1843
+
1844
+ # Attempt to reconcile a Color against two of its annotations (via annotation keywords)
1845
+ color = Colors.reconcile(RGB=(255, 255, 0), primary=True)
1846
+
1847
+ assert isinstance(color, Colors)
1848
+ assert isinstance(color, Enumeration)
1849
+
1850
+ assert color.name == "YELLOW"
1851
+ assert color.value == 3
1852
+ assert color.RGB == (255, 255, 0)
1853
+
1854
+ # Attempt to reconcile a Color against one of its annotations (via annotation argument)
1855
+ color = Colors.reconcile(value=(0, 255, 0), annotation="RGB")
1856
+
1857
+ assert isinstance(color, Colors)
1858
+ assert isinstance(color, Enumeration)
1859
+
1860
+ assert color.name == "GREEN"
1861
+ assert color.value == 4
1862
+ assert color.RGB == (0, 255, 0)
1863
+
1864
+ # Test reconciliation against a non-existent option
1865
+ color = Colors.reconcile(RGB=(125, 125, 125))
1866
+
1867
+ # Ensure the return value is None when a matching enumeration option cannot be found
1868
+ assert color is None
@@ -1 +0,0 @@
1
- 1.0.7
File without changes
File without changes
File without changes
File without changes