v3 improves enums (#188)

* Adds int and str enum literal outputs

* Adds enum literal outputs when possible

Author: spacether

modules/openapi-json-schema-generator/src/main/resources/python/components/schemas/_helper_enum_class.hbs

@@ -6,15 +6,15 @@ class {{enumInfo.valueToName.jsonPathPiece.camelCase}}:
 
     @schemas.classproperty
         {{#eq @key.type "string"}}
-    def {{this}}(cls) -> str:
+    def {{this}}(cls) -> typing_extensions.Literal["{{{@key.value}}}"]:
         return {{jsonPathPiece.camelCase}}.validate("{{{@key.value}}}")
         {{/eq}}
         {{#eq @key.type "number"}}
     def {{this}}(cls) -> typing.Union[int, float]:
         return {{jsonPathPiece.camelCase}}.validate({{{@key.value}}})
         {{/eq}}
         {{#eq @key.type "integer"}}
-    def {{this}}(cls) -> int:
+    def {{this}}(cls) -> typing_extensions.Literal[{{{@key.value}}}]:
         return {{jsonPathPiece.camelCase}}.validate({{{@key.value}}})
         {{/eq}}
         {{#eq @key.type "boolean"}}

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enum_with0_does_not_match_false.py

@@ -15,7 +15,7 @@
 class EnumWith0DoesNotMatchFalseEnums:
 
     @schemas.classproperty
-    def POSITIVE_0(cls) -> int:
+    def POSITIVE_0(cls) -> typing_extensions.Literal[0]:
         return EnumWith0DoesNotMatchFalse.validate(0)
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enum_with1_does_not_match_true.py

@@ -15,7 +15,7 @@
 class EnumWith1DoesNotMatchTrueEnums:
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return EnumWith1DoesNotMatchTrue.validate(1)
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enum_with_escaped_characters.py

@@ -15,11 +15,11 @@
 class EnumWithEscapedCharactersEnums:
 
     @schemas.classproperty
-    def FOO_LINE_FEED_LF_BAR(cls) -> str:
+    def FOO_LINE_FEED_LF_BAR(cls) -> typing_extensions.Literal["foo\nbar"]:
         return EnumWithEscapedCharacters.validate("foo\nbar")
 
     @schemas.classproperty
-    def FOO_CARRIAGE_RETURN_CR_BAR(cls) -> str:
+    def FOO_CARRIAGE_RETURN_CR_BAR(cls) -> typing_extensions.Literal["foo\rbar"]:
         return EnumWithEscapedCharacters.validate("foo\rbar")
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/enums_in_properties.py

@@ -15,7 +15,7 @@
 class FooEnums:
 
     @schemas.classproperty
-    def FOO(cls) -> str:
+    def FOO(cls) -> typing_extensions.Literal["foo"]:
         return Foo.validate("foo")
 
 
@@ -69,7 +69,7 @@ def validate(
 class BarEnums:
 
     @schemas.classproperty
-    def BAR(cls) -> str:
+    def BAR(cls) -> typing_extensions.Literal["bar"]:
         return Bar.validate("bar")
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/nul_characters_in_strings.py

@@ -15,7 +15,7 @@
 class NulCharactersInStringsEnums:
 
     @schemas.classproperty
-    def HELLO_NULL_THERE(cls) -> str:
+    def HELLO_NULL_THERE(cls) -> typing_extensions.Literal["hello\x00there"]:
         return NulCharactersInStrings.validate("hello\x00there")
 
 

samples/openapi3/client/3_0_3_unit_test/python/src/unit_test_api/components/schema/simple_enum_validation.py

@@ -15,15 +15,15 @@
 class SimpleEnumValidationEnums:
 
     @schemas.classproperty
-    def POSITIVE_1(cls) -> int:
+    def POSITIVE_1(cls) -> typing_extensions.Literal[1]:
         return SimpleEnumValidation.validate(1)
 
     @schemas.classproperty
-    def POSITIVE_2(cls) -> int:
+    def POSITIVE_2(cls) -> typing_extensions.Literal[2]:
         return SimpleEnumValidation.validate(2)
 
     @schemas.classproperty
-    def POSITIVE_3(cls) -> int:
+    def POSITIVE_3(cls) -> typing_extensions.Literal[3]:
         return SimpleEnumValidation.validate(3)
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/basque_pig.py

@@ -15,7 +15,7 @@
 class ClassNameEnums:
 
     @schemas.classproperty
-    def BASQUE_PIG(cls) -> str:
+    def BASQUE_PIG(cls) -> typing_extensions.Literal["BasquePig"]:
         return ClassName.validate("BasquePig")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/complex_quadrilateral.py

@@ -15,7 +15,7 @@
 class QuadrilateralTypeEnums:
 
     @schemas.classproperty
-    def COMPLEX_QUADRILATERAL(cls) -> str:
+    def COMPLEX_QUADRILATERAL(cls) -> typing_extensions.Literal["ComplexQuadrilateral"]:
         return QuadrilateralType.validate("ComplexQuadrilateral")
 
 

samples/openapi3/client/petstore/python/src/petstore_api/components/schema/currency.py

@@ -15,11 +15,11 @@
 class CurrencyEnums:
 
     @schemas.classproperty
-    def EUR(cls) -> str:
+    def EUR(cls) -> typing_extensions.Literal["eur"]:
         return Currency.validate("eur")
 
     @schemas.classproperty
-    def USD(cls) -> str:
+    def USD(cls) -> typing_extensions.Literal["usd"]:
         return Currency.validate("usd")