-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BUG][python] Support named arrays (#6493)
* [python] Support named arrays * Fix named array type * Use ModelSimple * Reset samples * Regenerated * Animal farm test * Array of enums * Clean-up * Clean-up * Clean-up * Fix array type generation * simplify * array model is not alias * Array model has one value field * ensure up-to-date * ./bin/utils/ensure-up-to-date --batch * Solve issue with missing import for array model * regenerate
- Loading branch information
1 parent
2be0aff
commit e708cdc
Showing
22 changed files
with
891 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
samples/client/petstore/python-experimental/docs/AnimalFarm.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # animal_farm.AnimalFarm | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **value** | [**[animal.Animal]**](Animal.md) | | | ||
|
|
||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
173 changes: 173 additions & 0 deletions
173
samples/client/petstore/python-experimental/petstore_api/model/animal_farm.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| # 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 re # noqa: F401 | ||
| import sys # noqa: F401 | ||
|
|
||
| import six # noqa: F401 | ||
| import nulltype # noqa: F401 | ||
|
|
||
| from petstore_api.model_utils import ( # noqa: F401 | ||
| ApiTypeError, | ||
| ModelComposed, | ||
| ModelNormal, | ||
| ModelSimple, | ||
| cached_property, | ||
| change_keys_js_to_python, | ||
| convert_js_args_to_python_args, | ||
| date, | ||
| datetime, | ||
| file_type, | ||
| int, | ||
| none_type, | ||
| str, | ||
| validate_get_composed_info, | ||
| ) | ||
| try: | ||
| from petstore_api.model import animal | ||
| except ImportError: | ||
| animal = sys.modules[ | ||
| 'petstore_api.model.animal'] | ||
|
|
||
|
|
||
| class AnimalFarm(ModelSimple): | ||
| """NOTE: This class is auto generated by OpenAPI Generator. | ||
| Ref: https://openapi-generator.tech | ||
| Do not edit the class manually. | ||
| Attributes: | ||
| allowed_values (dict): The key is the tuple path to the attribute | ||
| and the for var_name this is (var_name,). The value is a dict | ||
| with a capitalized key describing the allowed value and an allowed | ||
| value. These dicts store the allowed enum values. | ||
| validations (dict): The key is the tuple path to the attribute | ||
| and the for var_name this is (var_name,). The value is a dict | ||
| that stores validations for max_length, min_length, max_items, | ||
| min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, | ||
| inclusive_minimum, and regex. | ||
| additional_properties_type (tuple): A tuple of classes accepted | ||
| as additional properties values. | ||
| """ | ||
|
|
||
| allowed_values = { | ||
| } | ||
|
|
||
| validations = { | ||
| } | ||
|
|
||
| additional_properties_type = None | ||
|
|
||
| _nullable = False | ||
|
|
||
| @cached_property | ||
| def openapi_types(): | ||
| """ | ||
| This must be a class method so a model may have properties that are | ||
| of type self, this ensures that we don't create a cyclic import | ||
| Returns | ||
| openapi_types (dict): The key is attribute name | ||
| and the value is attribute type. | ||
| """ | ||
| return { | ||
| 'value': ([animal.Animal],), # noqa: E501 | ||
| } | ||
|
|
||
| @cached_property | ||
| def discriminator(): | ||
| return None | ||
|
|
||
| _composed_schemas = None | ||
|
|
||
| required_properties = set([ | ||
| '_data_store', | ||
| '_check_type', | ||
| '_spec_property_naming', | ||
| '_path_to_item', | ||
| '_configuration', | ||
| '_visited_composed_classes', | ||
| ]) | ||
|
|
||
| @convert_js_args_to_python_args | ||
| def __init__(self, value, *args, **kwargs): # noqa: E501 | ||
| """animal_farm.AnimalFarm - a model defined in OpenAPI | ||
| Args: | ||
| value ([animal.Animal]): | ||
| Keyword Args: | ||
| _check_type (bool): if True, values for parameters in openapi_types | ||
| will be type checked and a TypeError will be | ||
| raised if the wrong type is input. | ||
| Defaults to True | ||
| _path_to_item (tuple/list): This is a list of keys or values to | ||
| drill down to the model in received_data | ||
| when deserializing a response | ||
| _spec_property_naming (bool): True if the variable names in the input data | ||
| are serialized names, as specified in the OpenAPI document. | ||
| False if the variable names in the input data | ||
| are pythonic names, e.g. snake case (default) | ||
| _configuration (Configuration): the instance to use when | ||
| deserializing a file_type parameter. | ||
| If passed, type conversion is attempted | ||
| If omitted no type conversion is done. | ||
| _visited_composed_classes (tuple): This stores a tuple of | ||
| classes that we have traveled through so that | ||
| if we see that class again we will not use its | ||
| discriminator again. | ||
| When traveling through a discriminator, the | ||
| composed schema that is | ||
| is traveled through is added to this set. | ||
| For example if Animal has a discriminator | ||
| petType and we pass in "Dog", and the class Dog | ||
| allOf includes Animal, we move through Animal | ||
| once using the discriminator, and pick Dog. | ||
| Then in Dog, we will make an instance of the | ||
| Animal class but this time we won't travel | ||
| through its discriminator because we passed in | ||
| _visited_composed_classes = (Animal,) | ||
| """ | ||
|
|
||
| _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', ()) | ||
|
|
||
| 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._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 | ||
| for var_name, var_value in six.iteritems(kwargs): | ||
| 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
samples/client/petstore/python-experimental/test/test_animal_farm.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # 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'] | ||
| from petstore_api.model.animal_farm import AnimalFarm | ||
|
|
||
|
|
||
| class TestAnimalFarm(unittest.TestCase): | ||
| """AnimalFarm unit test stubs""" | ||
|
|
||
| def setUp(self): | ||
| pass | ||
|
|
||
| def tearDown(self): | ||
| pass | ||
|
|
||
| def testAnimalFarm(self): | ||
| """Test AnimalFarm""" | ||
| # FIXME: construct object with mandatory attributes with example values | ||
| # model = AnimalFarm() # noqa: E501 | ||
| pass | ||
|
|
||
|
|
||
| if __name__ == '__main__': | ||
| unittest.main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.