Merge pull request #225 from nekitmish/fix-strenum-type-inspection

Inspect StrEnum as an Enum, not string

Author: pristupa

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "winter"
-version = "9.6.3"
+version = "9.6.4"
 homepage = "https://github.com/WinterFramework/winter"
 description = "Web Framework inspired by Spring Framework"
 authors = ["Alexander Egorov <[email protected]>"]
@@ -42,6 +42,7 @@ python-dateutil = "2.8.0"
 injector = "0.15.0"
 SQLAlchemy = "~=1.3"
 typing-extensions = "^3.10.0"
+StrEnum = "^0.4.8"
 
 [tool.poetry.dev-dependencies]
 codecov = ">=2.0.9"

pyproject.toml

@@ -4,6 +4,7 @@
 from dataclasses import dataclass
 from enum import Enum
 from enum import IntEnum
+from enum import auto
 from typing import Any
 from typing import Generic
 from typing import List
@@ -14,6 +15,7 @@
 
 import pytest
 from drf_yasg import openapi
+from strenum import StrEnum
 
 from winter.core.utils import TypeWrapper
 from winter.data.pagination import Page
@@ -51,6 +53,11 @@ class StringValueEnum(Enum):
     GREEN = 'green'
 
 
+class StringEnum(StrEnum):
+    RED = auto()
+    GREEN = auto()
+
+
 class MixedValueEnum(Enum):
     RED = 123
     GREEN = 'green'
@@ -90,6 +97,7 @@ class CustomPage(Page, Generic[CustomPageItem]):
     (IntegerEnum, TypeInfo(openapi.TYPE_INTEGER, enum=[1, 2])),
     (IntegerValueEnum, TypeInfo(openapi.TYPE_INTEGER, enum=[1, 2])),
     (StringValueEnum, TypeInfo(openapi.TYPE_STRING, enum=['red', 'green'])),
+    (StringEnum, TypeInfo(openapi.TYPE_STRING, enum=['RED', 'GREEN'])),
     (MixedValueEnum, TypeInfo(openapi.TYPE_STRING, enum=[123, 'green'])),
     (List[IntegerValueEnum], TypeInfo(openapi.TYPE_ARRAY, child=TypeInfo(openapi.TYPE_INTEGER, enum=[1, 2]))),
     (List[StringValueEnum], TypeInfo(openapi.TYPE_ARRAY, child=TypeInfo(openapi.TYPE_STRING, enum=['red', 'green']))),

tests/winter_openapi/test_type_inspection.py

@@ -16,6 +16,7 @@
 from typing import Type
 
 from drf_yasg import openapi
+from strenum import StrEnum
 
 from winter.core.utils import has_nested_type
 from winter.core.utils.typing import get_origin_type, get_generic_args
@@ -194,7 +195,7 @@ def inspect_iterable(hint_class) -> TypeInfo:
     return TypeInfo(openapi.TYPE_ARRAY, child=child_type_info)
 
 
-@register_type_inspector(enum.IntEnum, enum.Enum)
+@register_type_inspector(enum.IntEnum, StrEnum, enum.Enum)
 def inspect_enum(enum_class: Type[enum.Enum]) -> TypeInfo:
     enum_values = [entry.value for entry in enum_class]
     # Try to infer type based on enum values