paddle-php-sdk PR# 35 PaddleEnum (in our case, PaddleStrEnum)

Author: Invincibear

paddle_billing/PaddleStrEnum.py

@@ -0,0 +1,43 @@
+from enum import EnumMeta, StrEnum
+
+from paddle_billing.Undefined import Undefined
+
+
+def _is_dunder(name):  # Copied from enum.py because IDE complains when calling protected class super()._is_dunder
+    """
+    Returns True if a __dunder__ name, False otherwise.
+    """
+    return (
+            len(name) > 4 and
+            name[:2] == name[-2:] == '__' and
+            name[2] != '_' and
+            name[-3] != '_'
+    )
+
+
+
+class PaddleStrEnumMeta(EnumMeta):
+    """
+    Returns Undefined() by default when a property doesn't exist
+    This provides some flexibility for the SDK to handle Paddle adding new properties to their APIspec
+    """
+
+    def __getattr__(cls, name):
+        if _is_dunder(name):
+            raise AttributeError(name)
+
+        try:
+            return super().__getattr__(name)
+        except AttributeError:
+            return Undefined()
+
+
+
+class PaddleStrEnum(StrEnum, metaclass=PaddleStrEnumMeta):
+    """
+    Subclass of StrEnum but uses PaddleStrEnumMeta metaclass to set Undefined() value to undefined enum keys
+    """
+
+    @classmethod
+    def is_known(cls) -> bool:
+        """Not yet implemented"""

paddle_billing/StrEnumFromValue.py

@@ -1,3 +1,4 @@
+# The order of these three imports matters
 from paddle_billing.Environment import Environment
 from paddle_billing.Options     import Options
 from paddle_billing.Client      import Client

paddle_billing/__init__.py

@@ -0,0 +1,43 @@
+from dataclasses import asdict, dataclass, is_dataclass
+
+from paddle_billing.PaddleStrEnum import PaddleStrEnum
+from paddle_billing.Undefined     import Undefined
+
+
+
+def test_paddle_str_enum_works_as_expected():
+    class TestCountryCodesEnum(PaddleStrEnum):
+        CA = 'canada'
+        US = 'usa'
+
+
+    assert isinstance(TestCountryCodesEnum.CA, PaddleStrEnum)
+    assert isinstance(TestCountryCodesEnum.US, PaddleStrEnum)
+    assert TestCountryCodesEnum.CA == 'canada'
+    assert TestCountryCodesEnum.US == 'usa'
+    assert TestCountryCodesEnum('canada') == 'canada'
+    assert TestCountryCodesEnum('usa')    == 'usa'
+
+
+
+def test_dataclass_asdict_returns_expected_paddle_str_enum_value():
+    class TestCountryCodesEnum(PaddleStrEnum):
+        CA = 'canada'
+        US = 'usa'
+
+
+    @dataclass
+    class TestDataclass:
+        country_code: TestCountryCodesEnum | Undefined = Undefined()
+
+        def get_parameters(self) -> dict:
+            return asdict(self)
+
+
+    test_dataclass = TestDataclass(TestCountryCodesEnum.CA)
+
+    assert is_dataclass(test_dataclass)
+    assert isinstance(test_dataclass.get_parameters(), dict)
+    assert test_dataclass.get_parameters().get('country_code', None) is not None
+    assert type(test_dataclass.get_parameters().get('country_code', None)) == TestCountryCodesEnum
+    assert test_dataclass.get_parameters().get('country_code', None) == 'canada'