Fixes issue 171, fixes required property access

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

@@ -1,19 +1,30 @@
 {{#if requiredProperties}}
-
     {{#each requiredProperties}}
         {{#if @key.isValid}}
             {{#with this}}
                 {{#if refInfo.refClass}}
-{{@key.original}}: '{{> components/schemas/_helper_refclass_with_module }}'
+
+@property
+def {{@key.original}}(self) -> '{{> components/schemas/_helper_refclass_with_module }}':
+    return self.__getitem__("{{{@key.original}}}")
                 {{else}}
                     {{#if jsonPathPiece}}
                         {{#if schemaIsFromAdditionalProperties}}
-{{@key.original}}: Schema_.{{jsonPathPiece.camelCase}}
+
+@property
+def {{@key.original}}(self) -> Schema_.{{jsonPathPiece.camelCase}}:
+    return self.__getitem__("{{{@key.original}}}")
                         {{else}}
-{{@key.original}}: Schema_.Properties.{{jsonPathPiece.camelCase}}
+
+@property
+def {{@key.original}}(self) -> Schema_.Properties.{{jsonPathPiece.camelCase}}:
+    return self.__getitem__("{{{@key.original}}}")
                         {{/if}}
                     {{else}}
-{{@key.original}}: schemas.AnyTypeSchema
+
+@property
+def {{@key.original}}(self) -> schemas.AnyTypeSchema:
+    return self.__getitem__("{{{@key.original}}}")
                     {{/if}}
                 {{/if}}
             {{/with}}

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

@@ -2004,22 +2004,6 @@ class DictBase:
         if not isinstance(self, FileIO):
             raise AttributeError('property setting not supported on immutable instances')
 
-    def __getattr__(self, name: str):
-        """
-        for instance.name access
-        Properties are only type hinted for required properties
-        so that hasattr(instance, 'optionalProp') is False when that key is not present
-        """
-        if not isinstance(self, frozendict.frozendict):
-            return super().__getattr__(name)
-        if name not in self.__class__.__annotations__:
-            raise AttributeError(f"{self} has no attribute '{name}'")
-        try:
-            value = self[name]
-            return value
-        except KeyError as ex:
-            raise AttributeError(str(ex))
-
     def get_item_(self, name: str) -> typing.Union['AnyTypeSchema', Unset]:
         # dict_instance[name] accessor
         if not isinstance(self, frozendict.frozendict):

modules/openapi-json-schema-generator/src/test/resources/3_0/python/petstore_customized.yaml

@@ -3273,4 +3273,20 @@ components:
     SelfReferencingArrayModel:
       type: array
       items:
-        $ref: '#/components/schemas/SelfReferencingArrayModel'
+        $ref: '#/components/schemas/SelfReferencingArrayModel'
+    ObjWithRequiredPropsBase:
+      type: object
+      properties:
+        b:
+          type: string
+      required:
+        - b
+    ObjWithRequiredProps:
+      type: object
+      properties:
+        a:
+          type: string
+      required:
+        - a
+      allOf:
+        - $ref: '#/components/schemas/ObjWithRequiredPropsBase'

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

@@ -57,7 +57,9 @@ class Properties:
                         }
 
 
-                bar: Schema_.Properties.Bar
+                @property
+                def bar(self) -> Schema_.Properties.Bar:
+                    return self.__getitem__("bar")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["bar"]) -> Schema_.Properties.Bar: ...
@@ -122,7 +124,9 @@ class Properties:
                         }
 
 
-                foo: Schema_.Properties.Foo
+                @property
+                def foo(self) -> Schema_.Properties.Foo:
+                    return self.__getitem__("foo")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["foo"]) -> Schema_.Properties.Foo: ...

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

@@ -66,7 +66,9 @@ class Properties:
                         }
 
 
-                foo: Schema_.Properties.Foo
+                @property
+                def foo(self) -> Schema_.Properties.Foo:
+                    return self.__getitem__("foo")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["foo"]) -> Schema_.Properties.Foo: ...
@@ -131,7 +133,9 @@ class Properties:
                         }
 
 
-                baz: Schema_.Properties.Baz
+                @property
+                def baz(self) -> Schema_.Properties.Baz:
+                    return self.__getitem__("baz")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["baz"]) -> Schema_.Properties.Baz: ...
@@ -182,7 +186,9 @@ def __new__(
             ]
 
 
-    bar: Schema_.Properties.Bar
+    @property
+    def bar(self) -> Schema_.Properties.Bar:
+        return self.__getitem__("bar")
 
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["bar"]) -> Schema_.Properties.Bar: ...

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

@@ -57,7 +57,9 @@ class Properties:
                         }
 
 
-                bar: Schema_.Properties.Bar
+                @property
+                def bar(self) -> Schema_.Properties.Bar:
+                    return self.__getitem__("bar")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["bar"]) -> Schema_.Properties.Bar: ...
@@ -122,7 +124,9 @@ class Properties:
                         }
 
 
-                foo: Schema_.Properties.Foo
+                @property
+                def foo(self) -> Schema_.Properties.Foo:
+                    return self.__getitem__("foo")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["foo"]) -> Schema_.Properties.Foo: ...

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

@@ -81,7 +81,9 @@ def BAR(cls):
                 "bar": Bar,
             }
 
