Akhil Nair e823290c8f
[PYTHON] GetItem not working for Client generated allOf model and broken since 5.2.0 (#12239)
* I feel the issue is due to the creation of self._var_name_to_model_instances while doing the deserialization of the data.

Earlier the Python SDK code was using get_var_name_to_model_instances function which was adding var name to model instances that contain it. So <class 'openapi_client.model.stream_options_all_of'> will not part of mapping in self._var_name_to_model_instances for variable name stream_options.

Now with the latest Python SDK code following is the way through which var_name_to_model_instances is created:

    for prop_name in model_args:
        if prop_name not in discarded_args:
            var_name_to_model_instances[prop_name] = [self] + composed_instances
Now as we can see that the var_name_to_model_instances is populated with self and composed_instance which will also contain stream_options_all_of as a composed instance and there will be no check that if stream_options is present in composed_instances or not.

As there is no attribute_mapping found for stream_options in stream_options_all_of, the type for stream_options will be treated as dict for mapping stream_options_all_of as mentioned by @Chekov2k.

So what I suggest is the following code:

    for prop_name in model_args:
        if prop_name not in discarded_args:
           var_name_to_model_instances[prop_name] = [self] + list(
                filter(
                    lambda x: prop_name in x.openapi_types, composed_instances))
This way we can check if the property name is present in that composed instance or not. If it's okay for @spacether I can raise a PR for this.

* [get_item_all_of_bug]
Added samples, test cases to validate all_of schema.

* [getiem_all_of_bug]

Updated docs and samples.

* [getiem_all_of_bug]

Updated test cases, docs and samples.
2022-05-27 21:09:48 -07:00

152 lines
4.8 KiB
Python

# 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 __future__ import absolute_import
import sys
import unittest
import petstore_api
try:
from petstore_api.model import animal
except ImportError:
animal = sys.modules[
'petstore_api.model.animal']
try:
from petstore_api.model import dog_all_of
except ImportError:
dog_all_of = sys.modules[
'petstore_api.model.dog_all_of']
from petstore_api.model.dog import Dog
class TestDog(unittest.TestCase):
"""Dog unit test stubs"""
def setUp(self):
pass
def tearDown(self):
pass
def testDog(self):
"""Test Dog"""
# make an instance of dog, a composed schema model
class_name = 'Dog'
color = 'white'
breed = 'Jack Russel Terrier'
dog = Dog(
class_name=class_name,
color=color,
breed=breed
)
# check its properties
self.assertEqual(dog.class_name, class_name)
self.assertEqual(dog.color, color)
self.assertEqual(dog.breed, breed)
# access them with keys
self.assertEqual(dog['class_name'], class_name)
self.assertEqual(dog['color'], color)
self.assertEqual(dog['breed'], breed)
# access them with getattr
self.assertEqual(getattr(dog, 'class_name'), class_name)
self.assertEqual(getattr(dog, 'color'), color)
self.assertEqual(getattr(dog, 'breed'), breed)
# check the model's to_dict result
self.assertEqual(
dog.to_dict(),
{
'class_name': class_name,
'color': color,
'breed': breed,
}
)
# getting a value that doesn't exist raises an exception
# with a key
with self.assertRaises(AttributeError):
invalid_variable = dog['not_here_a']
# with getattr
self.assertEqual(getattr(dog, 'not_here_a', 'some value'), 'some value')
with self.assertRaises(AttributeError):
invalid_variable = getattr(dog, 'not_here_a')
# make sure that the ModelComposed class properties are correct
# model.composed_schemas() stores the anyOf/allOf/oneOf info
self.assertEqual(
dog._composed_schemas,
{
'anyOf': [],
'allOf': [
animal.Animal,
dog_all_of.DogAllOf,
],
'oneOf': [],
}
)
# model._composed_instances is a list of the instances that were
# made from the anyOf/allOf/OneOf classes in model._composed_schemas()
for composed_instance in dog._composed_instances:
if composed_instance.__class__ == animal.Animal:
animal_instance = composed_instance
elif composed_instance.__class__ == dog_all_of.DogAllOf:
dog_allof_instance = composed_instance
self.assertEqual(
dog._composed_instances,
[animal_instance, dog_allof_instance]
)
# model._var_name_to_model_instances maps the variable name to the
# model instances which store that variable
self.assertEqual(
dog._var_name_to_model_instances,
{
'breed': [dog, dog_allof_instance],
'class_name': [dog, animal_instance],
'color': [dog, animal_instance]
}
)
# model._additional_properties_model_instances stores a list of
# models which have the property additional_properties_type != None
self.assertEqual(
dog._additional_properties_model_instances, [dog]
)
# setting a value that doesn't exist works
dog['invalid_variable'] = 'a'
assert dog.invalid_variable == 'a'
# with setattr
setattr(dog, 'invalid_variable', 'b')
assert dog.invalid_variable == 'b'
# if we modify one of the properties owned by multiple
# model_instances we get an exception when we try to access that
# property because the retrieved values are not all the same
dog_allof_instance.breed = 'Golden Retriever'
with self.assertRaises(petstore_api.ApiValueError):
breed = dog.breed
# including extra parameters works
dog = Dog(
class_name=class_name,
color=color,
breed=breed,
unknown_property='some value'
)
assert dog.unknown_property == 'some value'
if __name__ == '__main__':
unittest.main()