Adds 3.1.0 const feature (#210)

* Adds generation of const enum class and storage of const values in schema

* Writes const info in schema class when a type is defined

* Adds const validator and disableable keyword

* Adds const to the generator docs

* Fixes validation writing for str schema

* Handles constInfo in boolean/string/integer validate overloads

* Fixes validate else conditions

* Another fix to the validate template for enums

* Fixes literal casting using constInfo in validate

* Stops using type in validate method, uses types instead

* Refactors enumInfo for validate return type to be simpler

* Fixes validate templete for constInfo

* Sequence fixes in schema.py and schemas.py

* Adds and uses SequenceNotStr

* Fixes typo

* Adds tests of const

* Samples regen

* Samples regenerated

Author: spacether

docs/generators/java.md

@@ -316,6 +316,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3

docs/generators/jaxrs-jersey.md

@@ -299,6 +299,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3

docs/generators/jmeter.md

@@ -158,6 +158,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3

docs/generators/kotlin.md

@@ -268,6 +268,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✗|OAS2,OAS3
 |AllOf|✗|OAS2,OAS3
 |AnyOf|✗|OAS3
+|Const|✗|OAS3
 |Contains|✗|OAS3
 |Default|✗|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3

docs/generators/python.md

@@ -227,6 +227,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |AdditionalProperties|✓|OAS2,OAS3
 |AllOf|✓|OAS2,OAS3
 |AnyOf|✓|OAS3
+|Const|✓|OAS3
 |Contains|✓|OAS3
 |Default|✓|OAS2,OAS3
 |Discriminator|✓|OAS2,OAS3

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

@@ -25,7 +25,7 @@ def FOO_CARRIAGE_RETURN_CR_BAR(cls) -> typing.Literal["foo\rbar"]:
 
 @dataclasses.dataclass(frozen=True)
 class EnumWithEscapedCharacters(
-    schemas.Schema[schemas.immutabledict, str]
+    schemas.Schema
 ):
     """NOTE: This class is auto generated by OpenAPI JSON Schema Generator.
     Ref: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator

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

@@ -21,7 +21,7 @@ def FOO(cls) -> typing.Literal["foo"]:
 
 @dataclasses.dataclass(frozen=True)
 class Foo(
-    schemas.Schema[schemas.immutabledict, str]
+    schemas.Schema
 ):
     types: typing.FrozenSet[typing.Type] = frozenset({
         str,
@@ -75,7 +75,7 @@ def BAR(cls) -> typing.Literal["bar"]:
 
 @dataclasses.dataclass(frozen=True)
 class Bar(
-    schemas.Schema[schemas.immutabledict, str]
+    schemas.Schema
 ):
     types: typing.FrozenSet[typing.Type] = frozenset({
         str,

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

@@ -21,7 +21,7 @@ def HELLO_NULL_THERE(cls) -> typing.Literal["hello\x00there"]:
 
 @dataclasses.dataclass(frozen=True)
 class NulCharactersInStrings(
-    schemas.Schema[schemas.immutabledict, str]
+    schemas.Schema
 ):
     """NOTE: This class is auto generated by OpenAPI JSON Schema Generator.
     Ref: https://github.com/openapi-json-schema-tools/openapi-json-schema-generator

samples/client/3_0_3_unit_test/python/src/unit_test_api/configurations/schema_configuration.py

@@ -16,6 +16,7 @@
     'additional_properties': 'additionalProperties',
     'all_of': 'allOf',
     'any_of': 'anyOf',
+    'const_value_to_name': 'const',
     'contains': 'contains',
     'discriminator': 'discriminator',
     # default omitted because it has no validation impact

samples/client/3_0_3_unit_test/python/src/unit_test_api/schemas/schema.py

@@ -14,9 +14,33 @@
 
 from . import validation
 
+_T_co = typing.TypeVar("_T_co", covariant=True)
+
+
+class SequenceNotStr(typing.Protocol[_T_co]):
+    """
+    if a Protocol would define the interface of Sequence, this protocol
+    would NOT allow str/bytes as their __contains__ methods are incompatible with the definition in Sequence
+    methods from: https://docs.python.org/3/library/collections.abc.html#collections.abc.Collection
+    """
+    def __contains__(self, value: object, /) -> bool:
+        raise NotImplementedError
+
+    def __getitem__(self, index, /):
+        raise NotImplementedError
+
+    def __len__(self) -> int:
+        raise NotImplementedError
+
+    def __iter__(self) -> typing.Iterator[_T_co]:
+        raise NotImplementedError
+
+    def __reversed__(self, /) -> typing.Iterator[_T_co]:
+        raise NotImplementedError
+
 none_type_ = type(None)
 T = typing.TypeVar('T', bound=typing.Mapping)
-U = typing.TypeVar('U', bound=typing.Sequence)
+U = typing.TypeVar('U', bound=SequenceNotStr)
 W = typing.TypeVar('W')
 
 
@@ -439,15 +463,15 @@ def validate_base(
     @classmethod
     def validate_base(
         cls,
-        arg: typing.Union[datetime.date, datetime.datetime, uuid.UUID],
+        arg: typing.Union[str, datetime.date, datetime.datetime, uuid.UUID],
         configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
     ) -> str: ...
 
     @typing.overload
     @classmethod
     def validate_base(
         cls,
-        arg: typing.Sequence[INPUT_TYPES_ALL],  # also covers str, tuple, list, bytes
+        arg: SequenceNotStr[INPUT_TYPES_ALL],
         configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
     ) -> U: ...
 
@@ -486,6 +510,14 @@ def validate_base(
         configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
     ) -> FileIO: ...
 
+    @typing.overload
+    @classmethod
+    def validate_base(
+        cls,
+        arg: bytes,
+        configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
+    ) -> bytes: ...
+
     @classmethod
     def validate_base(
         cls,
@@ -614,15 +646,15 @@ def validate(
     @classmethod
     def validate(
         cls,
-        arg: typing.Union[datetime.date, datetime.datetime, uuid.UUID],
+        arg: typing.Union[str, datetime.date, datetime.datetime, uuid.UUID],
         configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
     ) -> str: ...
 
     @typing.overload
     @classmethod
     def validate(
         cls,
-        arg: typing.Sequence[INPUT_TYPES_ALL],  # also covers str, tuple, list, bytes
+        arg: SequenceNotStr[INPUT_TYPES_ALL],
         configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
     ) -> U: ...
 
@@ -653,6 +685,14 @@ def validate(
         configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
     ) -> FileIO: ...
 
+    @typing.overload
+    @classmethod
+    def validate(
+        cls,
+        arg: bytes,
+        configuration: typing.Optional[schema_configuration.SchemaConfiguration] = None
+    ) -> bytes: ...
+
     @classmethod
     def validate(
         cls,
@@ -668,20 +708,6 @@ class UnsetAnyTypeSchema(AnyTypeSchema[T, U]):
     # Used when additionalProperties/items was not explicitly defined and a defining schema is needed
     pass
 
-INPUT_TYPES_NOT_STR_BYTES_FILE = typing.Union[
-    dict,
-    validation.immutabledict,
-    list,
-    tuple,
-    float,
-    int,
-    datetime.date,
-    datetime.datetime,
-    uuid.UUID,
-    bool,
-    None,
-]
-
 INPUT_TYPES_ALL = typing.Union[
     dict,
     validation.immutabledict,