Python improved (#5512)

* ignore .vscode

* fixed test case for models requiring mandatory attributes. added deserialize test for enum class

* construct model with mandatory attributes. improve class reflection (e.g. deserialize). disable generated empty model unit test for further FIXME

* rebuilt samples

* FIXME comment

* FIXME comment

* fix deserialization enum test

.gitignore

@@ -23,6 +23,7 @@ packages/
 .pub
 .packages
 .vagrant/
+.vscode/
 
 .settings
 

modules/swagger-codegen/src/main/resources/python/api_client.mustache

@@ -608,16 +608,17 @@ class ApiClient(object):
         :param klass: class literal.
         :return: model object.
         """
-        instance = klass()
-
-        if not instance.swagger_types:
+        if not klass.swagger_types:
             return data
 
-        for attr, attr_type in iteritems(instance.swagger_types):
+        kwargs = {}
+        for attr, attr_type in iteritems(klass.swagger_types):
             if data is not None \
-               and instance.attribute_map[attr] in data \
+               and klass.attribute_map[attr] in data \
                and isinstance(data, (list, dict)):
-                value = data[instance.attribute_map[attr]]
-                setattr(instance, attr, self.__deserialize(value, attr_type))
+                value = data[klass.attribute_map[attr]]
+                kwargs[attr] = self.__deserialize(value, attr_type)
+
+        instance = klass(**kwargs)     
 
         return instance

modules/swagger-codegen/src/main/resources/python/model.mustache

@@ -14,42 +14,50 @@ class {{classname}}(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
-{{#allowableValues}}
 
+{{#allowableValues}}
+    """
+    allowed enum values
+    """
 {{#enumVars}}
     {{name}} = {{{value}}}
 {{/enumVars}}
-
 {{/allowableValues}}
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        {{#vars}}'{{name}}': '{{{datatype}}}'{{#hasMore}},
+        {{/hasMore}}{{/vars}}
+    }
+
+    attribute_map = {
+        {{#vars}}'{{name}}': '{{baseName}}'{{#hasMore}},
+        {{/hasMore}}{{/vars}}
+    }
+
     def __init__(self{{#vars}}, {{name}}={{#defaultValue}}{{{defaultValue}}}{{/defaultValue}}{{^defaultValue}}None{{/defaultValue}}{{/vars}}):
         """
         {{classname}} - a model defined in Swagger
-
-        :param dict swaggerTypes: The key is attribute name
-                                  and the value is attribute type.
-        :param dict attributeMap: The key is attribute name
-                                  and the value is json key in definition.
         """
-        self.swagger_types = {
-            {{#vars}}'{{name}}': '{{{datatype}}}'{{#hasMore}},
-            {{/hasMore}}{{/vars}}
-        }
-
-        self.attribute_map = {
-            {{#vars}}'{{name}}': '{{baseName}}'{{#hasMore}},
-            {{/hasMore}}{{/vars}}
-        }
 
 {{#vars}}
         self._{{name}} = None
 {{/vars}}
 
-        # TODO: let required properties as mandatory parameter in the constructor.
-        #       - to check if required property is not None (e.g. by calling setter)
-        #       - ApiClient.__deserialize_model has to be adapted as well
 {{#vars}}
+{{#required}}
+        self.{{name}} = {{name}}
+{{/required}}
+{{^required}}
         if {{name}} is not None:
           self.{{name}} = {{name}}
+{{/required}}
 {{/vars}}
 
 {{#vars}}

modules/swagger-codegen/src/main/resources/python/model_test.mustache

@@ -28,7 +28,9 @@ class Test{{classname}}(unittest.TestCase):
         """
         Test {{classname}}
         """
-        model = {{packageName}}.models.{{classFilename}}.{{classname}}()
+        # FIXME: construct object with mandatory attributes with example values
+        #model = {{packageName}}.models.{{classFilename}}.{{classname}}()
+        pass
 
 {{/model}}
 {{/models}}

samples/client/petstore/python/petstore_api/api_client.py

@@ -617,16 +617,17 @@ def __deserialize_model(self, data, klass):
         :param klass: class literal.
         :return: model object.
         """
-        instance = klass()
-
-        if not instance.swagger_types:
+        if not klass.swagger_types:
             return data
 
-        for attr, attr_type in iteritems(instance.swagger_types):
+        kwargs = {}
+        for attr, attr_type in iteritems(klass.swagger_types):
             if data is not None \
-               and instance.attribute_map[attr] in data \
+               and klass.attribute_map[attr] in data \
                and isinstance(data, (list, dict)):
-                value = data[instance.attribute_map[attr]]
-                setattr(instance, attr, self.__deserialize(value, attr_type))
+                value = data[klass.attribute_map[attr]]
+                kwargs[attr] = self.__deserialize(value, attr_type)
+
+        instance = klass(**kwargs)     
 
         return instance

samples/client/petstore/python/petstore_api/models/additional_properties_class.py

@@ -21,31 +21,33 @@ class AdditionalPropertiesClass(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
+
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'map_property': 'dict(str, str)',
+        'map_of_map_property': 'dict(str, dict(str, str))'
+    }
+
+    attribute_map = {
+        'map_property': 'map_property',
+        'map_of_map_property': 'map_of_map_property'
+    }
+
     def __init__(self, map_property=None, map_of_map_property=None):
         """
         AdditionalPropertiesClass - a model defined in Swagger
-
-        :param dict swaggerTypes: The key is attribute name
-                                  and the value is attribute type.
-        :param dict attributeMap: The key is attribute name
-                                  and the value is json key in definition.
         """
-        self.swagger_types = {
-            'map_property': 'dict(str, str)',
-            'map_of_map_property': 'dict(str, dict(str, str))'
-        }
-
-        self.attribute_map = {
-            'map_property': 'map_property',
-            'map_of_map_property': 'map_of_map_property'
-        }
 
         self._map_property = None
         self._map_of_map_property = None
 
-        # TODO: let required properties as mandatory parameter in the constructor.
-        #       - to check if required property is not None (e.g. by calling setter)
-        #       - ApiClient.__deserialize_model has to be adapted as well
         if map_property is not None:
           self.map_property = map_property
         if map_of_map_property is not None:

samples/client/petstore/python/petstore_api/models/animal.py

@@ -21,33 +21,34 @@ class Animal(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
+
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'class_name': 'str',
+        'color': 'str'
+    }
+
+    attribute_map = {
+        'class_name': 'className',
+        'color': 'color'
+    }
+
     def __init__(self, class_name=None, color='red'):
         """
         Animal - a model defined in Swagger
-
-        :param dict swaggerTypes: The key is attribute name
-                                  and the value is attribute type.
-        :param dict attributeMap: The key is attribute name
-                                  and the value is json key in definition.
         """
-        self.swagger_types = {
-            'class_name': 'str',
-            'color': 'str'
-        }
-
-        self.attribute_map = {
-            'class_name': 'className',
-            'color': 'color'
-        }
 
         self._class_name = None
         self._color = None
 
-        # TODO: let required properties as mandatory parameter in the constructor.
-        #       - to check if required property is not None (e.g. by calling setter)
-        #       - ApiClient.__deserialize_model has to be adapted as well
-        if class_name is not None:
-          self.class_name = class_name
+        self.class_name = class_name
         if color is not None:
           self.color = color
 

samples/client/petstore/python/petstore_api/models/animal_farm.py

@@ -21,27 +21,29 @@ class AnimalFarm(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
+
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        
+    }
+
+    attribute_map = {
+        
+    }
+
     def __init__(self):
         """
         AnimalFarm - a model defined in Swagger
-
-        :param dict swaggerTypes: The key is attribute name
-                                  and the value is attribute type.
-        :param dict attributeMap: The key is attribute name
-                                  and the value is json key in definition.
         """
-        self.swagger_types = {
-            
-        }
-
-        self.attribute_map = {
-            
-        }
 
 
-        # TODO: let required properties as mandatory parameter in the constructor.
-        #       - to check if required property is not None (e.g. by calling setter)
-        #       - ApiClient.__deserialize_model has to be adapted as well
 
     def to_dict(self):
         """

samples/client/petstore/python/petstore_api/models/api_response.py

@@ -21,34 +21,36 @@ class ApiResponse(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
+
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'code': 'int',
+        'type': 'str',
+        'message': 'str'
+    }
+
+    attribute_map = {
+        'code': 'code',
+        'type': 'type',
+        'message': 'message'
+    }
+
     def __init__(self, code=None, type=None, message=None):
         """
         ApiResponse - a model defined in Swagger
-
-        :param dict swaggerTypes: The key is attribute name
-                                  and the value is attribute type.
-        :param dict attributeMap: The key is attribute name
-                                  and the value is json key in definition.
         """
-        self.swagger_types = {
-            'code': 'int',
-            'type': 'str',
-            'message': 'str'
-        }
-
-        self.attribute_map = {
-            'code': 'code',
-            'type': 'type',
-            'message': 'message'
-        }
 
         self._code = None
         self._type = None
         self._message = None
 
-        # TODO: let required properties as mandatory parameter in the constructor.
-        #       - to check if required property is not None (e.g. by calling setter)
-        #       - ApiClient.__deserialize_model has to be adapted as well
         if code is not None:
           self.code = code
         if type is not None:

samples/client/petstore/python/petstore_api/models/array_of_array_of_number_only.py

@@ -21,28 +21,30 @@ class ArrayOfArrayOfNumberOnly(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
+
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'array_array_number': 'list[list[float]]'
+    }
+
+    attribute_map = {
+        'array_array_number': 'ArrayArrayNumber'
+    }
+
     def __init__(self, array_array_number=None):
         """
         ArrayOfArrayOfNumberOnly - a model defined in Swagger
-
-        :param dict swaggerTypes: The key is attribute name
-                                  and the value is attribute type.
-        :param dict attributeMap: The key is attribute name
-                                  and the value is json key in definition.
         """
-        self.swagger_types = {
-            'array_array_number': 'list[list[float]]'
-        }
-
-        self.attribute_map = {
-            'array_array_number': 'ArrayArrayNumber'
-        }
 
         self._array_array_number = None
 
-        # TODO: let required properties as mandatory parameter in the constructor.
-        #       - to check if required property is not None (e.g. by calling setter)
-        #       - ApiClient.__deserialize_model has to be adapted as well
         if array_array_number is not None:
           self.array_array_number = array_array_number