-    bar: Schema_.Properties.Bar
+    @property
+    def bar(self) -> Schema_.Properties.Bar:
+        return self.__getitem__("bar")
 
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["bar"]) -> Schema_.Properties.Bar: ...

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

@@ -57,7 +57,9 @@ class Properties:
                         }
 
 
-                bar: Schema_.Properties.Bar
+                @property
+                def bar(self) -> Schema_.Properties.Bar:
+                    return self.__getitem__("bar")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["bar"]) -> Schema_.Properties.Bar: ...
@@ -122,7 +124,9 @@ class Properties:
                         }
 
 
-                foo: Schema_.Properties.Foo
+                @property
+                def foo(self) -> Schema_.Properties.Foo:
+                    return self.__getitem__("foo")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["foo"]) -> Schema_.Properties.Foo: ...

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

@@ -54,8 +54,13 @@ class Schema_:
                     }
 
 
-                bar: schemas.AnyTypeSchema
-                foo: schemas.AnyTypeSchema
+                @property
+                def bar(self) -> schemas.AnyTypeSchema:
+                    return self.__getitem__("bar")
+
+                @property
+                def foo(self) -> schemas.AnyTypeSchema:
+                    return self.__getitem__("foo")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["bar"]) -> schemas.AnyTypeSchema: ...
@@ -123,8 +128,13 @@ class Schema_:
                     }
 
 
-                baz: schemas.AnyTypeSchema
-                foo: schemas.AnyTypeSchema
+                @property
+                def baz(self) -> schemas.AnyTypeSchema:
+                    return self.__getitem__("baz")
+
+                @property
+                def foo(self) -> schemas.AnyTypeSchema:
+                    return self.__getitem__("foo")
 
                 @typing.overload
                 def __getitem__(self, name: typing_extensions.Literal["baz"]) -> schemas.AnyTypeSchema: ...

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

@@ -48,7 +48,9 @@ class Properties:
             }
 
 
-    foo: Schema_.Properties.Foo
+    @property
+    def foo(self) -> Schema_.Properties.Foo:
+        return self.__getitem__("foo")
 
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["foo"]) -> Schema_.Properties.Foo: ...

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

@@ -45,7 +45,6 @@ class Schema_:
         }
 
 
-
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["foo\tbar"]) -> schemas.AnyTypeSchema: ...
 

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

@@ -1896,22 +1896,6 @@ def __setattr__(self, name: str, value: typing.Any):
         if not isinstance(self, FileIO):
             raise AttributeError('property setting not supported on immutable instances')
 
-    def __getattr__(self, name: str):
-        """
-        for instance.name access
-        Properties are only type hinted for required properties
-        so that hasattr(instance, 'optionalProp') is False when that key is not present
-        """
-        if not isinstance(self, frozendict.frozendict):
-            return super().__getattr__(name)
-        if name not in self.__class__.__annotations__:
-            raise AttributeError(f"{self} has no attribute '{name}'")
-        try:
-            value = self[name]
-            return value
-        except KeyError as ex:
-            raise AttributeError(str(ex))
-
     def get_item_(self, name: str) -> typing.Union['AnyTypeSchema', Unset]:
         # dict_instance[name] accessor
         if not isinstance(self, frozendict.frozendict):

samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/src/this_package/components/schema/addition_operator.py

@@ -63,9 +63,17 @@ class Schema_:
             }
         AdditionalProperties = schemas.NotAnyTypeSchema
 
-    a: Schema_.Properties.A
-    b: Schema_.Properties.B
-    operator_id: Schema_.Properties.OperatorId
+    @property
+    def a(self) -> Schema_.Properties.A:
+        return self.__getitem__("a")
+
+    @property
+    def b(self) -> Schema_.Properties.B:
+        return self.__getitem__("b")
+
+    @property
+    def operator_id(self) -> Schema_.Properties.OperatorId:
+        return self.__getitem__("operator_id")
 
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["a"]) -> Schema_.Properties.A: ...

samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/src/this_package/components/schema/subtraction_operator.py

@@ -63,9 +63,17 @@ class Schema_:
             }
         AdditionalProperties = schemas.NotAnyTypeSchema
 
-    a: Schema_.Properties.A
-    b: Schema_.Properties.B
-    operator_id: Schema_.Properties.OperatorId
+    @property
+    def a(self) -> Schema_.Properties.A:
+        return self.__getitem__("a")
+
+    @property
+    def b(self) -> Schema_.Properties.B:
+        return self.__getitem__("b")
+
+    @property
+    def operator_id(self) -> Schema_.Properties.OperatorId:
+        return self.__getitem__("operator_id")
 
     @typing.overload
     def __getitem__(self, name: typing_extensions.Literal["a"]) -> Schema_.Properties.A: ...

samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/src/this_package/schemas.py

@@ -1972,22 +1972,6 @@ def __setattr__(self, name: str, value: typing.Any):
         if not isinstance(self, FileIO):
             raise AttributeError('property setting not supported on immutable instances')
 
-    def __getattr__(self, name: str):
-        """
-        for instance.name access
-        Properties are only type hinted for required properties
-        so that hasattr(instance, 'optionalProp') is False when that key is not present
-        """
-        if not isinstance(self, frozendict.frozendict):
-            return super().__getattr__(name)
-        if name not in self.__class__.__annotations__:
-            raise AttributeError(f"{self} has no attribute '{name}'")
-        try:
-            value = self[name]
-            return value
-        except KeyError as ex:
-            raise AttributeError(str(ex))
-
     def get_item_(self, name: str) -> typing.Union['AnyTypeSchema', Unset]:
         # dict_instance[name] accessor
         if not isinstance(self, frozendict.frozendict):

samples/openapi3/client/features/security/python/src/this_package/schemas.py

@@ -1896,22 +1896,6 @@ def __setattr__(self, name: str, value: typing.Any):
         if not isinstance(self, FileIO):
             raise AttributeError('property setting not supported on immutable instances')
 
-    def __getattr__(self, name: str):
-        """
-        for instance.name access
-        Properties are only type hinted for required properties
-        so that hasattr(instance, 'optionalProp') is False when that key is not present
-        """
-        if not isinstance(self, frozendict.frozendict):
-            return super().__getattr__(name)
-        if name not in self.__class__.__annotations__:
-            raise AttributeError(f"{self} has no attribute '{name}'")
-        try:
-            value = self[name]
-            return value
-        except KeyError as ex:
-            raise AttributeError(str(ex))
-
     def get_item_(self, name: str) -> typing.Union['AnyTypeSchema', Unset]:
         # dict_instance[name] accessor
         if not isinstance(self, frozendict.frozendict):

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

@@ -117,6 +117,8 @@ docs/components/schema/nullable_string.md
 docs/components/schema/number.md
 docs/components/schema/number_only.md
 docs/components/schema/number_with_validations.md
+docs/components/schema/obj_with_required_props.md
+docs/components/schema/obj_with_required_props_base.md
 docs/components/schema/object_interface.md
 docs/components/schema/object_model_with_arg_and_args_properties.md
 docs/components/schema/object_model_with_ref_props.md
@@ -462,6 +464,8 @@ src/petstore_api/components/schema/nullable_string.py
 src/petstore_api/components/schema/number.py
 src/petstore_api/components/schema/number_only.py
 src/petstore_api/components/schema/number_with_validations.py
+src/petstore_api/components/schema/obj_with_required_props.py
+src/petstore_api/components/schema/obj_with_required_props_base.py
 src/petstore_api/components/schema/object_interface.py
 src/petstore_api/components/schema/object_model_with_arg_and_args_properties.py
 src/petstore_api/components/schema/object_model_with_ref_props.py

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

@@ -353,6 +353,8 @@ Class | Description
 [Number](docs/components/schema/number.md) |
 [NumberOnly](docs/components/schema/number_only.md) |
 [NumberWithValidations](docs/components/schema/number_with_validations.md) |
+[ObjWithRequiredProps](docs/components/schema/obj_with_required_props.md) |
+[ObjWithRequiredPropsBase](docs/components/schema/obj_with_required_props_base.md) |
 [ObjectInterface](docs/components/schema/object_interface.md) |
 [ObjectModelWithArgAndArgsProperties](docs/components/schema/object_model_with_arg_and_args_properties.md) |
 [ObjectModelWithRefProps](docs/components/schema/object_model_with_ref_props.md) | a model that includes properties which should stay primitive (String + Boolean) and one which is defined as a class, NumberWithValidations