Adds fix for refed properties with invalid names (#26)

* Adds fix for refed properties with invalid names

* Adds Object with refed from property

* Adds !reference property

* Adds test_instantiation_success + test_omitting_required_properties_fails

Author: spacether

modules/openapi-json-schema-generator/src/main/resources/python/model_templates/composed_schemas.handlebars

@@ -99,7 +99,7 @@ def any_of(cls):
 {{#if complexType}}
 
 @staticmethod
-def {{baseName}}() -> typing.Type['{{complexType}}']:
+def {{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}() -> typing.Type['{{complexType}}']:
     return {{complexType}}
 {{else}}
 {{> model_templates/schema }}

modules/openapi-json-schema-generator/src/main/resources/python/model_templates/dict_partial.handlebars

@@ -30,7 +30,7 @@ class properties:
 {{#if complexType}}
 
     @staticmethod
-    def {{baseName}}() -> typing.Type['{{complexType}}']:
+    def {{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}() -> typing.Type['{{complexType}}']:
         return {{complexType}}
 {{else}}
     {{> model_templates/schema }}

modules/openapi-json-schema-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml

@@ -2941,4 +2941,21 @@ components:
         double:
           format: double
         float:
-          format: float
+          format: float
+    FromSchema:
+      type: object
+      properties:
+        data:
+          type: string
+        id:
+          type: integer
+    ObjectWithInvalidNamedRefedProperties:
+      type: object
+      properties:
+        from:
+          $ref: "#/components/schemas/FromSchema"
+        "!reference":
+          $ref: "#/components/schemas/ArrayWithValidationsInItems"
+      required:
+        - from
+        - "!reference"

samples/openapi3/client/petstore/python/.openapi-generator/FILES

@@ -63,6 +63,7 @@ docs/models/File.md
 docs/models/FileSchemaTestClass.md
 docs/models/Foo.md
 docs/models/FormatTest.md
+docs/models/FromSchema.md
 docs/models/Fruit.md
 docs/models/FruitReq.md
 docs/models/GmFruit.md
@@ -99,6 +100,7 @@ docs/models/ObjectModelWithRefProps.md
 docs/models/ObjectWithDecimalProperties.md
 docs/models/ObjectWithDifficultlyNamedProps.md
 docs/models/ObjectWithInlineCompositionProperty.md
+docs/models/ObjectWithInvalidNamedRefedProperties.md
 docs/models/ObjectWithValidations.md
 docs/models/Order.md
 docs/models/ParentPet.md
@@ -248,6 +250,8 @@ petstore_api/model/foo.py
 petstore_api/model/foo.pyi
 petstore_api/model/format_test.py
 petstore_api/model/format_test.pyi
+petstore_api/model/from_schema.py
+petstore_api/model/from_schema.pyi
 petstore_api/model/fruit.py
 petstore_api/model/fruit.pyi
 petstore_api/model/fruit_req.py
@@ -320,6 +324,8 @@ petstore_api/model/object_with_difficultly_named_props.py
 petstore_api/model/object_with_difficultly_named_props.pyi
 petstore_api/model/object_with_inline_composition_property.py
 petstore_api/model/object_with_inline_composition_property.pyi
+petstore_api/model/object_with_invalid_named_refed_properties.py
+petstore_api/model/object_with_invalid_named_refed_properties.pyi
 petstore_api/model/object_with_validations.py
 petstore_api/model/object_with_validations.pyi
 petstore_api/model/order.py

samples/openapi3/client/petstore/python/README.md

@@ -284,6 +284,7 @@ Class | Method | HTTP request | Description
  - [FileSchemaTestClass](docs/models/FileSchemaTestClass.md)
  - [Foo](docs/models/Foo.md)
  - [FormatTest](docs/models/FormatTest.md)
+ - [FromSchema](docs/models/FromSchema.md)
  - [Fruit](docs/models/Fruit.md)
  - [FruitReq](docs/models/FruitReq.md)
  - [GmFruit](docs/models/GmFruit.md)
@@ -320,6 +321,7 @@ Class | Method | HTTP request | Description
  - [ObjectWithDecimalProperties](docs/models/ObjectWithDecimalProperties.md)
  - [ObjectWithDifficultlyNamedProps](docs/models/ObjectWithDifficultlyNamedProps.md)
  - [ObjectWithInlineCompositionProperty](docs/models/ObjectWithInlineCompositionProperty.md)
+ - [ObjectWithInvalidNamedRefedProperties](docs/models/ObjectWithInvalidNamedRefedProperties.md)
  - [ObjectWithValidations](docs/models/ObjectWithValidations.md)
  - [Order](docs/models/Order.md)
  - [ParentPet](docs/models/ParentPet.md)

samples/openapi3/client/petstore/python/docs/models/FromSchema.md

@@ -0,0 +1,16 @@
+# petstore_api.model.from_schema.FromSchema
+
+## Model Type Info
+Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+dict, frozendict.frozendict,  | frozendict.frozendict,  |  | 
+
+### Dictionary Keys
+Key | Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | ------------- | -------------
+**data** | str,  | str,  |  | [optional] 
+**id** | decimal.Decimal, int,  | decimal.Decimal,  |  | [optional] 
+**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+

samples/openapi3/client/petstore/python/docs/models/ObjectWithInvalidNamedRefedProperties.md

@@ -0,0 +1,16 @@
+# petstore_api.model.object_with_invalid_named_refed_properties.ObjectWithInvalidNamedRefedProperties
+
+## Model Type Info
+Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+dict, frozendict.frozendict,  | frozendict.frozendict,  |  | 
+
+### Dictionary Keys
+Key | Input Type | Accessed Type | Description | Notes
+------------ | ------------- | ------------- | ------------- | -------------
+**!reference** | [**ArrayWithValidationsInItems**](ArrayWithValidationsInItems.md) | [**ArrayWithValidationsInItems**](ArrayWithValidationsInItems.md) |  | 
+**from** | [**FromSchema**](FromSchema.md) | [**FromSchema**](FromSchema.md) |  | 
+**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+

samples/openapi3/client/petstore/python/petstore_api/model/from_schema.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from petstore_api import schemas  # noqa: F401
+
+
+class FromSchema(
+    schemas.DictSchema
+):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+
+    class MetaOapg:
+        
+        class properties:
+            data = schemas.StrSchema
+            id = schemas.IntSchema
+            __annotations__ = {
+                "data": data,
+                "id": id,
+            }
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ...
+    
+    @typing.overload
+    def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
+    
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "id", ], str]):
+        # dict_instance[name] accessor
+        return super().__getitem__(name)
+    
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> typing.Union[MetaOapg.properties.data, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
+    
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "id", ], str]):
+        return super().get_item_oapg(name)
+    
+
+    def __new__(
+        cls,
+        *args: typing.Union[dict, frozendict.frozendict, ],
+        data: typing.Union[MetaOapg.properties.data, str, schemas.Unset] = schemas.unset,
+        id: typing.Union[MetaOapg.properties.id, decimal.Decimal, int, schemas.Unset] = schemas.unset,
+        _configuration: typing.Optional[schemas.Configuration] = None,
+        **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
+    ) -> 'FromSchema':
+        return super().__new__(
+            cls,
+            *args,
+            data=data,
+            id=id,
+            _configuration=_configuration,
+            **kwargs,
+        )

samples/openapi3/client/petstore/python/petstore_api/model/from_schema.pyi

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  # noqa: E501
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by: https://openapi-generator.tech
+"""
+
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+
+import frozendict  # noqa: F401
+
+from petstore_api import schemas  # noqa: F401
+
+
+class FromSchema(
+    schemas.DictSchema
+):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+
+    class MetaOapg:
+        
+        class properties:
+            data = schemas.StrSchema
+            id = schemas.IntSchema
+            __annotations__ = {
+                "data": data,
+                "id": id,
+            }
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["data"]) -> MetaOapg.properties.data: ...
+    
+    @typing.overload
+    def __getitem__(self, name: typing_extensions.Literal["id"]) -> MetaOapg.properties.id: ...
+    
+    @typing.overload
+    def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
+    
+    def __getitem__(self, name: typing.Union[typing_extensions.Literal["data", "id", ], str]):
+        # dict_instance[name] accessor
+        return super().__getitem__(name)
+    
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["data"]) -> typing.Union[MetaOapg.properties.data, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: typing_extensions.Literal["id"]) -> typing.Union[MetaOapg.properties.id, schemas.Unset]: ...
+    
+    @typing.overload
+    def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
+    
+    def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["data", "id", ], str]):
+        return super().get_item_oapg(name)
+    
+
+    def __new__(
+        cls,
+        *args: typing.Union[dict, frozendict.frozendict, ],
+        data: typing.Union[MetaOapg.properties.data, str, schemas.Unset] = schemas.unset,
+        id: typing.Union[MetaOapg.properties.id, decimal.Decimal, int, schemas.Unset] = schemas.unset,
+        _configuration: typing.Optional[schemas.Configuration] = None,
+        **kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
+    ) -> 'FromSchema':
+        return super().__new__(
+            cls,
+            *args,
+            data=data,
+            id=id,
+            _configuration=_configuration,
+            **kwargs,
+        )