Refactor python model (#541)

* Refactor models

This refactors models to reduce duplication.

* Some more cleanups

* Regenerate client from commit 7c3089e of spec repo

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev11",
-            "regenerated": "2021-08-06 11:31:17.817652",
-            "spec_repo_commit": "692cbbb"
+            "regenerated": "2021-08-09 09:22:24.096659",
+            "spec_repo_commit": "7c3089e"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev11",
-            "regenerated": "2021-08-06 11:31:51.168390",
-            "spec_repo_commit": "692cbbb"
+            "regenerated": "2021-08-09 09:22:50.599634",
+            "spec_repo_commit": "7c3089e"
         }
     }
 }

.generator/templates/model.mustache

@@ -1,8 +1,5 @@
 {{> partial_header }}
 
-import re  # noqa: F401
-import sys  # noqa: F401
-
 from {{packageName}}.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
@@ -15,10 +12,7 @@ from {{packageName}}.model_utils import (  # noqa: F401
     datetime,
     file_type,
     none_type,
-    validate_get_composed_info,
 )
-from ..model_utils import OpenApiModel
-from {{packageName}}.exceptions import ApiAttributeError
 
 {{#models}}
 {{#model}}

.generator/templates/model_templates/classvars.mustache

@@ -120,12 +120,12 @@
         }
 {{/oneOf}}
 
-    @cached_property
-    def discriminator():
 {{^discriminator}}
-        return None
+    discriminator = None
 {{/discriminator}}
 {{#discriminator}}
+    @cached_property
+    def discriminator():
 {{#mappedModels}}
 {{#-first}}
 {{#imports}}
@@ -142,4 +142,4 @@
         }
         if not val:
             return None
-        return {'{{{discriminatorName}}}': val}{{/discriminator}}
+        return {'{{{discriminatorName}}}': val}{{/discriminator}}

.generator/templates/model_templates/invalid_pos_args.mustache

@@ -1,9 +1 @@
-        if args:
-            raise ApiTypeError(
-                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
-                    args,
-                    self.__class__.__name__,
-                ),
-                path_to_item=_path_to_item,
-                valid_classes=(self.__class__,),
-            )
+        self._check_pos_args(args)

.generator/templates/model_templates/method_from_openapi_data_composed.mustache

@@ -1,57 +1,16 @@
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """{{classname}} - a model defined in OpenAPI
-
-        Keyword Args:
-{{#requiredVars}}
-{{#defaultValue}}
-            {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}}  # noqa: E501
-{{/defaultValue}}
-{{^defaultValue}}
-            {{name}} ({{{dataType}}}):{{#description}} {{{description}}}{{/description}}
-{{/defaultValue}}
-{{/requiredVars}}
-{{> model_templates/docstring_init_required_kwargs }}
-{{#optionalVars}}
-            {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}}  # noqa: E501
-{{/optionalVars}}
-        """
+        """Helper creating a new instance from a response."""
 
 {{#requiredVars}}
 {{#defaultValue}}
         {{name}} = kwargs.get('{{name}}', {{{defaultValue}}})
 {{/defaultValue}}
 {{/requiredVars}}
-        _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
-        _path_to_item = kwargs.pop('_path_to_item', ())
-        _configuration = kwargs.pop('_configuration', None)
-        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
 
-        self = super(OpenApiModel, cls).__new__(cls)
+        self = super({{classname}}, cls)._from_openapi_data(kwargs)
 
 {{> model_templates/invalid_pos_args }}
 
-        self._data_store = {}
-        self._check_type = _check_type
-        self._spec_property_naming = _spec_property_naming
-        self._path_to_item = _path_to_item
-        self._configuration = _configuration
-        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
-
-        constant_args = {
-            '_check_type': _check_type,
-            '_path_to_item': _path_to_item,
-            '_spec_property_naming': _spec_property_naming,
-            '_configuration': _configuration,
-            '_visited_composed_classes': self._visited_composed_classes,
-        }
-        composed_info = validate_get_composed_info(
-            constant_args, kwargs, self)
-        self._composed_instances = composed_info[0]
-        self._var_name_to_model_instances = composed_info[1]
-        self._additional_properties_model_instances = composed_info[2]
-        discarded_args = composed_info[3]
-
-        return self
+        return self

.generator/templates/model_templates/method_from_openapi_data_normal.mustache

@@ -6,12 +6,4 @@
 {{#requiredVars}}
         self.{{name}} = {{name}}
 {{/requiredVars}}
-        for var_name, var_value in kwargs.items():
-            if var_name not in self.attribute_map and \
-                        self._configuration is not None and \
-                        self._configuration.discard_unknown_keys and \
-                        self.additional_properties_type is None:
-                # discard variable.
-                continue
-            setattr(self, var_name, var_value)
-        return self
+        return self

.generator/templates/model_templates/method_from_openapi_data_shared.mustache

@@ -1,49 +1,13 @@
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls{{#requiredVars}}{{^defaultValue}}, {{name}}{{/defaultValue}}{{/requiredVars}}, *args, **kwargs):  # noqa: E501
-        """{{classname}} - a model defined in OpenAPI
-
-{{#requiredVars}}
-{{#-first}}
-        Args:
-{{/-first}}
-{{^defaultValue}}
-            {{name}} ({{{dataType}}}):{{#description}} {{{description}}}{{/description}}
-{{/defaultValue}}
-{{#-last}}
-
-{{/-last}}
-{{/requiredVars}}
-        Keyword Args:
-{{#requiredVars}}
-{{#defaultValue}}
-            {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} defaults to {{{defaultValue}}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}}  # noqa: E501
-{{/defaultValue}}
-{{/requiredVars}}
-{{> model_templates/docstring_init_required_kwargs }}
-{{#optionalVars}}
-            {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}}  # noqa: E501
-{{/optionalVars}}
-        """
-
+        """Helper creating a new instance from a response."""
 {{#requiredVars}}
 {{#defaultValue}}
         {{name}} = kwargs.get('{{name}}', {{{defaultValue}}})
 {{/defaultValue}}
 {{/requiredVars}}
-        _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
-        _path_to_item = kwargs.pop('_path_to_item', ())
-        _configuration = kwargs.pop('_configuration', None)
-        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
 
-        self = super(OpenApiModel, cls).__new__(cls)
+        self = super({{classname}}, cls)._from_openapi_data(kwargs)
 
 {{> model_templates/invalid_pos_args }}
-
-        self._data_store = {}
-        self._check_type = _check_type
-        self._spec_property_naming = _spec_property_naming
-        self._path_to_item = _path_to_item
-        self._configuration = _configuration
-        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)

.generator/templates/model_templates/method_from_openapi_data_simple.mustache

@@ -1,62 +1,5 @@
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):
-        """{{classname}} - a model defined in OpenAPI
-
-        Note that value can be passed either in args or in kwargs, but not in both.
-
-        Args:
-            args[0] ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}}{{#defaultValue}} if omitted defaults to {{{defaultValue}}}{{/defaultValue}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}}  # noqa: E501
-
-        Keyword Args:
-            value ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}}{{#defaultValue}} if omitted defaults to {{{defaultValue}}}{{/defaultValue}}{{#allowableValues}}, must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}}  # noqa: E501
-{{> model_templates/docstring_init_required_kwargs }}
-        """
-        # required up here when default value is not given
-        _path_to_item = kwargs.pop('_path_to_item', ())
-
-        self = super(OpenApiModel, cls).__new__(cls)
-
-        if 'value' in kwargs:
-            value = kwargs.pop('value')
-        elif args:
-            args = list(args)
-            value = args.pop(0)
-{{#defaultValue}}
-        else:
-            value = {{{defaultValue}}}
-{{/defaultValue}}
-{{^defaultValue}}
-        else:
-            raise ApiTypeError(
-                "value is required, but not passed in args or kwargs and doesn't have default",
-                path_to_item=_path_to_item,
-                valid_classes=(self.__class__,),
-            )
-{{/defaultValue}}
-
-        _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
-        _configuration = kwargs.pop('_configuration', None)
-        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
-
-{{> model_templates/invalid_pos_args }}
-
-        self._data_store = {}
-        self._check_type = _check_type
-        self._spec_property_naming = _spec_property_naming
-        self._path_to_item = _path_to_item
-        self._configuration = _configuration
-        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
-        self.value = value
-        if kwargs:
-            raise ApiTypeError(
-                "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % (
-                    kwargs,
-                    self.__class__.__name__,
-                ),
-                path_to_item=_path_to_item,
-                valid_classes=(self.__class__,),
-            )
-
-        return self
+        """Helper creating a new instance from a response."""
+        return cls(*args, **kwargs)

.generator/templates/model_templates/method_init_composed.mustache

@@ -1,15 +1,3 @@
-    required_properties = set([
-        '_data_store',
-        '_check_type',
-        '_spec_property_naming',
-        '_path_to_item',
-        '_configuration',
-        '_visited_composed_classes',
-        '_composed_instances',
-        '_var_name_to_model_instances',
-        '_additional_properties_model_instances',
-    ])
-
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
         """{{classname}} - a model defined in OpenAPI
@@ -30,6 +18,7 @@
             {{name}} ({{{dataType}}}):{{#description}} {{{description}}}.{{/description}} [optional]{{#defaultValue}} if omitted the server will use the default value of {{{defaultValue}}}{{/defaultValue}}  # noqa: E501
 {{/optionalVars}}
         """
+        super().__init__(kwargs)
 
 {{#requiredVars}}
 {{^isReadOnly}}
@@ -38,31 +27,5 @@
 {{/defaultValue}}
 {{/isReadOnly}}
 {{/requiredVars}}
-        _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
-        _path_to_item = kwargs.pop('_path_to_item', ())
-        _configuration = kwargs.pop('_configuration', None)
-        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
 
 {{> model_templates/invalid_pos_args }}
-
-        self._data_store = {}
-        self._check_type = _check_type
-        self._spec_property_naming = _spec_property_naming
-        self._path_to_item = _path_to_item
-        self._configuration = _configuration
-        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
-
-        constant_args = {
-            '_check_type': _check_type,
-            '_path_to_item': _path_to_item,
-            '_spec_property_naming': _spec_property_naming,
-            '_configuration': _configuration,
-            '_visited_composed_classes': self._visited_composed_classes,
-        }
-        composed_info = validate_get_composed_info(
-            constant_args, kwargs, self)
-        self._composed_instances = composed_info[0]
-        self._var_name_to_model_instances = composed_info[1]
-        self._additional_properties_model_instances = composed_info[2]
-        discarded_args = composed_info[3]

.generator/templates/model_templates/method_init_normal.mustache

@@ -1,12 +1,3 @@
-    required_properties = set([
-        '_data_store',
-        '_check_type',
-        '_spec_property_naming',
-        '_path_to_item',
-        '_configuration',
-        '_visited_composed_classes',
-    ])
-
 {{> model_templates/method_init_shared }}
 
 {{#isEnum}}
@@ -17,14 +8,3 @@
         self.{{name}} = {{name}}
 {{/isReadOnly}}
 {{/requiredVars}}
-        for var_name, var_value in kwargs.items():
-            if var_name not in self.attribute_map and \
-                        self._configuration is not None and \
-                        self._configuration.discard_unknown_keys and \
-                        self.additional_properties_type is None:
-                # discard variable.
-                continue
-            setattr(self, var_name, var_value)
-            if var_name in self.read_only_vars:
-                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
-                                     f"class with read only attributes.")